Skip to main content

Installation

Get zCollections running on your server, then tune it to taste.

Requirements

NeedDetail
ServerSpigot or Paper
Minecraft1.21 and newer in the 1.21 line
Java21
Vault + an economy pluginOnly if you want money rewards
PlaceholderAPIOnly if you want placeholders

Vault and PlaceholderAPI are optional. The plugin enables fine without them, it just skips the features that need them.

Install steps

  1. Stop your server fully before adding the jar.
  2. Drop the zCollections jar into your plugins/ folder.
  3. Start the server. The plugin creates its config files on first run.
  4. Stop the server, edit the configs if you want, then start it again.

The plugin downloads a few small libraries on first start (database drivers and the config library). This needs an internet connection the first time only.

First run

On first start the plugin writes its default files and creates the database. Players can open the menu right away with /collection. Out of the box there are six collections ready to use, so you can test gathering immediately.

Plugin folder layout

After first run your folder looks like this:

plugins/
zCollections/
config.yml
categories.yml
menus.yml
lang/
english.yml
french.yml
spanish.yml
italian.yml
german.yml
data.db
FileWhat it holds
config.ymlGeneral settings: language, storage, notifications, save interval. See Configuration.
categories.ymlEvery collection, resource, tier, and reward. See Categories.
menus.ymlMenu layout and buttons. See Menus.
lang/Message files, one per language. See Messages and Language.
data.dbThe SQLite database (only when storage is SQLite). See Storage.

Optional integrations

  • Vault + an economy plugin turns on money rewards. Without it, money rewards are skipped and the rest still work.
  • PlaceholderAPI exposes progress and tier placeholders for scoreboards, tab lists, and holograms. See Placeholders.
tip

The config files update themselves when the plugin adds new options in a later build. Your edits are kept. Do not change the *-version line at the top of each file, it controls those updates.