Skip to main content

Installation

Requirementsโ€‹

RequirementVersion
Minecraft ServerPaper or Spigot 1.20+
Java17 or higher
Advanced TeleportRequired (soft dependency โ€” loads without it, but non-functional)

Installation Stepsโ€‹

1. Ensure Advanced Teleport Is Installedโ€‹

This addon is a companion to Advanced Teleport. Install and configure AT first.

2. Download the Addonโ€‹

Obtain AdvancedTeleportAddon.jar from the releases page.

3. Place the JARโ€‹

server/
โ””โ”€โ”€ plugins/
โ”œโ”€โ”€ AdvancedTeleport.jar โ† must already be here
โ””โ”€โ”€ AdvancedTeleportAddon.jar โ† place here

4. Start the Serverโ€‹

Config is generated on first run:

plugins/
โ””โ”€โ”€ HomesGUI-Addon/
โ”œโ”€โ”€ config.yml
โ””โ”€โ”€ home-icons.yml โ† stores per-player custom icons

5. Verifyโ€‹

Console output:

[HomesGUI-Addon] Advanced Teleport detected โ€” hooking in!
[HomesGUI-Addon] Plugin enabled!

If you see a warning about Advanced Teleport not found, double-check that AdvancedTeleport.jar is in plugins/ and fully loaded.

File Layoutโ€‹

FilePurpose
config.ymlGUI layout, display options, command aliases
home-icons.ymlPer-player custom home icons (auto-managed)

Updatingโ€‹

  1. Stop the server
  2. Replace the addon JAR
  3. Start the server โ€” both config files are preserved

Uninstallingโ€‹

  1. Stop the server
  2. Remove AdvancedTeleportAddon.jar from plugins/
  3. Optionally delete plugins/HomesGUI-Addon/ to remove config and icon data