The Hub World addon creates a bidirectional hub-and-spoke portal system. You designate one world as the hub and register a set of portal locations within it. When a player uses a Dimensions portal from anywhere on the map, they are sent to one of the hub portals. When they then use a portal from inside the hub, they are returned to the last portal they came from. This pattern is perfect for lobby or spawn servers where you want players to navigate between worlds through a single central hub.
How It Works
- A player on any server world uses a Dimensions portal.
- The addon intercepts the teleport and sends the player to a hub portal instead of the normal destination.
- The addon remembers which portal the player came from.
- When the player uses a portal from inside the hub world, they are returned to the origin portal.
Use the /dim addHub command while looking at a portal to register it as a hub portal — you do not need to manually enter coordinates in the config. The command adds the location directly to the Portals.List.
Configuration
Add the following block to your portal’s .yml file:
Addon:
Hub:
World: '<hub_world>'
Portals:
List:
# - world,x,y,z
Mode: <mode>
| Field | Type | Description |
|---|
World | String | The name of the world to treat as the hub. Set to 'false' (or remove the line) to disable the hub for this portal. |
Portals.List | List | The coordinates of each hub portal, in world,x,y,z format. Use /dim addHub to populate this automatically. |
Portals.Mode | String | How to select a hub portal when multiple are registered. See options below. |
Hub Selection Modes
| Mode | Behaviour |
|---|
random | Teleports the player to a randomly chosen portal from the list each time. |
firstToLast | Teleports the player to the first currently-lit portal in the list, working from top to bottom. |
If a hub portal is broken (unlit), it is not automatically removed from the list. If all hub portals are broken at the same time, Dimensions cannot deliver players to the hub and their return destination is lost. Keep at least one hub portal lit at all times.
Full Example
The following config turns the portal into a hub-aware portal. Players who use it are sent to a random active portal in the hub world, and using a portal from hub returns them to their origin:
Addon:
Hub:
World: 'hub'
Portals:
List:
- 'hub,100,64,200'
- 'hub,150,64,200'
- 'hub,200,64,200'
Mode: random
Adding Hub Portals via Command
Rather than editing the config manually, stand in front of a lit hub portal and run:
Dimensions will append the portal’s coordinates to the Portals.List automatically.
The Portals.List only works when World is set to a valid world name. If World is set to 'false' (or removed), the hub system is disabled entirely for that portal and the list is ignored.
