Core Configuration

You can change NPC’s settings for your user and for each individual campaign. User settings override the built-in defaults, and campaign settings override user settings and defaults.

The CLI command settings can be used to open the user settings file or current campaign settings file, but it’s useful to check out the entire settings directory too.

File Locations

User settings are stored in a different directory based on the current operating system. On Mac OSX, it’s ~/Library/Application Support/NPC. On Unix systems, it’s ~/.config/NPC. On Windows, it’s C:\Users\<user>\AppData\Roaming\. [1]

Campaign settings are stored under .npc/ within the campaign’s directory.

In either location, the settings file itself is settings.yaml. Other files can be put in the settings directory (or certain subdirectories) to configure the game system or its character types, or to provide templates for character listings.

The Settings File

All settings files are written in yaml syntax. The main settings file, settings.yaml, has two main sections. The npc section holds core info like the tags available to character files. The campaign section holds campaign-specific info, like where to find different files.

See Settings Keys for an explanation of all of the available settings keys.

Global Campaign Settings

While any key can appear in your user settings, there is one campaign key that is most useful to configure there: campaign.create_on_init. This key is a list of folder names that will be created for every new campaign.

[1]

This location is determined using Click