Shared rules for BitAspire YAML configuration files, strings, lists, comments, and runtime state files.

YAML files in BitAspire plugins

Most modern BitAspire plugins use YAML files for defaults, messages, modules, commands, and runtime state. This shared page applies especially to plugins powered by Takion/PrismaticAPI-backed text handling. CWR, XWR, and XenoScavenger can differ; use their product pages when they document a different rule.

String or list values

Many message keys accept either a single string or a list of strings.

message: '&aWelcome {player}.'

message:
  - '&aWelcome {player}.'
  - '&7Read /help when you are ready.'

Use a string for one short line. Use a list when the feature should send multiple chat lines, title lines, action-bar steps, or a multi-line embed/message body.

Indentation rules

Use spaces, not tabs. Keep child keys aligned under their parent.

join:
  default:
    public: '&8[&a+&8] &7Welcome &e{player}&7!'

If a section has repeated entries, keep each entry under a stable id:

profiles:
  default:
    priority: 0
  staff:
    priority: 100

Descriptor files vs behavior files

Do not treat every YAML file as normal configuration.

File	Role
`plugin.yml`	Bukkit/Paper plugin metadata.
`module.yml`	SIR/SIR+ module descriptor.
`commands.yml`	Command provider descriptor and command metadata.
`addon.yml`	SIR+ addon descriptor.
`config.yml`, `messages.yml`, `lang.yml`, feature files	Behavior and text configuration.

Edit behavior files for normal customization. Descriptor files should only change when you are building your own module, provider, or addon.

Runtime state files

State files such as modules/states.yml, commands/states.yml, or addons/states.yml record enable/disable choices made by the plugin. Prefer the admin command or GUI first:

/sir modules
/sir commands
/sir addons in SIR+

Manual edits are safest while the server is stopped.

Common key patterns

Key pattern	Meaning
`enabled`	Master toggle for a section or entry.
`permission`	Permission required to use or match the entry.
`priority`	Higher value wins when several entries match.
`group`	Optional grouping label or permission-group style selector.
`commands`	Console or plugin commands executed by the feature.
`messages`, `public`, `private`, `lang`	Player-facing text values.
`sound`	Sound feedback with `enabled`, `type`, `volume`, and `pitch`.
`conditions`	Matching rules such as permissions, worlds, or other selectors.

Recommended workflow

Change one feature file at a time.
Keep a backup of the original generated default.
Reload through the plugin command when supported.
If the feature is still wrong, check the state file before assuming the YAML syntax is broken.

YAML Files