HuskHomes

HuskHomes is a teleportation plugin for Minecraft: Java Edition (Spigot or Fabric) that provides player teleportation features such as homes, warps, and teleport requests.

Key capabilities include:

• Cross-server support: Using MySQL/MariaDB, players can set homes and teleport across a proxy network (BungeeCord or Velocity).
• Built-in commands: Familiar commands like /sethome, /home, /tpa, and /rtp are available out of the box.
• Interactive chat menus: Uses robust chat-based menus instead of traditional chest GUIs.
• Admin tools: Includes /tp and /warp along with management tools for player homes.
• Plugin hooks: Integrates with Plan for analytics and Dynmap/BlueMap for displaying homes on web maps.
• Extensibility: Provides an API for developers to extend functionality.

HuskHomes provides a wide range of home and warp management features, including:

• Command Management: Core commands for users and admins.
• Hooks: Support for Plan, Map, and Economy hooks.
• Security: Strict TP-after-teleport (Tpahere) and Restricted Warps.
• User Experience: Back command, Cooldowns, Global Spawn, and Global Respawning.

HuskHomes provides a comprehensive suite of teleportation and management tools. Key features include:

• Commands: A full set of commands for managing homes, warps, and teleports.
• Hooks: Integration with Plan, Map, and Economy plugins.
• Teleportation Controls: Features like Strict Tpahere, Back Command, Cooldowns, and Global Respawning.
• World Management: Global Spawn and Restricted Warps to control player movement across different worlds.

You can override the default home limits set in the plugin configuration by using specific permission nodes. If a user has multiple nodes, HuskHomes uses the highest value.

To make these limits stack instead of taking the highest value, set stack_permission_limits: true under the general section in the plugin config.

Available Nodes:

• huskhomes.max_homes.<amount>: Sets the maximum total number of homes a user can have.
• huskhomes.free_homes.<amount>: Sets the number of homes a user can set for free before economy checks apply (requires an economy hook).
• huskhomes.max_public_homes.<amount>: Sets the maximum number of homes a user can set to public.

# Example permission nodes:
huskhomes.max_homes.10
huskhomes.free_homes.3
huskhomes.max_public_homes.2

When global_respawning is enabled, HuskHomes manages player spawn points across the network using the following lifecycle:

1. Setting the Spawn: When a player interacts with a bed or respawn anchor, HuskHomes updates that player's global respawn position to match the coordinates on the current server.
2. Player Death: Upon death, the player is sent to the specific server where their global spawn was last set using a special RESPAWN teleport type.
3. Arrival: Once the player arrives at the target respawn server, the game completes the teleport to the stored position.

Note on Failures: If the stored respawn position is missing or obstructed on the target server, the player will be moved to that server's default world spawn instead.

All HuskHomes commands are registered with a fallback namespace. If a command is being intercepted by another plugin (like EssentialsX), you can bypass the conflict by prefixing the command with huskhomes:.

For example, instead of using /home, you can use /huskhomes:home to ensure the HuskHomes version of the command is executed.

Many HuskHomesAPI methods return CompletableFuture objects to prevent database queries from blocking the main server thread. Use #thenAccept() to process the result once the future completes.

Warning: Never call #join() on futures returned by the HuskHomesAPI. Since these are processed on asynchronous server tasks, calling #join() can lead to thread deadlocks and crash your server.

To enable Cross-Server Random Teleport (RTP), ensure the following three conditions are met:

1. Set rtp.cross-server to true in the configuration.
2. Use Redis as your messenger_type.
3. Ensure the server names listed in rtp.random_target_servers exactly match the names defined in your server.yml and your Proxy configuration.

HuskHomes supports several database types depending on whether you need local storage or cross-server synchronization.

Warning: There is no automatic migration between database types. Changing the type in your configuration will result in data loss.

Developers can extend HuskHomes using its public API. The documentation provides specific guidance on:

• API Usage: How to interact with the plugin's core logic.
• API Examples: Concrete code snippets for common tasks.
• API Events: A list of events that developers can listen to for custom logic.

To use the HuskHomes API in a Maven project, add the william278.net repository and the platform-specific dependency to your pom.xml.

Note: Replace VERSION with the latest HuskHomes version (e.g., 4.11). For Fabric platforms, you must append the Minecraft version to the version string (e.g., 4.11+1.20.1).

Use the provided scope as the API is expected to be present at runtime via the HuskHomes plugin.

<repositories>
    <repository>
        <id>william278.net</id>
        <url>https://repo.william278.net/releases</url>
    </repository>
</repositories>

<dependency>
    <groupId>net.william278.huskhomes</groupId>
    <artifactId>huskhomes-PLATFORM</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
</dependency>