Documentation
Getting started

Network

Link several servers to one shared database, with players, money, ranks and settings synced everywhere.

InglisCore is built for networks. All your servers share one database, so a player keeps the same balance, ranks, sanctions, homes and progress on every server, and a setting changed in the web editor applies to the whole network at once.

Note

Linking several servers is part of the complete edition. In the free edition, each server runs on its own. See editions.

What you need

  • A MySQL or MariaDB database reachable from every server.
  • A Velocity or BungeeCord proxy in front of your servers, with forwarding enabled on each server as usual. Nothing needs to be installed on the proxy.
  • Optional: a Redis server for instant sync.

Step 1: set up the first server

Install InglisCore on your first server (for example your lobby) and choose MySQL / MariaDB in the setup wizard. Restart the server when the wizard asks you to. See installation.

Step 2: choose how servers talk to each other

Servers exchange live events (a ban, a payment, a teleport request, a staff chat message) through a messaging channel. Open System in the web editor: the Network panel shows the mode in use.

Mode How it works
Proxy messaging Used automatically when the server runs behind Velocity or BungeeCord. Nothing to set up. Messages travel through connected players, so a server with nobody online cannot receive them until someone joins.
Redis Instant sync between servers, even when no player is online. Recommended for busy networks.
Single server No proxy and no Redis detected: the server works on its own.

To use Redis, open System, turn on Redis, enter the host, port and password, press Test, then Save and restart the server. If Redis becomes unreachable, InglisCore falls back to proxy messaging and keeps trying to reconnect every 30 seconds.

Even without any messaging, settings and messages saved in the editor reach every server within a few seconds, because they are read from the shared database.

Step 3: add the other servers

You do not need to run the setup wizard on the other servers. Instead, you attach them with an invite code.

  1. On the first server, open System in the web editor and click Generate an invite code under Add a server to the network.
  2. Copy the command shown. It looks like /inglis join <code> <pin>.
  3. Install InglisCore on the new server, start it once, then paste the command in its console.
  4. Restart the new server.

The new server now uses the same database (and the same Redis, if you set one up) as the rest of the network.

Warning

The invite code contains your encrypted database connection, protected by its PIN. It is valid for 24 hours. Do not share it, and generate a new one whenever you add a server.

/inglis join only works from the console. If the code has expired, generate a new one. If the console says the code or PIN is wrong, copy the full command again.

Server IDs

Every server has its own server ID, shown at the top of the web editor and under System. It is used for per server settings and to tell servers apart on the network. Server IDs do not need to match the server names in your proxy configuration: InglisCore finds the right proxy name on its own.

Warning

Do not copy a server folder that already has InglisCore set up to create a new server: both copies would share the same server ID. If that happens, the console warns you. Install InglisCore fresh on the new server and attach it with an invite code instead.

Per server overrides

By default, settings apply to the whole network. When one server needs something different (another scoreboard on the lobby, a module only on survival), open the module page, switch Apply to to This server, and change what you need. Only those values are overridden on that server; everything else still follows the network.

  • Overridden settings are marked Overridden here.
  • Remove this server's overrides brings the server back in line with the network.
  • Modules can be enabled or disabled per server the same way.
  • Settings marked Network only always apply to every server.

To edit another server's overrides, open the editor from that server with /inglis web.

What is shared across the network

  • Player data: profiles, playtime, name and IP history.
  • Ranks, temporary ranks and permissions.
  • Sanctions: bans, mutes, warnings and their history.
  • Money and transaction history.
  • Warps, homes, the network spawn, /tpa and teleports between servers.
  • Kit cooldowns, daily rewards, levels, quests, achievements and the battle pass.
  • Leaderboards, crate keys, the mailbox, clans and the auction house.
  • Staff chat, freeze, reports and tickets.
  • Settings, enabled modules and messages edited in the web editor.

Rewards that are claimed once (daily reward, battle pass tiers, leaderboard prizes) can only be claimed once on the whole network.