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 Jks__Tv:
Hi i was wondering if lobbyapi supports 1.12.2
thanks
In reply to Jks__Tv:
Hey there, I just started using this and found it a bit confusing, but I got it at first.
When I created a new world using ./lobbyapi addWorld [name], it worked and I got teleported to that world. I wanted to go back to the default world, but there was no command(?) or way to go back. I also tried looking at the commands at this page, but none of it seemed to help.
Is there a way for me to go back to the default world?
Thanks.
NOTE\EDIT: Nevermind, I just figured it out!
In reply to Yipikedia:
In reply to ZombieStryker:
In reply to Forge_User_78224567:
/lobbyapi setdisplayname doesn't support color coding but /lobbyapi setdescription does? :(
In reply to diboof:
In reply to diboof:
In reply to ZombieStryker:
In reply to xCaveSlimeYT:
In reply to ZombieStryker:
In reply to ZombieStryker:
In reply to xCaveSlimeYT:
In reply to xCaveSlimeYT:
In reply to xCaveSlimeYT:
In reply to ZombieStryker:
In reply to xCaveSlimeYT:
The above, for example, changes the material for the world to be GRASS.
In reply to ZombieStryker:
hasBungee: false
Version: 3.7.42
Worlds:
world:
name: world
displayname: §4§lFactions
spawnLoc:
x: 179.0
y: 79.0
z: 272.0
w: world
weatherstate: NORMAL
i: 1
save: world
desc: ''
gamemode: SURVIVAL
color: 5
XCaveSlimeYT:
world:
xp: 0.29629636
xpl: 10
health: 20.0
hunger: 17
i:
'0':
==: org.bukkit.inventory.ItemStack
type: DISPENSER
meta:
==: ItemMeta
meta-type: TILE_ENTITY
display-name: §7§lDispenser Of Pain
enchants:
DAMAGE_ALL: 666
blockMaterial: DISPENSER
'1':
==: org.bukkit.inventory.ItemStack
type: BONE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: §f§lGo Fetch!
enchants:
KNOCKBACK: 70
'9':
==: org.bukkit.inventory.ItemStack
type: SPONGE
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: §e§lSuck It Up
enchants:
DAMAGE_ALL: 200
'10':
==: org.bukkit.inventory.ItemStack
type: DROPPER
meta:
==: ItemMeta
meta-type: TILE_ENTITY
display-name: §7§lDrop Like I Do
enchants:
DAMAGE_ALL: 666
blockMaterial: DROPPER
'11':
==: org.bukkit.inventory.ItemStack
type: GRASS
'12':
==: org.bukkit.inventory.ItemStack
type: REDSTONE_TORCH_ON
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: §4§lLight It Up!
enchants:
FIRE_ASPECT: 666
DAMAGE_ALL: 3
'13':
==: org.bukkit.inventory.ItemStack
type: LEATHER_CHESTPLATE
amount: 57
meta:
==: ItemMeta
meta-type: LEATHER_ARMOR
display-name: §5TastyPBJ's Chesplate
lore:
- §5Fight Me
enchants:
PROTECTION_ENVIRONMENTAL: 666
DURABILITY: 9001
color:
==: Color
RED: 137
BLUE: 184
GREEN: 50
'14':
==: org.bukkit.inventory.ItemStack
type: TORCH
amount: 64
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: ' §6Burning §eRod'
lore:
- §cOUCH!
enchants:
FIRE_ASPECT: 999
'16':
==: org.bukkit.inventory.ItemStack
type: CLAY_BRICK
amount: 61
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: §l§400F
lore:
- §4One brick, one broken head.
enchants:
DAMAGE_ALL: 32767
'18':
==: org.bukkit.inventory.ItemStack
type: LEATHER_LEGGINGS
amount: 62
meta:
==: ItemMeta
meta-type: LEATHER_ARMOR
display-name: §5TastyPBJ's Leggings
lore:
- §5Fight Me
enchants:
PROTECTION_ENVIRONMENTAL: 666
DURABILITY: 9001
color:
==: Color
RED: 137
BLUE: 184
GREEN: 50
'23':
==: org.bukkit.inventory.ItemStack
type: END_ROD
amount: 60
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: §l§2Pointy Stick
lore:
- §a*Poke poke*
enchants:
DAMAGE_ALL: 69
'26':
==: org.bukkit.inventory.ItemStack
type: LEATHER_BOOTS
amount: 60
meta:
==: ItemMeta
meta-type: LEATHER_ARMOR
display-name: §5TastyPBJ's Leggings
lore:
- §5Fight Me
enchants:
PROTECTION_ENVIRONMENTAL: 666
DURABILITY: 9001
color:
==: Color
RED: 137
BLUE: 184
GREEN: 50
a:
'1':
==: org.bukkit.inventory.ItemStack
type: LEATHER_BOOTS
meta:
==: ItemMeta
meta-type: LEATHER_ARMOR
display-name: §5TastyPBJ's Leggings
lore:
- §5Fight Me
enchants:
PROTECTION_ENVIRONMENTAL: 666
DURABILITY: 9001
color:
==: Color
RED: 137
BLUE: 184
GREEN: 50
'2':
==: org.bukkit.inventory.ItemStack
type: LEATHER_LEGGINGS
meta:
==: ItemMeta
meta-type: LEATHER_ARMOR
display-name: §5TastyPBJ's Leggings
lore:
- §5Fight Me
enchants:
PROTECTION_ENVIRONMENTAL: 666
DURABILITY: 9001
color:
==: Color
RED: 137
BLUE: 184
GREEN: 50
'3':
==: org.bukkit.inventory.ItemStack
type: LEATHER_CHESTPLATE
meta:
==: ItemMeta
meta-type: LEATHER_ARMOR
display-name: §5TastyPBJ's Chesplate
lore:
- §5Fight Me
enchants:
PROTECTION_ENVIRONMENTAL: 666
DURABILITY: 9001
color:
==: Color
RED: 137
BLUE: 184
GREEN: 50
xMikeGamingYT:
world:
xp: 0.23999986
xpl: 9
health: 12.45772933959961
hunger: 14
i:
'0':
==: org.bukkit.inventory.ItemStack
type: STONE
damage: 5
amount: 3
'1':
==: org.bukkit.inventory.ItemStack
type: END_ROD
amount: 3
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: §l§2Pointy Stick
lore:
- §a*Poke poke*
enchants:
DAMAGE_ALL: 69
'2':
==: org.bukkit.inventory.ItemStack
type: CLAY_BRICK
amount: 3
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: §l§400F
lore:
- §4One brick, one broken head.
enchants:
DAMAGE_ALL: 32767
'3':
==: org.bukkit.inventory.ItemStack
type: DIAMOND_AXE
damage: 5
meta:
==: ItemMeta
meta-type: UNSPECIFIC
enchants:
DIG_SPEED: 5
'4':
==: org.bukkit.inventory.ItemStack
type: DIAMOND_PICKAXE
damage: 450
meta:
==: ItemMeta
meta-type: UNSPECIFIC
enchants:
DIG_SPEED: 5
'5':
==: org.bukkit.inventory.ItemStack
type: STRING
amount: 3
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'6':
==: org.bukkit.inventory.ItemStack
type: DIODE
amount: 64
'7':
==: org.bukkit.inventory.ItemStack
type: COBBLESTONE
amount: 64
'8':
==: org.bukkit.inventory.ItemStack
type: COBBLESTONE
amount: 58
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'9':
==: org.bukkit.inventory.ItemStack
type: SPIDER_EYE
amount: 2
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'10':
==: org.bukkit.inventory.ItemStack
type: COBBLESTONE
amount: 64
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'11':
==: org.bukkit.inventory.ItemStack
type: COBBLESTONE
amount: 64
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'12':
==: org.bukkit.inventory.ItemStack
type: COBBLESTONE
amount: 64
'13':
==: org.bukkit.inventory.ItemStack
type: COMMAND
meta:
==: ItemMeta
meta-type: TILE_ENTITY
display-name: Useless
lore:
- (+NBT)
internal: H4sIAAAAAAAAAFVPwUrDQBCd1UJDjCL4A2HPEm1tD8mpGHqr9WA8lSLL7hKWJjtLMosV6bf6D36BGxWpc3rDmzfvvRgghov7BuVuacnQWyVqBolEqwwZtA+aGIOR8ITAYOzwVXdaQQRx6XvCdi1aDWwRwbjEthVWweUNuXTh0sntPL2bprN8BOcr0dNyr6UfXkIY9vmxjuDEKEh+dd8RTiF58lLqvi/RWxoOg9OgfvTkPMHLO9d76gQvNsdIYoMdL3iNjeLXnAITtko32mFHxtZZlvHD9o85xpvJtJjlxTzfpvzA4KzqhNz92IXmV89OCdL/CjCAL1AOrUw3AQAA
blockMaterial: COMMAND
'15':
==: org.bukkit.inventory.ItemStack
type: STONE
damage: 5
amount: 64
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'16':
==: org.bukkit.inventory.ItemStack
type: EGG
amount: 2
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'17':
==: org.bukkit.inventory.ItemStack
type: COBBLESTONE
amount: 64
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'18':
==: org.bukkit.inventory.ItemStack
type: GRASS
amount: 2
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'19':
==: org.bukkit.inventory.ItemStack
type: COBBLESTONE
amount: 64
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'20':
==: org.bukkit.inventory.ItemStack
type: COBBLESTONE
amount: 64
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'21':
==: org.bukkit.inventory.ItemStack
type: LEATHER
amount: 7
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'22':
==: org.bukkit.inventory.ItemStack
type: DIAMOND
amount: 21
'23':
==: org.bukkit.inventory.ItemStack
type: GRAVEL
amount: 2
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'26':
==: org.bukkit.inventory.ItemStack
type: ROTTEN_FLESH
amount: 41
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'27':
==: org.bukkit.inventory.ItemStack
type: GOLD_LEGGINGS
damage: 103
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'28':
==: org.bukkit.inventory.ItemStack
type: NETHERRACK
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'29':
==: org.bukkit.inventory.ItemStack
type: SEEDS
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'30':
==: org.bukkit.inventory.ItemStack
type: PORK
amount: 5
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
'34':
==: org.bukkit.inventory.ItemStack
type: DIAMOND_CHESTPLATE
damage: 87
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
lore:
- §7StormCaller III
- §7OverLoad V
- §7Fortify III
- §7Infestation II
- §7Valor II
- §b§lPROTECTED
enchants:
PROTECTION_ENVIRONMENTAL: 75
DURABILITY: 10000
'31':
==: org.bukkit.inventory.ItemStack
type: DIAMOND_BOOTS
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
enchants:
PROTECTION_ENVIRONMENTAL: 15
'32':
==: org.bukkit.inventory.ItemStack
type: DIAMOND_LEGGINGS
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
enchants:
PROTECTION_ENVIRONMENTAL: 15
'14':
==: org.bukkit.inventory.ItemStack
type: DIRT
amount: 5
'24':
==: org.bukkit.inventory.ItemStack
type: DIAMOND_SWORD
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
lore:
- §7SkillSwipe III
- §7Paralyze III
- §7Inquisitive III
- §7Viper III
- §7LifeSteal III
- §4Fudging OP Stuff Please DO NOT ABUSE§4
enchants:
DAMAGE_ALL: 10
DURABILITY: 10000
MENDING: 10000
repair-cost: 1
'25':
==: org.bukkit.inventory.ItemStack
type: SULPHUR
amount: 3
'33':
==: org.bukkit.inventory.ItemStack
type: WOOL
damage: 15
'35':
==: org.bukkit.inventory.ItemStack
type: INK_SACK
amount: 4
a:
'1':
==: org.bukkit.inventory.ItemStack
type: LEATHER_BOOTS
damage: 1
meta:
==: ItemMeta
meta-type: LEATHER_ARMOR
display-name: §5TastyPBJ's Leggings
lore:
- §5Fight Me
enchants:
PROTECTION_ENVIRONMENTAL: 666
DURABILITY: 9001
color:
==: Color
RED: 137
BLUE: 184
GREEN: 50
'2':
==: org.bukkit.inventory.ItemStack
type: DIAMOND_LEGGINGS
damage: 137
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
lore:
- §4Fudging OP Stuff Please DO NOT ABUSE§4
enchants:
PROTECTION_ENVIRONMENTAL: 75
DURABILITY: 10000
'3':
==: org.bukkit.inventory.ItemStack
type: LEATHER_CHESTPLATE
damage: 5
meta:
==: ItemMeta
meta-type: LEATHER_ARMOR
display-name: §5TastyPBJ's Chesplate
lore:
- §5Fight Me
enchants:
PROTECTION_ENVIRONMENTAL: 666
DURABILITY: 9001
color:
==: Color
RED: 137
BLUE: 184
GREEN: 50
'4':
==: org.bukkit.inventory.ItemStack
type: DIAMOND_HELMET
damage: 120
meta:
==: ItemMeta
meta-type: UNSPECIFIC
display-name: Useless
lore:
- §7Commander III
- §7AcidRain III
- §b§lPROTECTED
enchants:
PROTECTION_ENVIRONMENTAL: 75
DURABILITY: 10000
Hi. I have a new server Spigot and I installed the plugin like 2 weeks ago. It doesn't make any problem but like 4 days ago the plugin start unistalling alone. I enter on the server and make /hub and it says the command doesn't exist make /help for more options...
I go to my server page and search for the plugin list, LobbyAPI doesn't exist and I have to install it every day. Can you help me with that?
Thanks.
In reply to IkerZalgoP: