Quickstart
Requirements
- You must have Java 21 or later installed.
- This guide assumes you’re using a Bash-like shell. Use Linux for best results; on Windows, you can modify the scripts or use WSL.
- Docker is recommended to quickly run the required MongoDB and LuckPerms services.
Setup
-
Clone the Quickstart and Server repositories:
Terminal window git clone https://github.com/BlueDragonMC/Quickstartgit clone https://github.com/BlueDragonMC/Server -
Install and start MongoDB and LuckPerms
Terminal window docker run -d -p 27017:27017 mongodocker run -d -p 8080:8080 ghcr.io/luckperms/rest-api -
Give yourself permissions:
By default, LuckPerms does not grant any permissions. To fix this, run the following command:
Terminal window docker run --rm -it -e LUCKPERMS_STORAGE_METHOD=mongodb -e LUCKPERMS_DATA_MONGODB_CONNECTION_URI="mongodb://localhost:27017/" -e LUCKPERMS_DATA_DATABASE=luckperms --net host ghcr.io/luckperms/rest-apiThis creates a terminal where you can run LuckPerms commands in a session connected directly to the database. Then, in that terminal, run the following command:
lp group default permission set * trueIf you want to be less permissive, you can give permissions to yourself:
lp user YOURNAME permission set * trueSee LuckPerms’s documentation for more information on permissions.
Once you’re done, press
CTRL + C
to close the terminal. Finally, restart your existing LuckPerms container to see the changes take effect.Terminal window docker restart $(docker ps -q --filter ancestor=ghcr.io/luckperms/rest-api) -
Run the server:
- If you are using IntelliJ, use the run configuration called “Run development server”
- If not, run the following command in the root of your project:
Terminal window ./gradlew runDev
This will build the core Server project, the Lobby, and the example minigame, copy them into their appropriate locations, and then run the Server with the games installed.
-
Join the server. It should appear as a LAN world, but if not, the IP address will be
localhost
.
Further Reading
- Learn more about the
worlds
folder. - Explore the code of the Quickstart project and create your own game.