Getting started
FeatherBoard turns the vanilla sidebar into a fully animated scoreboard. Boards are plain YAML files, so you can build everything from a one-line counter to a rotating news ticker with images, custom fonts and PlaceholderAPI data.
This guide takes you from an empty server to a working board in a few minutes.
Requirements
| Requirement | Version | Notes |
|---|---|---|
| Server | Spigot 26.3 | Paper usually works, but Spigot is the tested target. Other server software is not supported. |
| Java | 25 | Required by the 26.3 server line. |
| ProtocolLib | 5.5.0+ | Use the Spigot build when the GitHub release lags behind. |
| PlaceholderAPI | 2.12.3+ | Required at runtime; download the release jar, not the bare Maven artifact. |
| Vault | Optional | Only needed for GROUP scoreboard assignment. |
Use matching versions
FeatherBoard 7 targets Spigot/Paper 26.3. If you run an older server line, use the FeatherBoard release that matches that server version instead of mixing jars.
Install
- Stop the server.
- Put
FeatherBoard.jar,ProtocolLib.jarandPlaceholderAPI.jarin theplugins/folder. - Start the server. FeatherBoard creates its data folder on first start.
- Run
/fb aboutin-game or from the console to confirm the plugin loaded.
On first start the plugin creates its data folder and the files it needs. A full setup looks like this:
plugins/
├── FeatherBoard.jar
├── ProtocolLib.jar
├── PlaceholderAPI.jar
└── FeatherBoard/
├── config.yml
├── scoreboards/
│ ├── default.yml
│ ├── default-images.yml
│ └── benchmark.yml
├── effects/ # custom effects (created as needed)
├── lang/ # optional message overrides
└── resource-pack/ # generated when images or fonts are useddefault.yml is enabled for every player through featherboard.group.default. Keep it as a working example, or replace its contents with your own design.
Dependencies
FeatherBoard declares ProtocolLib and PlaceholderAPI as hard dependencies. If either jar is missing, the plugin disables itself and the folder is not generated.
Create your first scoreboard
Create plugins/FeatherBoard/scoreboards/myboard.yml:
# Optional: settings and scripts live at the root of the file.
settings:
# Higher priority wins when several boards are assigned to a player.
priority: 10
# This board is assigned with the permission featherboard.group.myboard.
assigning: 'PERMISSION'
# A dedicated title section. The first line under "lines" is also used as the title
# when this section is omitted.
title:
frames:
- '&c&lMy&e&lServer'
interval: 20
lines:
header:
frames:
- '&8&m--------------------'
interval: 100
player:
frames:
- '&7Player: &f%player_name%'
interval: 20
online:
frames:
- '&7Online: &a%server_online%'
interval: 40
world:
frames:
- '&7World: &b%player_world%'
interval: 40
footer:
frames:
- '&8&m--------------------'
interval: 100The file name is the board name, so this board is called myboard. Grant the matching permission to the players who should see it:
/lp group default permission set featherboard.group.myboard trueNow load the new file and show it:
/fb reload -all
/fb show myboard/fb reload -all is needed when you add a new file. /fb reload myboard only reloads an existing board, and is the faster option while you are tweaking a design.
Verify that everything works
| Command | What it checks |
|---|---|
/fb about | Plugin and framework version. |
/fb permissions | Which FeatherBoard permissions you currently have. |
/fb parse &aHello %player_name% | Parses text, effects and placeholders and prints the result. |
/fb show myboard | Forces a board for yourself, bypassing assignment. |
/fb debug | Creates a debug dump and uploads it to Ubuntu Paste. Include the link when asking for support. |
Common first-run problems
The board does not appear
Check, in this order:
- Is the board assigned? See assigning scoreboards.
- Does the player have
featherboard.group.myboard? - Is the world listed in
disabled-worlds? - Is the YAML valid? Run
/fb reload myboardand read the console. - Is
tweaks.default-hiddenenabled inconfig.yml? Players then need/fb on.
Images or custom fonts do not show
Images and fonts need a resource pack. Check that resource-pack.enabled is true and that players accepted the resource pack prompt. A board with images can define a fallback board for players who reject it. See images and fonts.
The plugin disables on startup
This is almost always a dependency problem. Confirm that ProtocolLib and PlaceholderAPI are present, enabled, and built for the same server version. Check the first lines of the server log for the exact missing dependency.
Updating
- Back up
plugins/FeatherBoard/. - Stop the server.
- Replace
FeatherBoard.jarwith the new release. - Start the server and check
consolefor config migration messages.
Do not change the config: number in config.yml; it is used by the plugin to migrate the file. If a release adds new keys, the plugin fills them in automatically.
Next steps
Design a board
Frames, metadata, settings, images, fonts and scripts.
Add animation
All built-in effects with syntax, arguments and live previews.
Choose who sees what
Permissions, groups, worlds, time, language and placeholders.
Build it visually
Use the browser animation creator to compose a board and copy its YAML.
