Welcome to Dwarf Fortress Storyteller

Add Visualizer

Visualizers in DF Storyteller are also referred to as 'paintings'. The people who create them are called painters.

Once you have started the API using the "start" subcommand, DF Storyteller will create a folder called "serve-paintings" next to "df_storyteller" executable. In this folder you can place subfolders with all the visualizers you want to install. The default index page will list all the installed visualizers. DF Storyteller will serve all the files and folder under the "/paintings" path in the api.

Serving the files through the "serve-paintings" using DF Storyteller is not mandatory. Visualizer can create there own service if they want to. This is just build in to have a common place to put all the files. This also prevents unnecessary need for application to create there own service, if needed.

Download/Installing Visualizers

You can find visualizers in many places, but most notably we have a list for you here .

Once you have downloaded the visualizer you can follow the instruction from where you downloaded it, or you can put the extracted archive in the "serve-paintings" folder. So if my visualizer is called "Starry Night" it would result in folders something like this:

/serve-paintings/starry_night/index.html

Note that we also replaced the space (' ') with an underscore ('_'). This will prevent potential problems in the future.

We can now access the visualizer over the path (if you are running DF Storyteller with the "start" subcommand):

http://127.0.0.1:20350/paintings/starry_night

Currently the "serve-paintings/paintings.json" file does not update itself, yet. So you might have to add a new visualizer like this:

[
  "my first painting",
  "starry_night"
]