Configuration Overview

Upon first launch, Roster generates a clean and modular folder structure. Each display feature has its own dedicated file to keep things organized.

plugins/Roster/
├── config.yml        # Core settings and language selection
├── tab.yml           # TAB header and footer configuration
├── sidebar.yml       # Sidebar scoreboard configuration
├── nametags.yml      # Overhead nametags configuration
├── groups.yml        # Internal groups and LuckPerms hook
├── branding.yml      # F3 Server Branding settings
└── messages/         # 8 built-in language translation files

config.yml

The core configuration file is simple and allows you to toggle entire modules on or off.

settings:
  # The default language used for plugin messages (e.g., en, pl, es, de, fr)
  language: "en"
  # Set to true to print extra debug information in the console
  debug: false

modules:
  # Enable or disable the TAB list manager
  tab: true
  # Enable or disable the sidebar scoreboard
  sidebar: true
  # Enable or disable overhead nametags
  nametags: true

If you don’t need a specific feature (for example, if you already have a sidebar plugin you prefer), you can simply set its module to false in config.yml. Roster will completely unregister that system to save server resources.