Installation
Requirements, a step by step install, and the files ATStaffMode creates on first run.
Installing ATStaffMode takes one file copy and one restart. Everything else is optional tuning.
Requirements
| Requirement | Detail |
|---|---|
| Server software | Spigot or Paper |
| Minecraft version | 1.16 and newer |
| Java | 17 or newer |
| Hard dependencies | None |
| Optional integrations | PlaceholderAPI, PremiumVanish, SuperVanish, MultiverseCore |
You need the jar before you start. Buy links are on the Download page.
Install
Stop the server
Shut the server down fully. Dropping a jar into a running server leaves the plugin half loaded.
Drop in the jar
Move the ATStaffMode jar into your server's plugins/ folder.
Start the server
On the first start the plugin creates its folder, writes the default config and language files, and sets up your storage backend.
Check the console
You should see the ATStaffMode startup banner, followed by lines like these.
[ATStaffMode] Loaded language: en_US
[ATStaffMode] Database initialized using: SQLITE
[ATStaffMode] AT-StaffMode enabled successfully with SQLite!If PlaceholderAPI is installed you will also see a line confirming the placeholders were registered.
Edit config.yml
Open plugins/ATStaffMode/config.yml. The settings most servers change first are the storage backend, the feature toggles, and the toolbar item slots. See Configuration.
Reload
Run /staffmode-reload in game or from the console to apply your changes. Aliases are /smreload and /atsmreload.
Plugin folder layout
This is what you get after the first run, using the default SQLite backend.
lang/en_US.yml is always written. A second language file only appears once you select it with the language key in config.yml. If you pick a backend other than SQLite the storage file changes with it, so YAML storage writes data.yml instead of database.db, and MySQL or MongoDB write nothing to disk. See Storage and Data.
Update checker
The plugin checks whether a newer release is out and tells you when there is one. It is on by default.
update-checker:
enabled: true
notify-staff-on-join: true
check-interval-hours: 6| Key | What it does | Default |
|---|---|---|
enabled | The master switch. Nothing is fetched at all when this is false. | true |
notify-staff-on-join | Tells staff holding atstaffmode.updates about a new version when they join, roughly two seconds after login so it is not buried under other join messages. The console is told either way. | true |
check-interval-hours | Hours between checks, with a minimum of 1. The first check runs shortly after startup. | 6 |
Every check is asynchronous, so it never blocks the server, and a check that fails, because the server has no outbound connection for instance, is logged as a warning and nothing more.
atstaffmode.updates is the permission that decides who sees the in game notice. It defaults to op, so grant it to your admin group if you want it wider. The wording itself is the update.available message in your language file, see Messages and Language.
Version detection uses the Spigot resource API only. BuiltByBit's API needs an authenticated key on every request, which cannot be shipped inside a public jar, so the BuiltByBit page is offered as a second download link rather than as a second version source. Both pages carry the same release.
Optional integrations
Install PlaceholderAPI before starting the server and ATStaffMode registers its expansion automatically. Nothing to configure. The full list is on the Placeholders page.