custom-lobby

custom-lobby is a small Minecraft lobby server with Minestom as its core.

custom-lobby is built for my private network, so it may or may not fit your needs. It includes a map, got only one instance and small gimmicks just for fun.

Table of Contents

• Install
• Usage
• API
• Maintainers
• Contributing
• License

Install

You could either just download a release or you compile the server yourself using the following commands under Linux

git clone https://github.com/self-crafted/custom-lobby.git
cd custom-lobby
./gradlew build

The server jar will be located at build/libs/custom-lobby-<VERSION>.jar.

Note that for compiling you need to use JDK 25.

Usage

To run the server you need to have Java 25 runtime installed. Use the following command to start the server.

java -jar custom-lobby-<VERSION>.jar

The settings are located at ./config.json with these default values:

{
  "SERVER_IP": "localhost",
  "SERVER_PORT": 25565,
  "MODE": "OFFLINE", // may be OFFLINE, ONLINE, BUNGEECORD or VELOCITY
  "VELOCITY_SECRET": ""
}

You have to restart the server for changes in there to take effect.

Note that the newest version of this server only supports 26.1.1/26.1.2 clients. You may need to use ViaVersion on the proxy.

API

This server itself does not add some API. But it features Minestom's API so you can use it from within extensions.

Maintainers

@offby0point5

Contributing

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

This project is licensed under the Apache License Version 2.0.