⛓️ Setup with Proxy

#Step 1:

The first step is to install PhoenixLobby on both your proxy server and your lobby servers.

#Step 2:

If you have set up your servers correctly and installed Phoenix Plugins on the right servers, the lobby server should automatically appear in the config.yml of the plugin on your proxy server. If it's not there make sure to set it manually.

servers:
    lobby: {display-name: Lobby, maximum-slots: 100}
registered-lobbies: [lobby]

#Step 3:

Make sure that register-lobby is enabled in the lobby server’s config.yml

proxy:
  register-lobby: true

#Additional Information

#Database

Make sure your database is properly set up in the config.yml if you want to use multiple lobbies. If they aren’t connected to the same database, you may run into issues.

#Enabling Advanced Features and Functionality

Multiple Lobbies Support: With Proxy, you can set up and manage multiple lobbies, each with its own settings, themes, and features.

Automatic Lobby Redirection: PhoenixLobby can send players to lobbies with fewer players, keeping the server balanced.

Seamless Lobby Networking: Players can move between lobbies easily, making the experience smooth across the network.

Queue System: Helps manage high player traffic by placing players in a waiting line, preventing server overload. queue: {enabled: true, forward-time: 5, reminder-time: 5, disable-between-lobbies: true}

Kick-Forward for Lobbying: PhoenixLobby offers a kick-forward mechanism that ensures players are redirected to the lobby server after being kicked from another game server.

lobby:
    connect-on-join: true
    reconnect:
        enabled: true
        blacklisted-reasons: []
        blacklisted-servers: []

Server Shortcuts: Registers one command per server, so /survival sends the player to the survival server instead of them having to type /queue survival. Each entry accepts extra aliases and an optional permission (leave empty for everyone). With use-queue: true the player goes through the queue system, otherwise they are connected right away.

server-shortcuts:
    enabled: true
    use-queue: true
    commands:
        survival:
            server: survival
            aliases: [smp]
            permission: ''

Command names that PhoenixLobby already uses (lobby, hub, queue, leavequeue, maintenance) are skipped, and a shortcut overrides any backend server command with the same name.

Queue Priority: Gives your ranks a better place in the queue. A player holding phoenixlobby.queuepriority.<number> is placed above everyone queued with a lower number, and players sharing the same number keep the order they joined in. Players without the permission count as 0.

queue:
    priority:
        enabled: true
        max-priority: 100

max-priority is the highest number that is looked up when a player joins a queue, so lower it if you only hand out small priority numbers.

Join and Leave Messages: Announces on every server when a player joins or leaves the network, instead of once per backend server. Players holding the silent permission are never announced.

join-messages:
    enabled: false
    silent-permission: phoenixlobby.silentjoin
    join:
        enabled: true
    leave:
        enabled: true

Lobby Auto Registration: Registers a new server as a lobby on its own when its name matches your pattern. This is meant for lobbies that are created automatically, so they join the lobby selector without you adding them by hand.

lobby-auto-registration:
    enabled: false
    pattern: '^lobby-[a-z0-9]{5}-[a-z0-9]{5}$'

Server Switch Logging: Tells the lobby that a player is changing server, so a real disconnect is not logged as one. See the Logger page.

Maintenance: Closes a server, or the whole network, for everyone except the people you allow. See the Maintenance page.

#NPC Actions and Proxy Connectivity

In addition to the queue system, PhoenixLobby offers convenient options for NPC actions. Administrators can use the following actions to connect players directly to specific Proxy servers:

• [COMMAND] player;queue your_server - Triggers the queue system and adds the player to the waiting line before connecting them to the specified server.
• [PROXY] your_server - Directly connects the player to the specified Proxy server without involving the queue system.

#Pre Installed Requirements

Make sure your backend servers are connected to the proxy. If they aren’t, PhoenixLobby won’t detect them. If you're using Velocity or BungeeCord, check their documentation for proper setup. We encourage our users to install Velocity instead of Bungeecord.

Velocity Docs - Click Here

Bungeecord Docs - Click Here