Changing Tags

The npc.tags key defines every tag available to character files. The command info can show details about the configured tags for a given system or campaign. Adding a new tag is as easy as adding a new entry under npc.tags in either your user settings or the campaign’s settings. You can also override and change an existing tag by adding an entry with that tag’s name.

Tip

When overwriting an existing tag, change the desc and doc strings so that they match the new changes to the tag. For example, if you add replaced_by, use desc and doc to describe why the replacement was made.

Tag Format

Each entry within npc.tags is the name of a tag, followed by these attributes:

desc:

required A single line of text describing the basic purpose of this tag.

doc:

A multiline block of text describing the details and nuances of this tag.

replaced_by:

The name of a different tag which is used instead of this tag. The replacement should be limited to a specific scope, like a system or type.

required:

Whether this tag must appear in the character file.

min:

The minimum number of times this tag must appear in the character file. A positive number implies required=true.

max:

The maximum number of times this tag may appear in the character file.

values:

Explicit list of allowed values for this tag.

allow_empty:

Whether this tag can appear with no value.

no_value:

Whether this tag must not have a value.

locked:

Whether this tag is prevented from being changed.

long:

Whether this tag’s value is intended to be longer than a few words. This is mostly a hint for how to display certain properties in the GUI.

subtags:

An object with additional tags which will be stored within this tag.

history:

A list of changes by NPC version. Probably only useful for the built-in tags, but could be used for your own versioned configs.

The long attribute was added in NEW_VERSION

Examples

One of the most common reasons to add a tag is to support some facet of a new system. The FATE system, for example, requires every character to have a Concept. This new concept tag can be defined as follows:

tags:
    concept:
      desc: The character's high concept
      required: true
      max: 1

The @concept tag will now be recognized in character files in a campaign that uses the FATE system.