Installation

This page walks through a fresh AtlasLobby setup. The short version: install the jar, start the server once, set your spawn, then customize the generated YAML files.

Requirements

AtlasLobby needs:

Requirement	Notes
Java	Java 21.
Server	Paper or a Spigot-compatible server.
Minecraft	Built for modern Paper and Spigot-compatible 1.21 servers.

AtlasLobby can start without any optional plugins.

Optional integrations:

Plugin	Why you might want it
PlaceholderAPI	Resolves external placeholders in messages, menus, scoreboard lines, and other configurable text.
Vault plus an economy plugin	Needed only if you want priced cosmetics to use Vault-backed economy behavior.
LuckPerms, or another permissions plugin	Recommended for managing admin, menu, cosmetic, and bypass permissions.

Install the Plugin

Stop your server.
Put the AtlasLobby jar into the server’s plugins/ folder.
Start the server once. AtlasLobby will generate its default files.
Join the server and run /setspawn.
Edit the generated YAML files for your lobby.
Run /al reload after normal config changes.

Build From Source

If you are building from source, run this from the project root:

gradle build

The built jar is generated under build/libs/.

If your setup uses a local Gradle distribution or wrapper, run the equivalent build command for that setup.

First Test Checklist

After installation, test the main player flow:

Run /setspawn.
Test /spawn, /lobby, and /hub.
Rejoin and confirm the inventory clears.
Confirm the configured hotbar items appear.
Right-click lobby items and confirm their actions run.
Try dropping and moving hotbar items. They should be blocked by default.
Open /serverselector.
Open /profile.
Open /rewards.
Open /cosmetics.
Run /al debug and check for warnings.

Generated Files

AtlasLobby creates these files inside plugins/AtlasLobby/:

File	Purpose
`config.yml`	Main feature toggles and global behavior.
`messages.yml`	Prefixes, errors, command replies, and other player-facing text.
`items.yml`	Join and hotbar items.
`menus.yml`	Chest menus and menu actions.
`servers.yml`	Server selector entries.
`rewards.yml`	Daily rewards, streaks, coins, and reward commands.
`announcements.yml`	Announcement and news entries.
`cosmetics.yml`	Particles, hats, gadgets, rarities, categories, and cosmetic menu data.
`data/players.yml`	Persisted player data.

Player data is persisted in data/players.yml.