Information

With this plugin you can allow your players to transfer between your server network and worlds with simplicity. NaviCompass is a plugin that uses FormAPI to easily display your servers and server worlds listed in a simple UI. It's easy, all you need to do is enter your IPs and ports of the servers or the names of your worlds you would like to add, along with a label to show up as the name in the UI, all inside the config.yml file. After that, the plugin will do the rest and you're good to go! Players will either have option to interact with the selector item (can be customized in the config.yml file), or type your custom command (can also be customized in the config.yml file) in chat to access the UI. Server networks simplified!

There are two ways to access the UI:

Execute type your custom command in chat or from the console (the default command is /servers)
Right click with the custom selector item set in the config.yml

Here's an example of how it will look:

Config

Command settings

  # Choose whether the command method should be enabled
  Enabled: true

  # This is name of the command that players will use to open the UI
  Name: "/servers"

  # This is the command's description shown in the command window
  Description: "Open the server list!"

  Permission:
    # Choose whether to require players to have permission to use the command
    Enabled: false

    # This is the command's usage permission
    Node: "navicompass.use"

Selector settings

  # Choose whether the selector item should be enabled
  Enabled: true

  # Choose what item the server selector should be
  # Default item is Compass (345)
  Item: 345

  # Choose what slot of the player's inventory the selector should appear in
  # The range for this input is 0-35 (0-8 are the player's hotbar)
  Slot: 0

  # Choose whether to prevent players from dropping or moving the selector to different slots
  Force-Slot: true

  # This is the text that will show on the selector in the player's inventory
  Name: "§l§aServer Selector"

  # This is the selector item's description that is displayed under the name
  Lore: "§bClick for Servers"

UI settings

  # This is the title of the transfer UI
  Title: "§9Server List"

  # This is the message that will show under your title on the transfer UI
  Message: "§aChoose a server to transfer to!"

  # This is the message displayed under each SERVER button
  # Don't worry about this if you're only using the INTERNAL transfer type
  # Use '{current-players}' for the server's current player count
  # Use '{max-players}' for the server's max player count
  # Use '{status}' to show whether the server is online or offline ('Online' will show as green; 'Offline' will show as red)
  Server-Button-Subtext: "§r{status} §8(§a{current-players}§8/§b{max-players}§8)"

  # This is the message displayed under each WORLD button
  # Don't worry about this if you're only using the EXTERNAL transfer type
  # Use '{current-players}' for the world's current player count
  World-Button-Subtext: "§r§o§8Tap to Teleport §8(§a{current-players} §eplayer(s)§8)"

Entry Listing

This is where you list your servers/worlds to be displayed on the server UI. You can use '§' and '&' on the labels to colorize your entries inside the UI!

Add SERVERS using this format → ext:ServerTitle:ServerIP:ServerPort:ImageType:Path/URL

Add WORLDS using this format → int:WorldTitle:WorldAlias:ImageType:Path/URL

List:
  - "ext:§l§2Prison §eServer:play.xenoservers.net:19133:url:file.xenoservers.net/Resources/GitHub-Resources/navicompass/prison.png" # ← EXTERNAL server example
  - "int:§l§5Creative:xenoCreative:url:file.xenoservers.net/Resources/GitHub-Resources/navicompass/creative.png" # ← INTERNAL world example