Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/BG-Software-LLC/SuperiorSkyblock2/llms.txt

Use this file to discover all available pages before exploring further.

The warp system allows island owners to create public teleport points on their islands. Visitors can use these warps to quickly navigate to specific locations or attractions.

Creating Warps

Set a warp at your current location:
/island setwarp <name>
1

Stand at desired location

Move to the exact spot where you want players to teleport.
2

Execute setwarp command

Use /island setwarp <name> with a unique name for the warp.
3

Configure warp settings

Optionally set the warp to private or customize its icon.
Requirements:
  • superior.island.setwarp permission
  • SET_WARP island privilege (Moderator role and above by default)
  • Available warp slot (based on warps limit)
The default warps limit is configurable in config.yml and can be increased through island upgrades.

Listing Warps

View all warps on an island:
# List warps on your island
/island warps

# List warps on another player's island
/island warps <player>
This displays:
  • Warp names
  • Warp icons (if set)
  • Public/private status
  • Warp categories

Using Warps

Teleport to a specific island warp:
/island warp <player> <warp-name>
Requirements:
  • superior.island.warp permission
  • Island must be open OR you must be a member/coop
  • Warp must be public (unless you’re a member)
When visiting an island, you can view available public warps using /island warps <player> and then click on the warp to teleport.

Deleting Warps

Remove a warp from your island:
/island delwarp <warp-name>
Requirements:
  • superior.island.delwarp permission
  • DELETE_WARP island privilege (Moderator role and above by default)
Deleting a warp is permanent. You’ll need to create it again if you want to restore it.

Warp Categories

Organize warps into categories for better management:
  • Default Category: Uncategorized warps
  • Custom Categories: Create themed categories (e.g., “Farms”, “Shops”, “Attractions”)
Categories help visitors navigate islands with many warps.

Private Warps

Make a warp private so only island members can use it: Warp privacy is managed through the warp configuration. Private warps:
  • Don’t appear in public warp lists
  • Can only be used by island members
  • Useful for member-only areas

Warp Icons

Customize the icon that appears in the warps menu: The warp icon is displayed when players view the warps list. Icons can be:
  • Any valid Minecraft item
  • Configured through the warps menu
  • Used to represent the warp’s purpose visually
Warp icons support placeholders, including {0} for the warp name. This allows for dynamic item names and lore.

Warp Locations

Warp locations store:
  • World: Which dimension (normal, nether, end)
  • Coordinates: Exact X, Y, Z position
  • Rotation: Yaw and pitch for player facing direction
You can update a warp’s location by using /island setwarp <name> again.

Warps Limit

Islands have a maximum number of warps they can create:
default-values:
  warps-limit: 3
Increase the limit through:
  • Island upgrades
  • Admin commands
  • Permissions (if configured)
Players can check their current warp usage by opening the warps menu with /island warps.

Global Warps

The global warps system displays all public warps across all islands:
/island warps
Global warps are:
  • Sorted by island rank (configurable: worth, level, rating, or players)
  • Filtered to show only public warps
  • Great for server-wide navigation

Admin Commands

Administrators can manage warps with special commands:
# Delete a warp on any island
/admin delwarp <player> <warp-name>

# Set warps limit for an island
/admin setwarpslimit <player> <limit>

# Add to existing warps limit
/admin addwarpslimit <player> <amount>
Permissions:
  • superior.admin.delwarp - Delete warps
  • superior.admin.setwarpslimit - Set warps limit
  • superior.admin.addwarpslimit - Increase warps limit

Use Cases

Public Shops
  • Create a warp to your shop area
  • Name it “Shop” with a chest icon
  • Make it public for customer access
Island Tours
  • Set warps at key attractions
  • Name them descriptively (“Mega Farm”, “Castle”, “Maze”)
  • Guide visitors through your island
Member Areas
  • Create private warps to storage rooms
  • Set warps at important work areas
  • Quick access for team members
Events and Games
  • Warp to event locations
  • Parkour course starting points
  • PvP arenas or minigames

Best Practices

1

Use descriptive names

Name warps clearly so visitors know where they lead (e.g., “Shop”, “Farm”, “PvP Arena”).
2

Set appropriate icons

Choose icons that represent the warp’s purpose (chest for shops, wheat for farms).
3

Keep warps updated

Remove outdated warps and update locations as your island changes.
4

Balance privacy

Make visitor attractions public, but keep utility warps private.

Configuration

Warp system settings in config.yml:
default-values:
  warps-limit: 3  # Default number of warps per island

global-warps-order: 'WORTH'  # How to sort global warps
Changes to warp limits require a restart or reload to take effect. Existing warps are not affected when reducing limits.

Build docs developers (and LLMs) love