Configure DF Storyteller

You can configure DF Storyteller using the df_storyteller-config.json file located nex to the executable. When no file is given it will use its build in defaults.

Default configuration:

  "local_address": "",
  "server": {
    "address": "",
    "port": 20350
    "service": "sqlite",
    "config": {
      "db_path": "df_storyteller.db",
      "user": "df_storyteller",
      "password": "",
      "host": "localhost",
      "port": 5432,
      "database": "df_storyteller"
To create the default configuration run:
# Linux/macOS
./df_storyteller config
# Windows
./df_storyteller.exe config

The default configuration will use SQLite and has some additional field to easily switch to Postgres, only password has to be filled in and service switched to "postgres".

Configure Postgres

The Postgres database requires some setup. Although most of it is automated. In order to configure Postgres run the following command:

./df_storyteller database --postgres --drop-db
This command will creates a new user called `df_storyteller` in postgres and create a password for it. It will then login as that user and create the database `df_storyteller` (and delete if it already exist if the --drop-db is set) It will then create the df_storyteller-config.json file with the correct info in it.

Custom configuration

There are a lot of additional setting that can be changed in DF Storyteller and more will be added in the future. You can find a full list of all the options here: DF Storyteller Rust docs