Installation

Install the plugin

1. Make sure the server runs Paper 1.21.x with Java 21.

2. Preferably install LuckPerms (offline staff hierarchy, contexts) and PlaceholderAPI (placeholders). Other dependencies are optional, see the overview.

3. Stop the server, then copy CobaltStaff-1.0.0.jar into the plugins/ folder.

4. Start the server. The plugin creates its configuration folder and database, then enables its six modules.

5. Check the installation in game or from the console:

   /cobaltstaff version

   The answer shows the version and the list of active modules.

6. Give permissions to your team (see Permissions), then adapt the configuration (see Configuration).

Generated files

On first start, the default files are extracted into the plugin folder. They are never overwritten afterwards: your changes are kept across updates, and a missing key falls back to its default value.

• Directoryplugins/CobaltStaff/

  • config.yml general settings (language, database, hierarchy, modules…)
  • commands.yml the /cobaltstaff admin command
  • data.db SQLite database (WAL mode)
  • Directorycommands/ names, aliases and permissions of each module’s commands

    • sanctions.yml
    • reports.yml
    • staffmode.yml
    • investigation.yml
    • chat.yml
  • Directoryconfig/ options of each module

    • sanctions.yml
    • reports.yml
    • staffmode.yml
    • investigation.yml
    • chat.yml
    • integration.yml
  • Directorylang/ FR and EN texts (MiniMessage)

    • fr.yml
    • en.yml
    • sanctions.en.yml
    • …
  • Directorystaffmode/ staff mode modes and items

    • modes.yml
    • modules.yml
    • custom-modules.yml
  • Directorybans/ ban screen templates

    • permanent.txt
    • temporaire.txt
    • ip-permanent.txt
    • ip-temporaire.txt
  • Directorytraces/ /trace logs (created by the first trace)

    • …

Recommended first settings

Language

Choose the text language in config.yml:

language: en   # or fr
date-format: "dd/MM/yyyy HH:mm"
timezone: Europe/Paris

Hierarchy

Declare your team’s ranks, from lowest to highest. Each rank matches the permission cobaltstaff.rank.<name>:

ranks:
  - guide
  - moderateur
  - supermodo
  - responsable
  - admin

A staff member can only ban, mute, kick, warn, freeze or examine a player of a strictly lower rank (or without a rank).

Modules

Disable the modules you do not need:

modules:
  sanctions: true
  reports: true
  staffmode: true
  investigation: true
  chat: true
  integration: true

A disabled module registers no commands, listeners or tasks.

Existing commands

By default, CobaltStaff replaces commands with the same name from other plugins (/ban, /mute, /vanish…):

commands:
  override-existing: true
  hide-vanished-in-tab: true

Set override-existing to false to give priority to other plugins.

Reload the configuration

/cobaltstaff reload            reload the whole plugin
/cobaltstaff reload chat       reload a single module

Caution

Renaming a command or alias in commands.yml or commands/*.yml requires a server restart. Staff chat channels, however, reload with /cobaltstaff reload chat.

Migrate from another plugin

• LiteBans: /cobaltstaff import litebans [severity] reads the database described in the LiteBans configuration (H2, MySQL/MariaDB or PostgreSQL) and imports bans, mutes, kicks and warns. The command can be run again: already imported sanctions are skipped. Imported warns get the given severity (LEGER by default).
• Vanilla bans: /bans migrer and /ipbans migrer import the vanilla server’s bans and IP bans.

See Sanctions for details.