MCPcopy Index your code
hub / github.com/WiIIiam278/HuskHomes

github.com/WiIIiam278/HuskHomes @4.10

Chat with this repo
repository ↗ · DeepWiki ↗ · release 4.10 ↗ · + Follow
1,882 symbols 6,922 edges 205 files 407 documented · 22%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
<img src="https://github.com/WiIIiam278/HuskHomes/raw/4.10/images/banner.png" alt="HuskHomes" />
<a href="https://github.com/WiIIiam278/HuskHomes/actions/workflows/ci.yml">
    <img src="https://img.shields.io/github/actions/workflow/status/WiIIiam278/HuskHomes/ci.yml?branch=master&logo=github"/>
</a> 
<a href="https://repo.william278.net/#/releases/net/william278/huskhomes/">
    <img src="https://repo.william278.net/api/badge/latest/releases/net/william278/huskhomes/huskhomes-common?color=00fb9a&name=Maven&prefix=v" />
</a> 
<a href="https://discord.gg/tVYhJfyDWG">
    <img src="https://img.shields.io/discord/818135932103557162.svg?label=&logo=discord&logoColor=fff&color=7389D8&labelColor=6A7EC2" />
</a>



<b>
    <a href="https://modrinth.com/plugin/huskhomes">Modrinth</a>
</b> —
<b>
    <a href="https://william278.net/docs/huskhomes/setup">Setup</a>
</b> — 
<b>
    <a href="https://william278.net/docs/huskhomes/">Docs</a>
</b> — 
<b>
    <a href="https://github.com/WiIIiam278/HuskHomes/issues">Issues</a>
</b>

HuskHomes is a powerful, intuitive and flexible teleportation plugin for Minecraft: Java Edition servers. HuskHomes contains a meaty—but not bloated—set of player teleportation features, including set homes, warps, public homes, teleport requests, previous and offline position teleporting—and more.

HuskHomes can be used on your Spigot or Fabric server, and with a MySQL Database even works cross-server, letting players teleport across your proxy (Bungee or Velocity) network!

Features

⭐ Works cross-server — Let players seamlessly teleport and set homes across your proxies network of servers using MySQL/MariaDB.

⭐ Zero learning curve — Your players already know how to use it! /sethome, /home, /tpa, /rtp—among others—are all built-in and easy-to-use.

⭐ Quick and beautiful menus — Sometimes, simple is better. No monolithic chest GUIs—instead, robust and beautiful interactive chat menus.

⭐ Great admin features — Comes with all the classic admin commands—/tp and /warp—as well as robust tools for managing other players' homes.

⭐ Plan & Web map plugin hooks — Stay in touch with your community through home analytics via Plan and display homes on Dynmap or BlueMap.

⭐ Extensible API & open-source — Still not enough? Extend the plugin with the HuskHomes API. Or, submit a pull request—we're open-source!

Development

To build HuskHomes, simply run the following in the root of the repository (building requires Java 21):

./gradlew clean build

License

HuskHomes is licensed under the Apache 2.0 license.

Translations

Translations of the plugin locales are welcome to help make the plugin more accessible. Please submit a pull request with your translations as a .yml file.

Links


© William278, 2025. Licensed under the Apache-2.0 License.

Extension points exported contracts — how you extend this code

Cancellable (Interface)
Base interface for a cancellable event. [32 implementers]
common/src/main/java/net/william278/huskhomes/event/Cancellable.java
BukkitTask (Interface)
(no doc) [3 implementers]
bukkit/src/main/java/net/william278/huskhomes/util/BukkitTask.java
FabricTask (Interface)
(no doc) [3 implementers]
fabric/src/main/java/net/william278/huskhomes/util/FabricTask.java
IDeleteAllWarpsEvent (Interface)
Representation of an event that fires when all warps are deleted. [5 implementers]
common/src/main/java/net/william278/huskhomes/event/IDeleteAllWarpsEvent.java
BukkitUserProvider (Interface)
(no doc) [1 implementers]
bukkit/src/main/java/net/william278/huskhomes/user/BukkitUserProvider.java
FabricUserProvider (Interface)
(no doc) [1 implementers]
fabric/src/main/java/net/william278/huskhomes/user/FabricUserProvider.java
UserListTabCompletable (Interface)
(no doc) [6 implementers]
common/src/main/java/net/william278/huskhomes/command/UserListTabCompletable.java
BukkitHookProvider (Interface)
(no doc) [1 implementers]
bukkit/src/main/java/net/william278/huskhomes/hook/BukkitHookProvider.java

Core symbols most depended-on inside this repo

getString
called by 314
common/src/main/java/net/william278/huskhomes/network/Payload.java
getName
called by 275
common/src/main/java/net/william278/huskhomes/teleport/Teleportable.java
getLocales
called by 230
common/src/main/java/net/william278/huskhomes/config/ConfigProvider.java
toString
called by 215
common/src/main/java/net/william278/huskhomes/position/Position.java
format
called by 211
common/src/main/java/net/william278/huskhomes/database/Database.java
getUuid
called by 209
common/src/main/java/net/william278/huskhomes/position/SavedPosition.java
log
called by 208
common/src/main/java/net/william278/huskhomes/HuskHomes.java
getLocale
called by 191
common/src/main/java/net/william278/huskhomes/config/Locales.java

Shape

Method 1,607
Class 172
Interface 82
Enum 21

Languages

Java100%

Modules by API surface

common/src/main/java/net/william278/huskhomes/database/Database.java57 symbols
common/src/main/java/net/william278/huskhomes/api/BaseHuskHomesAPI.java52 symbols
bukkit/src/test/java/net/william278/huskhomes/BukkitPluginTests.java49 symbols
common/src/main/java/net/william278/huskhomes/database/SqLiteDatabase.java40 symbols
common/src/main/java/net/william278/huskhomes/database/PostgreSqlDatabase.java40 symbols
common/src/main/java/net/william278/huskhomes/database/MySqlDatabase.java40 symbols
common/src/main/java/net/william278/huskhomes/database/H2Database.java39 symbols
bukkit/src/main/java/net/william278/huskhomes/BukkitHuskHomes.java33 symbols
common/src/main/java/net/william278/huskhomes/config/Settings.java30 symbols
fabric/src/main/java/net/william278/huskhomes/FabricHuskHomes.java29 symbols
common/src/main/java/net/william278/huskhomes/user/OnlineUser.java27 symbols
common/src/main/java/net/william278/huskhomes/manager/HomesManager.java24 symbols

For agents

$ claude mcp add HuskHomes \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact