LobbyAPI
What is LobbyAPI
LobbyAPI was created to manage multiple worlds and allow players to teleport to those worlds using user friendly menu, while being able to be fully configurable.Just by using the commands /lobby or /hub, the player has access to all worlds specified in the menu, where when they click on the block the represents a world they are teleported to location given to that world. LobbyAPI has tons of configurable methods to change the color of the block in the menu, the amount of that block, what spot it is located, and the description of the world, who can see or go to a world, along with the methods for how the world will interact with other worlds.
How to create and manage worlds
If you a re new to LobbyAPI, you can find a guide how to set up worlds at this link:
https://dev.bukkit.org/projects/lobbyapi/pages/events/basic-command-tutorial
Features
- Allows players to teleport from world to world.
- Menu is fully customizable
- Shows all players in given world
- Allows players to teleport from Server to Server (for bungee servers only).
- Allows other plugins to access when a player teleports to a new world or clicks on a new world in the menu.
- Works on all versions of Bukkit
- Plugin support LobbyAPI is just the back-bone for the plugins that will add the worlds. All that is needed to add a world to the menu will be under Developer Information.
Icon Customization is here!
Now you can easily customize the materials, description, and other attributes for each world registered!
Commands
/Lobby | Opens up the WorldMenu |
/Hub | Opens up the WorldMenu |
/LobbyApi | Allows you to change some properties of LobbyAPI |
/LobbyApi addWorld [world] [slot] [x][y][z]..... | Adds a world to the LobbyAPI menu |
/LobbyApi removeWorld [world] | Removes a world to the LobbyAPI menu |
/LobbyApi addServer [server-name] [slot] | Adds a server to the LobbyAPI menu |
/LobbyApi removeServer [server-name] | Removes a server to the LobbyAPI menu |
/LobbyApi listServers | Shows a list for all the servers |
/LobbyApi listWorlds |
Shows a list for all the worlds |
/LobbyApi setDefaultWeather [world] [weather] | Sets the default weather for a world. Choices are NORMAL, NO_RAIN, and ALWAYS_RAINING |
/LobbyApi addJoiningCommand [world] [command] | Adds a command that should be sent when a player joins that world. |
/LobbyApi removeJoiningCommand [world] [command id] | Removes a command that should be sent when a player joins that world. |
/LobbyApi listJoiningCommands [world] | Lists all the commands that are sent when a player joins that world. |
/LobbyApi listJoiningCommands [world] | Lists all the commands that are sent when a player joins that world. |
(There are a few more commands, but I've had issues recreating the table :p):
/LobbyAPI generateNetherAndEndFor", "Generates a nether and end world for the world"
/LobbyAPI setMainLobby", "Changes the default spawn world"
/LobbyAPI removeMainLobby", "Removes default spawn world"
/LobbyAPI setMaterial", "Sets the material icon for a world"
/LobbyAPI setDisplayName", "Changes a display name for a world."
/LobbyAPI setDescription", "Sets the description for a world"
/LobbyAPI hideWorld", "Hides a world from the menu."
/LobbyAPI showWorld", "Shows the world from the menu, if previously hidden"
/LobbyAPI setWorldSelector", "Sets the word selector to be the item in the sender's hand"
/LobbyAPI removeWorldSelector", "removes word selector"
/LobbyAPI setGamemode", "Sets the description for a world"
/LobbyAPI changeSpawn", "Changes the spawn location for a world"
/LobbyAPI version", "Gets the version of the plugin"
/LobbyAPI setvoidlooping", "Enables or disables teleporting players to spawn if they are in the void"
/LobbyAPI setdisablehealthandhunger", "Enables or disables health or hunger changes for worlds"
/LobbyAPI setlocationsaving", "Enables or disables location saving when a player leaves the world"
/LobbyAPI setcanuseportals", "Enables or disables portals for certain worlds."
/LobbyAPI addDefaultItem", "Adds the item in your hand to the list of default items."
/LobbyAPI removeDefaultItem", "Adds the item in your hand to the list of default items."
/LobbyAPI listDefaultItems", "Adds the item in your hand to the list of default items."
/LobbyAPI addDecor", "Adds a decor item to the hub menu"
/LobbyAPI removeDecor", "Removes a decor item."
/LobbyAPI toggleWhitelist", "Toggles whether the world is restricted to only certain players"
/LobbyAPI addToWhitelist", "Adds a player to a world's whitelist"
/LobbyAPI removeFromWhitelist", "Adds a player to a world's whitelist"
/LobbyAPI listWhitelist", "Adds a player to a world's whitelist"
/LobbyAPI goto", "Teleports the player to the spawn of a world"
Permissions:
- lobbyapi.*
- ---Gives access to all lobbyapi features
- lobbyapi.user
- --Gives all commands that users should have. If you do not know what permissions to give to your players, just give them this.
- lobbyapi.commands
- --Only gives access to commands
- lobbyapi.hub
- --Gives access to the /hub commands.
- lobbyapi.bypassworldlimits
- --Gives players the ability to join worlds that are private, or have gone over the player limit
Dependencies and Compatibility
LobbyAPI does not depend on any other plugin, and should work with all other plugins. If you receive any errors from my plugin or features or not enabled for you, please make a comment or ticket of this page.
Developer Information
If you want to register a world through a plugin, use the guide HERE . Call this method in onEnable method to register worlds when the plugin loads.
To add a BungeeServer to the menu, all you need is this line: LobbyAPI.registerBungeeServer(String bungeeServersName, Description, WoolColor);
How to Install
- Drop this plugin into you plugins folder
- Find/Create a plugin that will allow you get to your world
- Restart your server
This plugin uses bStats:
bStats is a metrics service that allows me to to see how many servers use my plugins, how many players they have, and which countries use my plugin the most. All information is anonymized, so no information can be directly linked to you, and instead is added to the average of all severs that use the plugin.
In reply to ZombieStryker:
Hi again , i have another question. How can I whitelist someone from a world?
This is my first server so I have a lot to learn.
In reply to Forge_User_80763564:
Hi Stryker! So when i make a new world and teleport to it , the coordonates don't work , like I cannot place an armor stand to make floating text because it needs the coords to place it. Can you help me out?
In reply to Forge_User_80763564:
In reply to ZombieStryker:
I have an problem, i created a world called "Casa" without doing nothing before teleporting me into the world, now i don't know how to leave the world and return to the default one, how do i solve this?
In reply to thedarkprox15:
Hi, I was told to report this by the game, it says: "The config has already registered this world, even though LobbyAPI has not. This should not happen, but if it does, report this to Zombie_Striker." How do I solve this issue?
Edit: It seems to have registered it anyway, under the name of the color wool it is, but when I click it, it does nothing.
Edit Edit: Alright, to solve it, stop the server, delete the config file inside the LobbyAPI folder, start the server and add the worlds again.
In reply to StolidSnow0:
That should only happen if the name of the world is already registered in the config, but not as a legitimate world. As long as you did not manually make any changes to the config while the server is running, this error should not appear.
If the problem happens again, can you post how to replicate the problem?
In reply to ZombieStryker:
In reply to StolidSnow0:
I get the question if it is up to date?
I downloaded the last version and I use the last mc version!
Is it compatible with mc 1.12.2?
In reply to BoemieGamesNL:
GEtting this error please help !
In reply to 2018k__:
Witam! (i'm from Polish)
Nie wiem jak zmienić żeby lobbyAPI działało i było widoczne dla wszystkich graczy i czy jest to możliwe. Za odpowiedź bardzo dziękuje.
In reply to Forge_User_02445471:
On the page it shows different blocks as icons, i cant find any commands on how to do this. could you tell me how?
*edit*
i figured it out
Hey just wondering if there is a command to change a worlds spawn point when you join it, as /setworldspawn doesnt change the lobbyapi spawn