Branch-aware explorer for SIR modules, their files, keys, dependencies, commands, and configuration examples.

SIR modules

This page replaces the old separate Legacy and Modern module references with one branch-aware explorer.

Select Current 2.3.1 for maintained servers. Select Legacy only when you are auditing an old resources/modules tree before migration.

Knowledge Explorer

Choose the entry you want to inspect

The data below follows the current repository resources and excludes descriptor-only files unless they define commands.

BranchEntry

Current 2.3.1advancements

Advancements

Summary

Controls advancement announcements, filters, and command reactions.

What it offers

- Task, goal, challenge, and custom advancement messages.
- World, game mode, and advancement allow/deny filters.
- Optional console commands when an advancement category is completed.

Plugin dependencies

Required

No hard plugin dependency in the default resource files.

Optional

- PlaceholderAPI for external placeholders inside text values.

Configuration files and important keys

config.yml

Filtering rules before an advancement message is allowed to run.

worlds.enabled/whitelist/listgame-modes.enabled/whitelist/listadvancements.enabled/whitelist/list

messages.yml

Message and command payloads per advancement type.

messages.task/goal/challenge/customcommands.task/goal/challenge/custom

data.yml

Runtime data file owned by the module.

data

Commands

No user-facing command is declared by this entry.

Configuration examples

- Use worlds.whitelist: true with a short worlds.list when only survival worlds should broadcast advancements.
- Put reward commands under commands.challenge when challenge advancements should trigger server-side rewards.

Descriptor files

module.yml is intentionally not documented as a behavior config here. It is an extension descriptor used by the loader. Edit behavior files such as channels.yml, messages.yml, config.yml, or profiles.yml instead.

Modules