🌎 Setup with Multiverse

Integrate PhoenixLobby with worlds directly, without the need for a proxy server.

The lobby should be in its own separate world, not in a world where players will be playing normally.

We recommend using proxy integration as it offers more benefits for your server.

#Installation

For the best experience with world integration, we recommend using Multiverse-Core, as it is the top choice for world management and ideal for this setup method.

#Step 1:

The first step is to whitelist your lobby world so the plugin functions as a lobby only on that specific world. To achieve this, follow the steps below:

Open the config.ymlof the plugin, and find the worlds:
Then make sure you have should-use as ENABLED_WORLDS and you put the name of your lobby.

worlds:
  should-use: ENABLED_WORLDS
  enabled:
  - your_lobby_name_here
  disabled: []

This step is required, not optional. Out of the box the plugin treats every world as a lobby, so your other worlds get the scoreboard, the tablist, the hotbar items, the world protection and the inventory clearing until you set this.

This is the whole plugin, every module at once. The lobby items have a worlds block of their own that only decides where the items are handed out, which is a separate and narrower setting.

#Step 2:

The second step is to modify the commands that will be executed when a user clicks an item in the compass.

Open the menus folder, then the servers.yml file. Next, find your servers in the following example, we will use "survival".
Modify the current third line that teleports the user to use the Multiverse command, as shown in the example below:

  survival:
    slot: '14'
    material: GRASS_BLOCK
    amount: 1
...
    actions:
    - '[CLOSE_INVENTORY]'
    - '[MESSAGE] &7Sending you to &aSurvival&7.'
    - '[COMMAND] console; mvtp %player% your_server_world'

You might need to add the permission multiverse.access.your_server_world to the users, if they cant access that world.

#Step 3:

Once you have done the steps above, make sure to reload the plugin with /plobby reload

#Step 4:

If you want for the /lobby command to teleport the users to your lobby world, follow the method below.

Go to your commands.yml (on your server's main directory) and add this:

command-block-overrides: []
ignore-vanilla-permissions: false
aliases:
  hub:
  - mvtp $1 lobbyworldname
  lobby:
  - mvtp $1 lobbyworldname

#Additional Information

#Separate World Inventories:

The plugin can hold the inventory for you, so Multiverse-Inventories is not needed for this. Turn it on in the join module:

restore-inventory: true

With this on, the inventory a user carries into a lobby world is put away before it is cleared, and handed back when they leave for a world that is not a lobby. It is kept in the database, so it survives a rejoin or a restart.

While this is off, and it is off by default, the inventory is cleared on the way into a lobby world with no copy kept. Your users lose what they were carrying.

You can also scope the lobby items to your lobby world, so they are only handed out there:

worlds:
  should-use: ENABLED_WORLDS
  enabled:
  - your_lobby_name_here
  disabled: []

The plugin keeps one inventory, the one held before entering the lobby. If you run several gameplay worlds and want each of them to keep an inventory of its own, use Multiverse-Inventories instead.

#Fix the Spawning

If you are using MultiverseCore and a player dies in the Nether or the End, they will respawn in the same world where they died. To fix this, run the following command while being on each world:

/mvm set respawnWorld lobbyworldname

#For non Multiverse Users (Optional)

If you don't use Multiverse-Core, you can replace the /mvtp command with the teleportation command specific to your server that teleports the user to another world.

If you dont use any world management plugins, you can still use the vanilla teleport command as the following example. Make sure to replace the X Y Z to the location you want the user to get teleported.

execute as %player% in minecraft:your_server_world run teleport X_location Y_location Z_location

#Limitations with Worlds

Join Message Limitations: The join message system cannot be limited exclusively to the lobby-reserved worlds. Additionally, there is a slight possibility of plugin conflicts if another plugin operates in a different game mode, although such occurrences are rare.
Manual Configuration of Commands: To avoid conflicts, users will need to manually configure the /lobby, /hub, and /spawn commands, especially if they have the Essentials plugin installed.
Aliases for /lobby and /hub: If you intend to use the /lobby and /hub commands, you can create aliases that redirect to /plobby spawn, which teleports the user to the spawn point set in the join module. It works without a proxy.

Last updated about 3 hours ago