Installation Guide
Prerequisites and setup steps for modl.gg.
Prerequisites
Before installing modl.gg, make sure you have the following:
- Java 8 or higher installed on your server
- A Minecraft server running one of the supported platforms:
- Spigot (or most Spigot forks such as Paper)
- BungeeCord (or most BungeeCord forks such as Waterfall)
- Velocity
- Your Minecraft server must be connected to the internet.
Setup Steps
Getting modl.gg up and running involves four steps:
- Download the latest version of the Minecraft plugin at https://github.com/modl-gg/minecraft/releases
- Install the plugin on all your Spigot servers and your Velocity/Bungeecord proxy (or just Spigot server if you aren't using a proxy).
- Run your server and wait for the setup wizard to show up in console.
- Follow the steps in the setup wizard
- When installing in bridge-mode (spigot server behind proxy), you can grab the api-key from proxy plugin's boot.yml
- If you are using Pterodactyl and running a proxy, you will need to allocate port 25590 (or whatever TCP query port you specified) to the proxy in order for the backend servers to connect.
- Done! Enjoy the plugin and join our discord if you need any assistance or want to suggest features.