{"id":15143892,"url":"https://github.com/xenophilicy/navicompass","last_synced_at":"2025-09-29T12:31:29.613Z","repository":{"id":38021921,"uuid":"168095326","full_name":"Xenophilicy/NaviCompass","owner":"Xenophilicy","description":"PocketMine plugin that lets you transfer between your server network and worlds with a UI!","archived":true,"fork":false,"pushed_at":"2023-07-16T11:02:05.000Z","size":612,"stargazers_count":23,"open_issues_count":2,"forks_count":21,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-09-27T10:21:02.229Z","etag":null,"topics":["compass","lobby","minecraft","navigation","network","players","plugin","pocketmine","servers","teleport","transfer","worlds","xenophilicy"],"latest_commit_sha":null,"homepage":"https://poggit.pmmp.io/p/NaviCompass","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Xenophilicy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-01-29T05:32:05.000Z","updated_at":"2024-06-27T09:26:54.000Z","dependencies_parsed_at":"2022-09-01T09:52:02.378Z","dependency_job_id":"a5ba5ee3-33e1-448a-ac64-ba332a7008ef","html_url":"https://github.com/Xenophilicy/NaviCompass","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xenophilicy%2FNaviCompass","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xenophilicy%2FNaviCompass/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xenophilicy%2FNaviCompass/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Xenophilicy%2FNaviCompass/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Xenophilicy","download_url":"https://codeload.github.com/Xenophilicy/NaviCompass/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234619489,"owners_count":18861456,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compass","lobby","minecraft","navigation","network","players","plugin","pocketmine","servers","teleport","transfer","worlds","xenophilicy"],"created_at":"2024-09-26T10:20:28.756Z","updated_at":"2025-09-29T12:31:24.282Z","avatar_url":"https://github.com/Xenophilicy.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/Xenophilicy/NaviCompass\"\u003e\u003cimg src=\"https://github.com/Xenophilicy/NaviCompass/blob/master/icon.png\"\u003e\u003c/img\u003e\u003c/a\u003e\u003cbr\u003e\n    \u003cb\u003eNaviCompass allows your players to transfer between your server network and worlds with simplicity.\u003c/b\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg alt=\"GitHubrelease\" src=\"https://img.shields.io/github/v/release/Xenophilicy/NaviCompass?label=release\u0026sort=semver\"\u003e\n      \u003cimg alt=\"Stars\" src= \"https://img.shields.io/github/stars/Xenophilicy/NaviCompass?style=for-the-badge\"\u003e\n    \u003ca href=\"https://discord.gg/6M9tGyWPjr\"\u003e\u003cimg src=\"https://img.shields.io/discord/837701868649709568?label=discord\u0026color=7289DA\u0026logo=discord\" alt=\"Discord\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n### **NaviCompass now supports the WaterDog MCBE proxy!**\n\n***\n\n## Credits\n* [Xenophilicy](https://github.com/Xenophilicy/) (original developer)\n* [Vecnavium](https://github.com/Vecnavium/) (Maintainer for the longterm)\n\n# Config\n### Basic settings\n```yaml\n# Choose your transfer type:\n# \"external\" will use an IP address and port to move players between SERVERS\n# \"internal\" will use your preset command string to move players between WORLDS\n# \"hybrid\" will include both transfer types\nTransfer-Type: \"hybrid\"\n\n# This is the command string that will be used to transfer players between WORLDS\n# Don't worry about this if you're only using the EXTERNAL transfer type\n# Use '{player}' for the player's name\n# Use '{world}' for the world name\nWorld-CMD: \"multiworld tp {world} {player}\"\n\n# This is where you choose if world command should be run by the player or the console\n# Don't worry about this if you're only using the EXTERNAL transfer type\n# Options are: \"console\" and \"player\"\nWorld-CMD-Mode: \"console\"\n```\n\n### Command settings\n```yaml\n  # Choose whether the command method should be enabled\n  Enabled: true\n\n  # This is name of the command that players will use to opent the UI\n  Name: \"/servers\"\n\n  # This is the command's description shown in the command window\n  Description: \"Open the server list!\"\n\n  Permission:\n    # Choose whether to require players to have permission to use the command\n    Enabled: false\n\n    # This is the command's usage permission\n    Node: \"navicompass.use\"\n```\n### Selector settings\n```yaml\n  # Choose whether the selector item should be enabled\n  Enabled: true\n\n  # Choose what item the server selector should be\n  # Default item is Compass (345)\n  Item: 345\n\n  # Set the cooldown for using the compass to open the UI\n  Cooldown:\n    # Choose whether the cooldown should be enabled\n    Enabled: true\n\n    # Set the duration of the cooldown\n    Duration: 1\n\n    # Message sent to the player when the item is on cooldown\n    # Set to false to disable the message\n    Message: \"§cCompass is on cooldown!\"\n\n  # Choose what slot of the player's inventory the selector should appear in\n  # The range for this input is 0-35 (0-8 are the player's hotbar)\n  Slot: 1\n\n  # Choose whether to prevent players from dropping or moving the selctor to different slots\n  Force-Slot: true\n\n  # This is the text that will show on the selector in the player's inventory\n  Name: \"§l§aServer Selector\"\n\n  # This is the selector item's description that is displayed under the name\n  Lore: \"§bClick for Servers\"\n```\n### UI settings\n```yaml\n  # This is the title of the transfer UI\n  Title: \"§9Server List\"\n\n  # This is the message that will show under the title on the transfer UI\n  Message: \"§aChoose a server to transfer to!\"\n\n  Status-Format:\n\n    # Edit the format for online servers\n    Online: \"§aOnline\"\n\n    # This is where you edit the format for offline servers\n    Offline: \"§cOffline\"\n\n  Subtext:\n    # This is the message displayed under each SERVER button\n    # Use '{current-players}' for the server's current player count\n    # Use '{max-players}' for the server's max player count\n    # Use '{status}' to show whether the server is online or offline (the colors can be customized under Status-Format)\n    Server: \"§r{status} §8(§a{current-players}§8/§b{max-players}§8)\"\n\n    # This is the message displayed under each WATERDOG button\n    # Don't worry about this if you're only using the EXTERNAL transfer type\n    WaterDog: \"§r§o§8Tap to transfer\"\n\n    # This is the message displayed under each WORLD button\n    # Use '{current-players}' for the world's current player count\n    World: \"§r§o§8Tap to teleport §8(§a{current-players} §eplayer(s)§8)\"\n```\n\n### Sound settings\n```yaml\n  # Choose what sound (if any) to play when opening the UI\n  UI: \"random.pop\"\n\n  # Choose what sound (if any) to play while transferring SERVERS\n  Transfer: \"mob.blaze.shoot\"\n\n  # Choose what sound (if any) to play while teleporting between WORLDS\n  Teleport: \"random.anvil_use\"\n```\n\n### Titles settings\n```yaml\n  # Set the delay to show the title before transferring/teleporting\n  # This value is in seconds (default is 2 seconds)\n  # Set this to false or 0 for no delay\n  Delay: 2\n\n  # Set the formatting for the title shown to players when transferring SERVERS\n  Transfer: \"§a§oTransferring...\"\n\n  # Set the formatting for the title shown to players when teleporting between WORLDS\n  Teleport: \"§a§oTeleporting...\"\n```\n\n### Entry Listing\nThis is where you list your servers/worlds to be displayed on the server UI\n\nServer format: \"ext:ServerTitle:ServerIP:ServerPort:ImageType:Path/URL\"\n\nWaterDog server format: \"wd:ServerTitle:ServerName:ImageType:Path/URL\"\n\nWorld format: \"int:WorldTitle:WorldAlias:ImageType:Path/URL\"\n\n```yaml\nList:\n - \"ext:§l§6Lobby §eServer:play.xenoservers.net:19132:url:file.xenoservers.net/Resources/GitHub-Resources/navicompass/lobby.png\"\n - \"ext:§l§2Prison §eServer:play.xenoservers.net:19133\"\n - \"wd:§l§3Sky§cBlock §eServer:skyblock:url:file.xenoservers.net/Resources/GitHub-Resources/navicompass/skyblock.png\"\n - \"wd:§l§bFactions §eServer:factions\"\n - \"int:§l§5Creative §eServer:creative:url:file.xenoservers.net/Resources/GitHub-Resources/navicompass/creative.png\"\n - \"int:§l§cKitPvP §eServer:kitpvp\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxenophilicy%2Fnavicompass","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxenophilicy%2Fnavicompass","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxenophilicy%2Fnavicompass/lists"}