HuskHomes

https://william278.net/docs/huskhomes/
Admin
HuskHomes is a powerful and intuitive homes, warps, and teleportation suite plugin for Minecraft...
Tokens:14,511
Snippets:202
Trust Score:7.4
Update:6 months ago
Show doc for...
Tokens:
Raw
### Fabric Callbacks for Events

Source: https://william278.net/docs/huskhomes/api-events

Example of how to register a callback for the HomeCreateEvent on Fabric.

```JAVA
import net.fabricmc.fabric.api.event.player.PlayerBlockBreakEvents;
import net.minecraft.util.ActionResult;

// ... other imports

public class ExampleMod implements ModInitializer {

    @Override
    public void onInitialize() {
        // Example for HomeCreateEvent (assuming HomeCreateCallback exists and is registered)
        // HuskHomes and Fabric callbacks
        // HomeCreateCallback.EVENT.register((player, home) -> {
        //     // Do something with the player and home
        //     System.out.println("Home created by " + player.getName());
        //     return ActionResult.SUCCESS; // Return an appropriate ActionResult
        // });
    }
}
```

--------------------------------

### Get HuskHomes API Instance

Source: https://william278.net/docs/huskhomes/api-examples

Obtain an instance of the HuskHomesAPI by calling the static `getInstance()` method. This instance is used to access all API functionalities.

```java
import net.william278.huskhomes.api.HuskHomesAPI;

public class HuskHomesAPIHook {

    private final HuskHomesAPI huskHomesAPI;

    public HuskHomesAPIHook() {
        this.huskHomesAPI = HuskHomesAPI.getInstance();
    }

}
```

--------------------------------

### Create HuskHomes API Hook Class

Source: https://william278.net/docs/huskhomes/api-examples

Create a dedicated class to interface with the HuskHomes API. Avoid placing API calls in your main plugin class to prevent ClassNotFoundExceptions if HuskHomes is not installed.

```java
public class HuskHomesAPIHook {

    public HuskHomesAPIHook() {
        // Ready to do stuff with the API
    }

}
```

--------------------------------

### Get an OnlineUser by UUID

Source: https://william278.net/docs/huskhomes/api-examples

Retrieve an OnlineUser object for a player currently online using their UUID. This method uses `adaptUser` for Bukkit players and `getOnlineUser` for an Optional result.

```java
public class HuskHomesAPIHook {

    private final HuskHomesAPI huskHomesAPI;

    // This method prints out a player's homes into console using stdout
    public void getAnOnlineUser(UUID uuid) {
        OnlineUser user = huskHomesAPI.adaptUser(Bukkit.getPlayer(uuid));
        System.out.println("Found " + user.getUsername() + "!");
        Optional<OnlineUser> otherMethod = huskHomesAPI.getOnlineUser(uuid);
    }

}
```

--------------------------------

### Create a new player home

Source: https://william278.net/docs/huskhomes/api-examples

Shows how to create a home at a player's current position. Must handle ValidationException to catch issues like home limits or invalid metadata.

```java
public class HuskHomesAPIHook {

    private final HuskHomesAPI huskHomesAPI;

    // This method creates a home with the name "example" at the player's current location
    public void createHome(Player owner) {
        // Use this to adapt an online player to an OnlineUser, which extends User (accepted by createHome).
        OnlineUser onlineUser = huskHomesAPI.adaptUser(player);
        
        // We can get an OnlineUser's Position with #getPosition, which we can pass here to createHome
        try {
            huskHomesAPI.createHome(onlineUser, "example", onlineUser.getPosition());
        } catch (ValidationException e) {
            // Homes will be validated, and if validation fails a ValidationException will be thrown.
            // This can happen if the user has too many homes, or if its metadata is invalid (name, description, etc)
            // You should catch ValidationExceptions, determine what caused it (#getType) and handle it appropriately.
            owner.sendMessage(ChatColor.RED + "Failed to create example home: " + e.getType());
        }
    }
}
```

--------------------------------

### Configure Back Command Settings

Source: https://william278.net/docs/huskhomes/back-command

Full configuration block for the /back command, including death return, teleport event tracking, and restricted worlds.

```yaml
# Settings for the /back command
back_command:
  # Whether /back should work to teleport the user to where they died
  return_by_death: true
  # Whether /back should work with other plugins that use the PlayerTeleportEvent (can conflict)
  save_on_teleport_event: false
  # List of world names where the /back command cannot RETURN the player to.
  # A user's last position won't be updated if they die or teleport from these worlds, but they still will be able to use the command while IN the world
  restricted_worlds: []

```

--------------------------------

### Build and execute an instant teleport

Source: https://william278.net/docs/huskhomes/api-examples

Constructs a teleport to a specific coordinate and executes it immediately using buildAndComplete.

```java
public class HuskHomesAPIHook {

    private final HuskHomesAPI huskHomesAPI;

    // This teleports a player to 128, 64, 128 on the server "server"
    public void teleportPlayer(Player player) {
        OnlineUser onlineUser = huskHomesAPI.adaptUser(player);

        // The TeleportBuilder accepts a class that extends Target. This can be a Username or a Position (or a Home/Warp, which extends Position)
        // * Note that the World object needs the name and UID of the world.
        // * The UID will be used if the world can't be found by name. You can just pass it a random UUID if you don't have it.
        Position position = Position.at(
            128, 64, 128,
            World.from("world", UUID.randomUUID()), "server"
        );

        // To construct a teleport, get a TeleportBuilder with #teleportBuilder
        huskHomesAPI.teleportBuilder()
            .teleporter(onlineUser) // The person being teleported
            .target(position) // The target position
            .buildAndComplete(false); // This builds and executes the teleport instantly.
        
        // The `true` flag we passed above indicates we want an instant teleport (as opposed to a timed teleport)
    }

}
```

--------------------------------

### Retrieve and print player homes

Source: https://william278.net/docs/huskhomes/api-examples

Demonstrates fetching a list of homes or a specific home for a user asynchronously. Requires an OnlineUser or User object and handles results via CompletableFuture.

```java
public class HuskHomesAPIHook {

    private final HuskHomesAPI huskHomesAPI;

    // This method prints out a player's homes into console using stdout
    public void printPlayerHomes(UUID uuid) {
        // Use this to adapt an online player to an OnlineUser, which extends User (accepted by getUserHomes).
        // To get the homes of an offline user, use: User.of(uuid, username);
        OnlineUser user = huskHomesAPI.adaptUser(Bukkit.getPlayer(uuid));
        
        // A lot of HuskHomes' API methods return as futures which execute asynchronously.
        huskHomesAPI.getUserHomes(user).thenAccept(homeList -> { // Use #thenAccept(data) to run after the future has executed with data
            for (Home home : homeList) {
                // The home and warp object both extend SavedPosition, which maps a position object to a name and description
                System.out.println(home.meta.name); // It's best to use your plugin logger, but this is just an example.
            }
        });
        
        // You can also get a specific home by name using #getUserHome(user, name)
        huskHomesAPI.getUserHome(user, "example").thenAccept(optionalHome -> {
            // #getUserHome returns an Optional wrapper, so we need to run #ifPresent() first and call #get() to retrieve it if it exists
            if (optionalHome.isPresent()) {
                System.out.println("Found " + user.getUsername() + "'s home: " + optionalHome.get().getName());
            } else {
                System.out.println("Home not found");
            }
        });
    }

}
```

--------------------------------

### Plugin Management

Source: https://william278.net/docs/huskhomes/Commands

Administrative commands for managing the HuskHomes plugin state and data.

```APIDOC
## GET /huskhomes

### Description
Base command for plugin management, including status, updates, and data maintenance.

### Method
GET

### Endpoint
/huskhomes [action] [parameters]

### Parameters
#### Path Parameters
- **action** (string) - Optional - Actions include: about, help, update, reload, homeslots, import, delete, status, dump.
```

--------------------------------

### Configure Redis in config.yml

Source: https://william278.net/docs/huskhomes/redis

Set the broker_type to REDIS and provide connection details including host, port, and optional sentinel settings.

```yaml
# Type of network message broker to ues for cross-server networking (PLUGIN_MESSAGE or REDIS)
broker_type: REDIS
# Settings for if you're using REDIS as your message broker
redis:
  host: localhost
  port: 6379
  # Password for your Redis server. Leave blank if you're not using a password.
  password: ''
  use_ssl: false
  # Settings for if you're using Redis Sentinels.
  # If you're not sure what this is, please ignore this section.
  sentinel:
    master_name: ''
    # List of host:port pairs
    nodes: []
    password: ''
```

--------------------------------

### Register a Fabric HomeCreateCallback

Source: https://william278.net/docs/huskhomes/api-events

Register a callback to handle logic when a player creates a home in the Fabric environment.

```java
HomeCreateCallback.EVENT.register((player, home) -> {
    // Do something with the player and home
    return ActionResult.SUCCESS; // Return an appropriate ActionResult
});
```

--------------------------------

### Gradle Repository Configuration

Source: https://william278.net/docs/huskhomes/api

Add this repository to your build.gradle for all projects to access HuskHomes API releases. For development builds, use '/snapshots'.

```gradle
allprojects {
    repositories {
        maven { url 'https://repo.william278.net/releases' }
    }
}
```

--------------------------------

### Configure Cooldowns in config.yml

Source: https://william278.net/docs/huskhomes/cooldowns

Define cooldown times for specific actions in seconds. Ensure `enabled` is set to `true` to activate cooldowns. Players with `huskhomes.bypass_cooldowns` permission will not be affected.

```yaml
# Action cooldown settings. Docs: https://william278.net/docs/huskhomes/cooldowns
cooldowns:
  # Whether to apply a cooldown between performing certain actions
  enabled: true
  # Map of cooldown times to actions
  cooldown_times:
    RANDOM_TELEPORT: 600

```

--------------------------------

### Plugin Management Commands

Source: https://william278.net/docs/huskhomes/commands

Administrative commands for managing the HuskHomes plugin state and data.

```APIDOC
## GET /huskhomes

### Description
Base command for plugin management.

### Method
GET

### Endpoint
/huskhomes

## GET /huskhomes/about

### Description
View the plugin about menu.

### Method
GET

### Endpoint
/huskhomes about

## POST /huskhomes/reload

### Description
Reload the plugin locales and config file.

### Method
POST

### Endpoint
/huskhomes reload

## DELETE /huskhomes/delete

### Description
Delete player data, homes, or warps from the system database.

### Method
DELETE

### Endpoint
/huskhomes delete [player|homes|warps] [target] [confirm]
```

--------------------------------

### Build and execute a timed teleport

Source: https://william278.net/docs/huskhomes/api-examples

Creates a teleport that requires the user to remain stationary, handling potential TeleportationException errors.

```java
public class HuskHomesAPIHook {

    private final HuskHomesAPI huskHomesAPI;

    // This performs a timed teleport to tp a player to another online player with the username "William278"
    public void teleportPlayer(Player player) {
        OnlineUser onlineUser = huskHomesAPI.adaptUser(player);
        Target targetUsername = Target.username("William278"); // Get a target by a username, who can be online on this server/a server on the network (cross-server teleport).

        try {
            huskHomesAPI.teleportBuilder()
                .teleporter(onlineUser)
                .target(targetUsername)
                .toTimedTeleport() // Instead of running buildAndComplete, we can get the Teleport object itself this way.
                .execute(); // A timed teleport will throw a TeleportationException if the player moves/takes damage during the warmup, or if the target is not found.
        } catch(TeleportationException e) { // Since this doesn't catch the TeleportException (buildAndComplete does!), we need to do this.
            // Use TeleportException#displayMessage() to display why the teleport failed to the user.
            e.displayMessage(onlineUser);
        }
    }

}
```

--------------------------------

### Maven Repository Configuration

Source: https://william278.net/docs/huskhomes/api

Add this repository to your pom.xml to access HuskHomes API releases. For development builds, use '/snapshots'.

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

--------------------------------

### Configure HuskHomes Aliases in commands.yml

Source: https://william278.net/docs/huskhomes/command-conflicts

Define aliases in your Spigot commands.yml to ensure HuskHomes commands take priority over other plugins.

```yaml
aliases:
  home:
    - "huskhomes:home $1-"
  sethome:
    - "huskhomes:sethome $1-"
  homelist:
    - "huskhomes:homelist $1-"
  homes:
    - "huskhomes:homelist $1-"
  delhome:
    - "huskhomes:delhome $1-"
  edithome:
    - "huskhomes:edithome $1-"
  phome:
    - "huskhomes:phome $1-"
  phomelist:
    - "huskhomes:phomelist $1-"
  warp:
    - "huskhomes:warp $1-"
  setwarp:
    - "huskhomes:setwarp $1-"
  warplist:
    - "huskhomes:warplist $1-"
  delwarp:
    - "huskhomes:delwarp $1-"
  editwarp:
    - "huskhomes:editwarp $1-"
  tp:
    - "huskhomes:tp $1-"
  tphere:
    - "huskhomes:tphere $1-"
  tpa:
    - "huskhomes:tpa $1-"
  tpahere:
    - "huskhomes:tpahere $1-"
  tpaccept:
    - "huskhomes:tpaccept $1-"
  tpyes:
    - "huskhomes:tpaccept $1-"
  tpdecline:
    - "huskhomes:tpdecline $1-"
  tpno:
    - "huskhomes:tpdecline $1-"
  rtp:
    - "huskhomes:rtp $1-"
  tpignore:
    - "huskhomes:tpignore $1-"
  tpoffline:
    - "huskhomes:tpoffline $1-"
  tpall:
    - "huskhomes:tpall $1-"
  tpaall:
    - "huskhomes:tpaall $1-"
  spawn:
    - "huskhomes:spawn $1-"
  setspawn:
    - "huskhomes:setspawn $1-"
  back:
    - "huskhomes:back $1-"
  huskhomes:
    - "huskhomes:huskhomes $1-"
```

--------------------------------

### HuskHomes config.yml configuration

Source: https://william278.net/docs/huskhomes/config-files

The primary configuration file for defining language, database type, and connection pool settings.

```yaml
# ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
# ┃       HuskHomes Config       ┃
# ┃    Developed by William278   ┃
# ┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
# ┣╸ Information: https://william278.net/project/huskhomes/
# ┣╸ Config Help: https://william278.net/docs/huskhomes/config-files/
# ┗╸ Documentation: https://william278.net/docs/huskhomes/

# Locale of the default language file to use. Docs: https://william278.net/docs/huskhomes/translations
language: en-gb
# Whether to automatically check for plugin updates on startup
check_for_updates: true
# Database settings
database:
  # Type of database to use (SQLITE, H2, MYSQL, MARIADB, or POSTGRESQL)
  type: SQLITE
  # Specify credentials here if you are using MYSQL, MARIADB, or POSTGRESQL
  credentials:
    host: localhost
    port: 3306
    database: huskhomes
    username: root
    password: pa55w0rd
    parameters: ?autoReconnect=true&useSSL=false&useUnicode=true&characterEncoding=UTF-8
  # MYSQL / MARIADB / POSTGRESQL database Hikari connection pool properties
  # Don't modify this unless you know what you're doing!
  pool_options:
    size: 12
    idle: 12
    lifetime: 1800000
    keep_alive: 30000
    timeout: 20000
  # Names of tables to use on your database. Don't modify this unless you know what you're doing!
  table_names:
    PLAYER_DATA: huskhomes_users
    PLAYER_COOLDOWNS_DATA: huskhomes_user_cooldowns
    POSITION_DATA: huskhomes_position_data
    SAVED_POSITION_DATA: huskhomes_saved_positions
    HOME_DATA: huskhomes_homes
    WARP_DATA: huskhomes_warps
    TELEPORT_DATA: huskhomes_teleports
```

--------------------------------

### Check for HuskHomes and Instantiate Hook

Source: https://william278.net/docs/huskhomes/api-examples

Ensure the HuskHomes plugin is present on the server before creating an instance of your API hook class. This prevents errors if the plugin is missing.

```java
public class MyPlugin extends JavaPlugin {

    public HuskHomesAPIHook huskHomesHook;

    @Override
    public void onEnable() {
        if (Bukkit.getPluginManager().getPlugin("HuskHomes") != null) {
            this.huskHomesHook = new HuskHomesAPIHook();
        }
    }
}
```

--------------------------------

### Configure Teleport Event Integration

Source: https://william278.net/docs/huskhomes/back-command

Configuration snippet to toggle tracking of teleport events from other plugins.

```yaml
back_command:
  # Whether /back should work with other plugins that use the PlayerTeleportEvent (can conflict)
  save_on_teleport_event: false

```

--------------------------------

### Teleport Warmup Time Permissions

Source: https://william278.net/docs/huskhomes/Commands

Customize teleport warmup times using permission nodes. The highest value present will always be used, regardless of the `stack_permission_limits` setting.

```plaintext
huskhomes.teleport_warmup.<seconds> — Determines how long this player has to wait before teleporting.
```

--------------------------------

### HuskHomes Placeholders

Source: https://william278.net/docs/huskhomes/placeholders

HuskHomes (v4.0.5+) provides a set of placeholders that can be registered and used with PlaceholderAPI (on Spigot/Paper) or Fabric PlaceholderAPI (on Fabric). These placeholders are replaced with their corresponding values when used in-game.

```APIDOC
## HuskHomes Placeholders API

### Description
HuskHomes provides several placeholders that can be used with PlaceholderAPI or Fabric PlaceholderAPI to display dynamic information about user homes.

### Placeholders

| Placeholder | Description | Example Value |
|---|---|---|
| `%huskhomes_homes_count%` | The number of homes this user has set | 3 |
| `%huskhomes_max_homes%` | The maximum number of homes this user can set | 10 |
| `%huskhomes_max_public_homes%` | The number of homes this user can make public | 5 |
| `%huskhomes_free_home_slots%` | The number of homes this user can make for free† | 5 |
| `%huskhomes_home_slots%` | The number of additional home slots this user has purchased† | 2 |
| `%huskhomes_homes_list%` | A comma-separated list of this user's homes | home, castle, tower |
| `%huskhomes_public_homes_count%` | The number of homes this user has set to public | 3 |
| `%huskhomes_public_homes_list%` | A comma-separated list of this user's public homes | castle, tower |
| `%huskhomes_ignoring_tp_requests%` | Whether this user is ignoring teleport requests | true |

†Only effective on servers that make use of the [[Economy Hook]].
```

--------------------------------

### Define economy costs in config.yml

Source: https://william278.net/docs/huskhomes/economy-hook

Configure the economy settings and action costs within the economy section of the configuration file. Ensure monetary values are provided as decimals.

```yaml
# Economy settings. Docs: https://william278.net/docs/huskhomes/economy-hook
economy:
  # Enable economy plugin integration (requires Vault and a compatible Economy plugin)
  enabled: true
  # Map of economy actions to costs.
  economy_costs:
    ADDITIONAL_HOME_SLOT: 100.0
    MAKE_HOME_PUBLIC: 50.0
    RANDOM_TELEPORT: 25.0
```

--------------------------------

### Enable Return by Death

Source: https://william278.net/docs/huskhomes/back-command

Configuration snippet to enable returning to the location of the last death.

```yaml
back_command:
  # Whether /back should work to teleport the user to where they died
  return_by_death: true

```

--------------------------------

### Configure database settings in config.yml

Source: https://william278.net/docs/huskhomes/database

Modify the database type and connection credentials within the config.yml file. Ensure the type matches your chosen database backend and provide valid credentials for server-based options.

```yaml
database:
  # Type of database to use (SQLITE, H2, MYSQL or MARIADB)
  type: SQLITE
  mysql:
    credentials:
      # Specify credentials here if you are using MYSQL, MARIADB, or POSTGRESQL as your database type
      host: localhost
      port: 3306
      database: HuskHomes
      username: root
      password: pa55w0rd
      parameters: ?autoReconnect=true&useSSL=false&useUnicode=true&characterEncoding=UTF-8
    connection_pool:
      # MYSQL / MARIADB / POSTGRESQL database Hikari connection pool properties. Don't modify this unless you know what you're doing!
      size: 12
      idle: 12
      lifetime: 1800000
      keepalive: 30000
      timeout: 20000
```

--------------------------------

### Restrict Worlds for Back Command

Source: https://william278.net/docs/huskhomes/back-command

Configuration snippet to define worlds where the /back command cannot return players to.

```yaml
back_command:
  # List of world names where the /back command cannot RETURN the player to.
  # A user's last position won't be updated if they die or teleport from these worlds, but they still will be able to use the command while IN the world
  restricted_worlds: []

```

--------------------------------

### Gradle Dependency Configuration

Source: https://william278.net/docs/huskhomes/api

Add this dependency to your build.gradle. Replace VERSION with the latest HuskHomes version (e.g., '3.6.1+1.20.1').

```gradle
dependencies {
    compileOnly 'net.william278.huskhomes:huskhomes-PLATFORM:VERSION'
}
```

--------------------------------

### Home Limit Permissions

Source: https://william278.net/docs/huskhomes/Commands

Manage the maximum number of homes, free homes, and public homes a user can set using specific permission nodes. These nodes override the general settings in `config.yml`.

```plaintext
huskhomes.max_homes.<amount> — Determines the max number of homes a user can set
huskhomes.free_homes.<amount> — Determines the allotment of homes the user can set for free, before they have to pay†
huskhomes.max_public_homes.<amount> — Determines the maximum number of homes a user can make public
```

--------------------------------

### Enable Permission Restricted Warps

Source: https://william278.net/docs/huskhomes/restricted-warps

Set `permission_restrict_warps` to `true` in `config.yml` to enable this feature. Players will then need the `huskhomes.warp.<warp_name>` permission to use warps.

```yaml
  # Whether users require a permission (huskhomes.warp.<warp_name>) to use warps
  permission_restrict_warps: false
```

--------------------------------

### Maven Dependency Configuration

Source: https://william278.net/docs/huskhomes/api

Include this dependency in your pom.xml. Replace VERSION with the latest HuskHomes version (e.g., '3.6.1+1.20.1').

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

--------------------------------

### Command Aliases

Source: https://william278.net/docs/huskhomes/commands

Convenient aliases are available for several HuskHomes commands. These provide shorter or alternative ways to execute common actions.

```plaintext
Command| Aliases  
---|---
/homelist| /homes  
/phome| /publichome  
/phomelist| /phomes, /publichomelist  
/warplist| /warps  
/tp| /tpo  
/tpaccept| /tpyes  
/tpdecline| /tpno, /tpdeny
```

--------------------------------

### Teleportation Commands

Source: https://william278.net/docs/huskhomes/Commands

Commands for managing teleport requests and random teleportation.

```APIDOC
## POST /tpdecline

### Description
Decline a teleport request from a specific user.

### Method
POST

### Endpoint
/tpdecline [username]

### Parameters
#### Path Parameters
- **username** (string) - Required - The username of the player whose request is being declined.

## POST /tpignore

### Description
Toggle whether to ignore incoming teleport requests.

### Method
POST

### Endpoint
/tpignore

## GET /rtp

### Description
Teleport randomly into the wild in the current world or specified locations.

### Method
GET

### Endpoint
/rtp [player] [world] [server]

### Parameters
#### Path Parameters
- **player** (string) - Optional - The player to teleport.
- **world** (string) - Optional - The target world.
- **server** (string) - Optional - The target server.
```

--------------------------------

### Plugin Dependency in plugin.yml

Source: https://william278.net/docs/huskhomes/api

Configure your plugin.yml to declare HuskHomes as a soft or hard dependency. Use 'depend' if your plugin requires HuskHomes to be present.

```yaml
name: MyPlugin
version: 1.0
main: net.william278.myplugin.MyPlugin
author: William278
description: 'A plugin that hooks with the HuskHomes API!'
softdepend: # Or, use 'depend' here
  - HuskHomes
```

--------------------------------

### HuskHomes API Events

Source: https://william278.net/docs/huskhomes/api-events

List of cancellable and non-cancellable events provided by HuskHomes.

```APIDOC
## HuskHomes API Events

### Description
HuskHomes provides a number of API events that plugins can listen to when certain actions are performed. Most of these events are cancellable, allowing plugins to prevent them from executing.

### Event List

| Bukkit Event class             | Since   | Cancellable | Description                                                                                                |
|--------------------------------|---------|-------------|------------------------------------------------------------------------------------------------------------|
| `HomeCreateEvent`              | 4.0     | ✅          | Called when a player sets a home.                                                                            |
| `HomeListEvent`                | 3.0     | ✅          | Called when a player requests to view a list of homes / public homes.                                        |
| `HomeEditEvent`                | 4.0     | ✅          | Called when a player edits a home (privacy, relocate, description, name).                                  |
| `HomeDeleteEvent`              | 3.0     | ✅          | Called when a player deletes a home.                                                                         |
| `DeleteAllHomesEvent`          | 3.2.1   | ✅          | Called when a player uses `/delhome all` to delete all their homes.                                        |
| `WarpCreateEvent`              | 4.0     | ✅          | Called when a player sets a warp.                                                                            |
| `WarpListEvent`                | 3.0     | ✅          | Called when a player requests to view a list of warps.                                                       |
| `WarpEditEvent`                | 4.0     | ✅          | Called when a player edits a warp (relocate, description, name).                                             |
| `WarpDeleteEvent`              | 3.0     | ✅          | Called when a player deletes a warp.                                                                         |
| `DeleteAllWarpsEvent`          | 3.2.1   | ✅          | Called when a player uses `/delwarp all` to delete all warps.                                                |
| `SendTeleportRequestEvent`     | 4.1     | ✅          | Called when a player sends a teleport request (`/tpa`).                                                      |
| `ReceiveTeleportRequestEvent`  | 4.1     | ✅          | Called when a player receives a teleport request from someone.                                               |
| `ReplyTeleportRequestEvent`    | 4.1     | ✅          | Called when a player accepts or declines a teleport request.                                                 |
| `TeleportWarmupEvent`          | 3.0     | ✅          | Called when a player starts a teleport warmup countdown.                                                     |
| `TeleportWarmupCancelledEvent` | 4.6.3   | ❌          | Called when a player cancels the teleport warmup.                                                            |
| `TeleportEvent`                | 3.0     | ✅          | Called when a player is teleported.                                                                          |
| `TeleportBackEvent`            | 4.1     | ✅          | Called when a player teleports to their last position (`/back`).                                             |
| `RandomTeleportEvent`          | 4.8     | ✅          | Called when a player is randomly teleported.                                                               |

**Notes:**
- If a player uses `/delhome all` or `/delwarp all`, a single `DeleteAllHomesEvent` or `DeleteAllWarpsEvent` is fired, respectively.
- `TeleportEvent` and `TeleportBackEvent` are called on the server the player is teleported *from*.
```

--------------------------------

### Back Teleportation

Source: https://william278.net/docs/huskhomes/Commands

Commands to return to previous locations or death points.

```APIDOC
## GET /back

### Description
Teleport to your last position, previous teleport location, or last death location.

### Method
GET

### Endpoint
/back
```

--------------------------------

### Disable EssentialsX Commands

Source: https://william278.net/docs/huskhomes/command-conflicts

Add these commands to the disabled-commands section of your Essentials/config.yml to prevent conflicts.

```yaml
# Disabling commands here will prevent Essentials handling the command, this will not affect command conflicts.
# You should not have to disable commands used in other plugins, they will automatically get priority.
# See https://bukkit.fandom.com/wiki/Commands.yml#aliases to map commands to other plugins.
disabled-commands:
  - home
  - homes
  - sethome
  - homelist
  - delhome
  - warp
  - setwarp
  - createwarp 
  - warplist
  - delwarp
  - tp
  - tphere
  - tpa
  - tpahere
  - tpaccept
  - tpdeny
  - tpno
  - rtp
  - tpignore
  - tpoffline
  - tpall
  - tpaall
  - spawn
  - setspawn
  - back
```

--------------------------------

### Clear Redis Default User Password

Source: https://william278.net/docs/huskhomes/redis

Commands to run in redis-cli to set or clear the default user password.

```text
requirepass thepassword
user default on nopass ~* &* +@all
```

--------------------------------

### Disable Commands in config.yml

Source: https://william278.net/docs/huskhomes/Commands

To disable commands, add them to the `disabled_commands` list in your config.yml file. This prevents the commands from being registered by the plugin.

```yaml
# Disabled commands (e.g. ['/home', '/warp'] to disable /home and /warp)
disabled_commands: [ '/rtp' ]
```
Tokens:
Raw