Installation

To try GrayCore, use the local development stack: it starts everything below with one command. This page is about running it on real servers.

What you need

Component	Version
Paper (game servers)	26.3
Velocity (proxy)	4.3
Java	25
PostgreSQL	any supported version (the driver is 42.7)
Redis	any supported version
server-service	built from this repository (server-service/), a Docker image is published by the CI

Each Paper server also needs TAB, PlaceholderAPI and WorldGuard (with FastAsyncWorldEdit or WorldEdit): GrayCore does not start without them. The proxy needs TAB.

Steps

1. Start PostgreSQL, Redis and server-service. server-service needs GRPC_API_KEY: the key the servers will present.
2. Install the jars: graycore-paper.jar in the plugins/ folder of every Paper server, graycore-velocity.jar in the one of the proxy.
3. Set the environment variables of each server and of the proxy, see Environment variables. A game server refuses to start without them.
4. Fill in the configurations: the database and Redis in plugins/GrayCorePaper/config.yml, the database in the proxy's config.yml. See Configuration.
5. Create the database schema once: set enableLiquibase: true on one server (or createStructure: true on the proxy) for the first start.
6. Start the servers, then the proxy. On its first start, a Paper server creates the admin group with every GrayCore permission. Give it to yourself from the console with /grayperms.

Checking it works

• In game, /grayserver list (with the admin permission) shows the servers the proxy knows.
• /debug on shows how your profile was loaded and which servers the proxy considered when routing you.