Getting started
BestServerBasics 3.3.0 in a few minutes: install it, move over from EssentialsX, link the dashboard. This page only says what the plugin really does today.
Install and go
One jar file for Minecraft 1.8 up to 26.x. No setup is needed, and every default can be changed later.
- 1
Put the jar into the "plugins" folder and start the server. All 313 commands are then there.
- 2
/bsb setup survivalTell the plugin what kind of server this is: survival, creative, lobby or minigames. That switches the fitting command groups on and off, nothing else. "bsb undo" takes it back.
- 3
/setspawnStand where new people should arrive and set the spawn.
- 4
/bsbShows the state of the plugin and everything about the dashboard.
- After the first start "plugins/BestServerBasics" holds two folders: "config" with config.yml, localizations.yml and one file per category in "commands", and "data" with the database data.db.
- Permissions are named bsb.<command> and are listed with every command in the documentation. OPs may do everything; for everybody else you grant them with your permissions plugin.
- Started and tried on Paper 1.8.8, 1.12.2, 1.16.5, 1.21.11 and 26.3, each with the Java version the server itself asks for. Spigot, Purpur and Folia are not tested.
Moving from EssentialsX
The import reads the files of EssentialsX. EssentialsX does not have to be installed any more, and its folder stays untouched.
- 1
/import essentials allThe dry run: nothing is changed, you only see what would happen. Instead of "all" you can use "config" (settings only) or "data" (data only).
- 2
/import essentials all confirmNow it really imports. Where both sides have a different value, the one of BestServerBasics stays; with "overwrite" at the end EssentialsX wins.
- 3
Restart the server so changed settings apply, and remove EssentialsX. Running both plugins side by side is not tested.
- Imported per account: balance, nickname, homes, mails, ignore list, mute, ban and jail sentence with reason and duration, first and last visit. For the server: warps, jails, spawn, prices (worth.yml) and kits. From the config.yml only four settings: starting balance, currency symbol, teleport delay and number of homes.
- Not imported: all other settings of EssentialsX (such as chat formats and cooldowns; the report names each one with the place where you set it here), separate spawns of single groups, money in kits, anything expired and NPC accounts of other plugins. Places in worlds that are not loaded right now come along and work once the world exists.
- The import looks for the folder "plugins/Essentials". If it is somewhere else, enter the place in config/commands/importer.yml under import.folder.
- A broken file does not hold up the import, it is listed with its reason in the report. If an import stops after all, everything before stays saved; after a restart the same command continues there. A second run adds nothing twice.
- The command needs the permission bsb.import. The complete report is then in "plugins/BestServerBasics/import". The import is tested with a hand-made EssentialsX folder on Paper 1.16.5 and with tests for the old and the new file format, not with a large real data set: make a backup and the dry run first.
Linking the dashboard
The dashboard is optional. Without this step the plugin connects to nobody.
- 1
Sign in to the dashboard and choose "Add a server". You get a code that is valid for ten minutes and only once.
- 2
bsb link <code>Type the command into the server console, not in game. At a host it is the Console page of the panel. The server says what linking allows and shows a number after “confirm”.
- 3
The dashboard asks whether this server should belong to your account and shows a number as well. Confirm only if both are the same. Only your yes links; whoever reads the code along can do nothing with it.
- What the dashboard may do is decided by your server, from 1 settings, 2 live view and 3 actions up to 4 everything the server console can. Linking in the server console switches everything on, after a warning and "bsb link <code> confirm". The page Security lowers it; only the server console switches a part on again, with "bsb dashboard on <name>".
- "bsb undo" takes back the last change from the dashboard, the history in the dashboard older ones too (the last 50). "bsb unlink" ends the link at once.
- You cannot tell a real message by its looks. Real is only what you see yourself under "bsb". Neither the plugin nor the dashboard ever ask you in chat to type a command.
- Where the console is: on Pterodactyl and Pelican panels the Console tab of the server, on Multicraft the Console page; on your own machine the window or screen session the server runs in.
Common questions
Do I have to configure anything?
No. The plugin runs with its defaults. What you want to change is in the files under "plugins/BestServerBasics/config" or, once linked, in the dashboard.
How do I switch the plugin to German?
Not with a switch yet: the texts are English, choosing a language including German is being built. Until then you can change every text yourself in "plugins/BestServerBasics/config/localizations.yml".
When does a change to a file apply?
After a restart of the server. Before every change made by the plugin, the previous version stays beside it as .bak.
Do I need the dashboard?
No. Everything also works with commands and files. Without "bsb link" the plugin talks to nobody.
Where is my data?
On your server, in "plugins/BestServerBasics/data/data.db" (SQLite). For a backup the folder "plugins/BestServerBasics" is enough while the server is stopped.
Can I switch off single commands?
Yes, every command and every group: in the files under "config/commands" or in the dashboard under "Modules".