Setting up

Installation

What you need#


Server	Paper, or any fork of it. Folia works with the same jar.
Versions	1.18.2 through 26.2
Java	17 or newer
Internet, once	The first start downloads three libraries

Spigot is not supported. The plugin uses Paper's API for messages, teleports and entity handling, and none of that exists on Spigot.

Steps#

Put the jar in plugins/.
Start the server.
Stop it, read through plugins/ChorusCore/config.yml, start it again.

That is all. The plugin makes its own database and every config file on the first start.

About that first start#

The server fetches three libraries from Maven Central into its own libraries/ folder: HikariCP, the SQLite driver and the MariaDB driver. They are not shaded into the jar, which is why the jar is small and why every plugin on the server that needs them shares one copy.

A server with no way out to the internet cannot do this, and the plugin will not start. If that is your situation, start it once on a machine that does have internet and copy the libraries/ folder across.

What the console says#

  ░█████╗░██╗░░██╗░█████╗░██████╗░██╗░░░██╗░██████╗
  ██╔══██╗██║░░██║██╔══██╗██╔══██╗██║░░░██║██╔════╝
  ██║░░╚═╝███████║██║░░██║██████╔╝██║░░░██║╚█████╗░
  ██║░░██╗██╔══██║██║░░██║██╔══██╗██║░░░██║░╚═══██╗
  ╚█████╔╝██║░░██║╚█████╔╝██║░░██║╚██████╔╝██████╔╝
  ░╚════╝░╚═╝░░╚═╝░╚════╝░╚═╝░░╚═╝░╚═════╝░╚═════╝░

  ChorusCore 0.1.0  ·  Paper 1.21.4
  ✔ Storage        sqlite
  ✔ Economy        built in, 412 accounts
  ▪ Placeholders   PlaceholderAPI not installed
  ▪ Languages      English only
  ✔ Scheduling     one server thread
  ✔ Modules        14 of 14
  ✔ Commands       138 registered

  Ready in 214ms

A tick is something it connected to; a dot is something it did not find and is carrying on without. Read it once after every change to the config — most of what people report as a bug is one of these lines saying something the owner did not expect.

startup-banner: false in config.yml replaces the whole block with a single line.

/chorus status prints the same information at any time.

Optional plugins#

Plugin	What changes if it is there
Vault	The built-in economy is offered to every other plugin, and another economy plugin can take over instead. Without it, `/pay` and `/balance` still work — the plugin keeps its own balances.
PlaceholderAPI	The `%chorus_...%` placeholders register themselves. See API and placeholders.

Both are soft dependencies. Neither is needed.

Folia has no Vault. That is not a problem: the built-in economy is the default and does not need it. See Folia.

Updating the plugin#

Stop the server.
Replace the jar.
Start it.

Config files are never overwritten. A release that adds a setting adds it with its default when the file is next read, and a release that adds a database column adds it as its own migration step, so nothing is lost going forward.

Read the release notes before skipping several versions at once.

Removing it#

Take the jar out. The plugins/ChorusCore/ folder stays where it is, database included, so putting the jar back gives you everything again. Delete the folder as well for a clean start.

There is nothing written into the world files except chest shop signs, which stay as ordinary signs.