Skip to main content

Installation

Get Zander up and running in a few steps. This page covers prerequisites and the installation order — web platform first, then Minecraft plugins.

Prerequisites​

Web Platform (zander-web)​

RequirementMinimum Version
Node.js20.x or later
npm8.5.0 or later
MySQL8.x or later

Minecraft Plugins​

ModuleMinecraft VersionPlatformPlugin Dependencies
zander-addon1.21+Paper / SpigotNone
zander-auth1.19+Paper / SpigotNone
zander-hub1.19+Paper / SpigotPremiumVanish, ProtocolLib
zander-velocity—Velocity proxyNone
note

zander-hub requires both PremiumVanish and ProtocolLib to be installed on the same Paper/Spigot server.

Step 1 — Set Up zander-web​

  1. Clone or download the zander-web repository.
  2. Copy .env.example to .env and fill in all required values (see Configuration).
  3. Copy config.json.example to config.json and configure your site settings.
  4. Create a new MySQL database and run the initialisation script: 
    mysql -u <user> -p <database> < dbinit.sql
  5. Run database migrations in order from the migration/ folder.
  6. Install dependencies and start the application: 
    npm install
    npm run dev       # development
    npm run prod      # production

The API will be available at the siteAddress you configured (default http://localhost:8080).

Step 2 — Install Minecraft Plugins​

Download the built JAR files for the modules you need and place them in the plugins/ folder of the appropriate server.

On each Paper/Spigot game server​

  • zander-addon.jar — all game servers
  • zander-auth.jar — servers requiring authentication

On your hub server​

  • zander-hub.jar
  • PremiumVanish and ProtocolLib (required dependencies)

On your Velocity proxy​

  • zander-velocity.jar

Step 3 — Configure the Plugins​

Each plugin has a config.yml that is generated in plugins/<plugin-name>/ on first run. You must set at minimum:

BaseAPIURL: "https://your-site.example.com/api"
APIKey: "your-api-key"

The APIKey must match the apiKey value in your .env file.

See Configuration for all available options per plugin.