Run a Minestom server on Kixa
Minestom is a library for building your own light server, great for lobbies and minigames. Kixa runs the server you build, or a simple flat lobby until you upload one.
Create the server
- Choose Create your server, pick Minestom as the software and pick the Minecraft version your code is built for.
- Start it. With no jar of your own, Kixa runs a small flat lobby, so you can check that joining works.
- Build your server as one jar with everything inside it (a shaded or fat jar, for example with the Gradle Shadow plugin).
- Stop the server, upload the jar in Files as server.jar in the top folder, and start it again. Kixa runs it on Java 25.
Turn on Velocity forwarding
Players reach your server through the Kixa gateway, which checks who they are. Your server must only let in players the gateway sends, so start Minestom with Velocity forwarding and the secret Kixa gives you:
import net.minestom.server.Auth;
import net.minestom.server.MinecraftServer;
String secret = System.getenv("KIXA_FORWARDING_SECRET");
int port = Integer.parseInt(System.getenv().getOrDefault("KIXA_PORT", "25565"));
MinecraftServer server = MinecraftServer.init(new Auth.Velocity(secret));
// set up your worlds and events here
server.start("0.0.0.0", port);Settings Kixa gives your server
| Environment variable | What it holds |
|---|---|
| KIXA_PORT | The port to listen on. Listen on 0.0.0.0. |
| KIXA_FORWARDING_SECRET | The Velocity forwarding secret. It changes on every start, so read it each time. |
| KIXA_MOTD | The MOTD from Settings. |
| KIXA_MAX_PLAYERS | The max players shown, from Settings. |
How Kixa checks your server
When your server starts, Kixa tries one login without forwarding. Your server counts as online once it asks for Velocity forwarding. If it lets that login in (offline mode) or asks for a Mojang login, Kixa stops it and says why in the console. This way nobody can join under someone else's name.
Kixa sends console commands to your server's standard input. Read it if you want stop to shut your server down cleanly. If the server is still running 15 seconds after stop, Kixa ends it.
What works
- Console, Files, backups, start and stop work like on any other server.
- Free servers sleep when nobody is online and wake up when someone joins.
- Minestom has no Bukkit or Paper plugins, so there is no Plugins tab. Add features in your own code.
- Players need the Minecraft version your server is built for. Kixa does not add ViaVersion to Minestom servers.
Common questions
- Can I run Minestom on the free plan?
- Yes. Minestom servers use little memory, so they fit the free plan and small servers well.
- How do I go back to the Kixa lobby?
- Stop the server, delete server.jar in Files and start it again.