⛓️Setup with Proxy

Proxy Integration available to Bungeecord and Velocity

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: []

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

Last updated

Was this helpful?