Skip to content

Configuration overview ​

FeatherBoard is configured with YAML files inside plugins/FeatherBoard/. There is one plugin config, any number of scoreboard files, a language folder and a folder for custom effects.

text
plugins/FeatherBoard/
├── config.yml              # plugin-wide behaviour
├── scoreboards/
│   ├── default.yml         # each file is one scoreboard
│   ├── myboard.yml
│   └── images/             # optional: images referenced by scoreboards
├── effects/
│   └── example1.yml        # optional custom effects
├── lang/
│   └── en.yml              # overrides for built-in messages
└── resource-pack/          # generated resource pack files

What lives where ​

File or folderPurposeReference
config.ymlDatabase, resource pack upload, assignment methods, GUI and performance tweaks.Plugin config
scoreboards/*.ymlOne scoreboard per file. The file name is the board name.Scoreboard files
effects/*.ymlCustom effect tags built from frames, arguments and scripts.Custom effects
lang/*.ymlOverrides for plugin messages. Missing keys fall back to English.Language
resource-pack/The resource pack ZIP and SHA1.txt generated for images and fonts.Images and fonts

Reloading ​

CommandUse it when
/fb reload <board>You changed an existing board. Only that board is rebuilt.
/fb reloadYou changed config.yml, effects or language files.
/fb reload -allYou added a new scoreboard file, or the server has 10+ players and you want to skip the safety prompt.
/fb reload -fYou need a full plugin hard reload. Use this as a last resort.

Reloading with players online

A full reload resends scoreboards. With many players and a very fast animation this can cause a short client-side flicker. The plugin refuses a full reload when 10 or more players are online unless you add -all. Prefer /fb reload <board> while editing.

YAML basics ​

  • Indent with spaces, never tabs. Two spaces per level is the common style.
  • Quote strings that contain &, %, {, }, : or start with */!.
  • Use a YAML validator before reloading if a board suddenly disappears.
  • Comments start with # and are ignored by the plugin.

Validate before you reload

Most "my board disappeared" reports are YAML indentation mistakes. A quick check with yamllint or your editor's YAML mode saves a restart.

Where to go next ​

Released under a proprietary license. FeatherBoard is not affiliated with Mojang or Microsoft.