wiiiiam278 / huskhomes

The powerful & intuitive homes, warps, and teleportation suite

Modrinth — Setup — Docs — Issues

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, Sponge 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!

Building

HuskHomes requires Java 17 to build. To build for all platforms, simply run the following in the root of the repository:

./gradlew clean build

License

HuskHomes is licensed under the Apache 2.0 license.

• 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.

• Locales Directory
• English Locales

Links

• Docs — Read the plugin documentation!
• Modrinth — View the plugin Modrinth page (Also: Spigot, Polymart, Hangar, & CurseForge)
• Issues — File a bug report or feature request
• Discord — Get help, ask questions
• bStats — View plugin metrics (Also: Sponge)

---

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

huskhomes's Issues

Permission-restricted warps

Add a new config option restricting warps to permissions (e.g /warp mall requires the huskhomes.warps.mall permission.)

Players are able to request tp's to themselves

Any player with access to the /tpa command is able to do /tpa . This should probably be removed to limit confusion and any issues that could potentially arrive

Double Message when warping from console

Currently throwing two messages when doing a warp from console. The first one shouldn't be fired.

Internal error when trying to teleport to a public home without following the correct format

Occurs when using /phome followed by text that isn't in the format <owner_name>.<home_name>

Add ability to delete all your homes/all warps with /delhome

/delhome all should first try deleting the home all; if it doesn't exist it should prompt the user to enter /delhome all confirm to delete ALL their homes. Same with warps

Add ability for staff to visit and edit players’ homes

Make a command like Essentials' /home : to teleport to players' home

Adding on: This is highly similar to the Phome system, differing from a prefix of the playername. My guess is this would be a "admin" command. Allowing universal teleporting to anyhome. Such a permission would be required (Huskhomes.home.universal?).

Filtering would probably be a nice thing on both the /homes menu and just /home tab filler.
Discussion is welcome

[Add-on] GUI Hex Support

Add Hex Support to the GUI Add-on

BlueMap support

Should support BlueMap like HuskTowns. Shouldn't be considerably difficult to implement.

No confirmation button when doing `/delhome all` or `/delwarp all`

Option to display countdown numbers as titles instead of action bar

If possible, nice how could you add titles to the screen while teleporting?

Original Issue #33 - ReferTV - May 4th, 2021

Button locale not handling color codes (`&`)

Example of items that do not parse colors:

edit_warp_teleport_button: '[Teleport]'
edit_warp_teleport_button_tooltip: Teleport to this warp
edit_warp_delete_button: '[Delete]'
edit_warp_delete_button_tooltip: Delete this warp
edit_warp_relocate_button: '[Relocate]'
edit_warp_relocate_button_tooltip: Update this warp's location
edit_warp_rename_button: '[Rename]'
edit_warp_rename_button_tooltip: Change the name of this warp
edit_warp_description_button: '[Edit Description]'
edit_warp_description_button_tooltip: Update this warp's description
edit_home_teleport_button: '[Teleport]'
edit_home_teleport_button_tooltip: Teleport to your home
edit_home_delete_button: '[Delete]'
edit_home_delete_button_tooltip: Delete your home
edit_home_relocate_button: '[Relocate]'
edit_home_relocate_button_tooltip: Update your home's location
edit_home_rename_button: '[Rename]'
edit_home_rename_button_tooltip: Change the &aname&7 of your home
edit_home_description_button: '[Edit Description]'
edit_home_description_button_tooltip: Update the &adescription&7 of your home
edit_home_make_public_button: '[Make Public]'
edit_home_make_public_button_tooltip: Open your home to the public
edit_home_make_private_button: '[Make Private]'
edit_home_make_private_button_tooltip: Make your home private
home_default_description: '&a%1%''s&7 home'
warp_default_description: A &apublicly&7 accessible warp

Add support for setting custom teleportation sounds

Relocating homes and warps when using mySQL causes them to be deleted

After Renaming a home from "EndermanFarm" to "EndRaiding" i went to change it's location, the Plugin then informed me that the home "does not exists".

After checking the Home list i found the home had vanished from my list. Even after a re log it did not return, The only other change made latter to the other home was to another former home called "End" which i renamed to "EndermanFarm".

Make default home / warp descriptions translatable

Homes and warps have these default descriptions when set currently
PLAYER's home
A publicly accessible warp
This should be made translatable through the language yml

Have HuskHomes track and restrict teleportation to possible target players cross-server and allow them to appear in TAB completion for teleport commands.

Players can do /tpa and still send a tp request (or at least chat displays the "request sent to ...". Probably should have an error if the player isn't online anymore or doesn't actually exist.

/tp x y z world server erroneously checks if the world is not null cross server

If world names differ cross server this will result in the command returning invalid syntax erroneously.
https://github.com/WiIIiam278/HuskHomes2/blob/d2442e4433bdcee968c795baa307cf7a654fa12d/src/main/java/me/william278/huskhomes2/commands/TpCommand.java#L74

Move SQL operations off the main thread

All SQL operations are currently handled synchronously on the main thread, meaning that the thread is frozen until a query is complete, which may lead to server crashes on slow databases.
More than likely won't cause issues on SQLite, but it's still taxing I/O operations that should be handled asynchronously.

Re-implement teleportation cancelled sound and make it customisable

Regression from HuskHomes 1.5.x that I forgot to re-implement. With 2.1's customization sound feature this shouldn't be difficult to implement.

Pl3xMap support

Should be pretty easy. API:
https://github.com/pl3xgaming/Pl3xMap/wiki/Basic-API

Add warp permissions override

It appears doing something like huskhomes.warp.* doesn't do the trick.

Add /tpignore

maybe add a command to cancel all tpa requests
deny all of them
really useful for streamers
and youtubers

Original Suggestion by Unnm3d on Discord

Feature Request: Force Spawn on Login

Small request to add an option to force a player to spawn when entering the world / logging in similar to Essentials.

Implement an FAQ section to Wiki documentation

Implementation of a FAQ section to the Wiki subsection; this will include any questions that may crop up on occasion such as disabling a command via permissions or common questions on features.

This section can be updated, changed and morphed per version and will be revised as such -- this means that if any drastic change is performed steps to reproduce or test can be found either in the section or within a external document.

• Introduction to the FAQ
• Frequently Asked Questions: Permissions
• Frequently Asked Questions: Command Errors
• Frequently Asked Questions: Support

Hopefully this will both improve support efficiency and help new users.

implement /tpoffline

...to add an option to teleport you to offline users

Origin suggestion by Melonzio on Discord

Probably just a hooktie to the Player Position Database table? no egregious database reworking \o/

Dynamap integration Problems

Dynamap is displaying any and all homes made, even if set non-public that are made using HuskHomes2 - despite this there names on the map are still prefixed with /phome.

The Dynamap also doesn't appear to remove the Home or Phome after it has been deleted.

Below is a screenshot of a Home deleted over 10 minutes ago that is displayed on the dynamap as a Phome and is no longer existent.

Hide warps that you do not have permission to in /warps

Thanks a lot for the recent permission change.

I'd like to request that when doing /warps – it filters out the warps that the user does not have permission(s) for.

Implement HikariCP connection pooling

An error occurred when I tried to use MySQL to store data.
Output error message: [HuskHomes] The mySQL JBDC library is missing! Please download and place this in the /lib folder.
HuskHomes version 2.5. MySQL version 5.7.

Add EssentialsX home export from yaml userdata

Please add this feature. it's very useful for servers with a large playerbase

	                        Essentials ess=(Essentials)getServer().getPluginManager().getPlugin("Essentials");
				Plugin BTM = Bukkit.getPluginManager().getPlugin("BungeeTeleportManager");
				if (ess == null) {
					Bukkit.getLogger().severe("Essentials hook failed");
					return;
				}
				if (BTM == null && !BTM.isEnabled()) {
					Bukkit.getLogger().severe("BungeeTeleportManager hook failed");
					return;
				}
				BungeeTeleportManager bTel = (BungeeTeleportManager) BTM;
				for (UUID uuid : ess.getUserMap().getAllUniqueUsers()) {
					User u = ess.getUser(uuid);
					Bukkit.getLogger().info("Exporting home of "+u.getName()+" to Database");
					try {
						Home home = new Home(uuid, u.getName(), "home", Utility.getLocation(u.getHome("home")));
						bTel.getMysqlHandler().create(MysqlHandler.Type.HOMES, home);
					} catch (Exception e) {
						// TODO Auto-generated catch block
						e.printStackTrace();
					}
				}			

this is a sample i've made for another plugin but i hope it works with HuskHomes too

Permission error for /back

players cannot use /back even though the huskhomes.back permission is granted: also effects huskhomes.back.death.

Spam Prevention; Command Cooldown

Ability to set a cooldown to porkoju /tpa and other commands that may cause spam to the player.

Allow for customization and coloring of the home/warp list format

[home] • [home] • [home]
Currently only the separator (' • ') can be edited but this string does not respect MineDown formatting.
It should be possible to customize the display of the [home] items and separators including their color through MineDown formatting.

Look into providing an option to use Redis Messages

As opposed to Bungee plugin messages.

Add option to store a single /spawn location cross-server

Each server should have an option for /spawn to direct to that server's /spawn position OR the globally set /spawn point. /setspawn should probably be able to control this alongside some config options.

(There are no ____ to list on this page) messages missing

Should appear on pages with no homes, public homes or warps.

Add option to enforce teleportation safety

Make /tpa, /tpahere, /back, /home teleport Event safe. What I mean? I mean that when a player teleports to a position, this has to be safe. For example: if a player gets into a end portal, then he types /back, the teleport position has to be out of the end portal. It helps to avoid the loop teleporting, also helps to avoid stupid nether portal traps. This option has to be configurable (so we can toggle on/off)
The second suggestion is for the HuskHomesGUI. Try to save to database the icon selected for the home. It would be helpful if you have a multi instance network

Re-implement cross-server tab completion (Regression from 2.4.x)

Hello, we've setup in 2 servers and the tab complete isnt working when i want to send tpa and he is on another server.. We have enable the feature on the config.-

IllegalStateException thrown when teleporting to a world that is no longer available on server

[13:39:26] [Server thread/ERROR]: [HuskHomes] Task #83 for HuskHomes v2.2 generated an exception
[13:39:26] [Server thread/ERROR]: [HuskHomes] Suspected Plugins:
[13:39:26] [Server thread/ERROR]: [HuskHomes] HuskHomes{enabled,ver=2.2,path=plugins/HuskHomes-2.2.jar}
[13:39:26] [Server thread/ERROR]: [HuskHomes] Exception details below:
java.lang.IllegalStateException: The world "the_end" could not be found on the server; could not return location
at me.william278.huskhomes2.teleport.points.TeleportationPoint.getLocation(TeleportationPoint.java:78) ~[?:?]
at me.william278.huskhomes2.teleport.TeleportManager.teleportPlayer(TeleportManager.java:38) ~[?:?]
at me.william278.huskhomes2.teleport.TeleportManager.teleportPlayer(TeleportManager.java:30) ~[?:?]
at me.william278.huskhomes2.teleport.TeleportRequestHandler.lambda$startExpiredChecker$0(TeleportRequestHandler.java:197) ~[?:?]
at org.bukkit.craftbukkit.v1_16_R3.scheduler.CraftTask.run(CraftTask.java:100) ~[1.16.5-patched.jar:git-Yatopia-ver/1.16.5-36]
at org.bukkit.craftbukkit.v1_16_R3.scheduler.CraftScheduler.mainThreadHeartbeat(CraftScheduler.java:469) ~[1.16.5-patched.jar:git-Yatopia-ver/1.16.5-36]
at net.minecraft.server.v1_16_R3.MinecraftServer.b(MinecraftServer.java:1393) ~[1.16.5-patched.jar:git-Yatopia-ver/1.16.5-36]
at net.minecraft.server.v1_16_R3.DedicatedServer.b(DedicatedServer.java:402) ~[1.16.5-patched.jar:git-Yatopia-ver/1.16.5-36]
at net.minecraft.server.v1_16_R3.MinecraftServer.a(MinecraftServer.java:1302) ~[1.16.5-patched.jar:git-Yatopia-ver/1.16.5-36]
at net.minecraft.server.v1_16_R3.MinecraftServer.w(MinecraftServer.java:1023) ~[1.16.5-patched.jar:git-Yatopia-ver/1.16.5-36]
at net.minecraft.server.v1_16_R3.MinecraftServer.lambda$a$0(MinecraftServer.java:179) ~[1.16.5-patched.jar:git-Yatopia-ver/1.16.5-36]
at java.lang.Thread.run(Thread.java:834) [?:?]

Velocity Support

It would be cool to have support for the Velocity Proxy
Is it possible?

Clickable list navigation button tooltips do not change based on items per page settings

The list_button_next_page_tooltip and list_button_previous_page_tooltip tooltips that appear on the navigational buttons on lists (homes, warps, phomes) display "Click to view next/previous 10"; even if the number of items per page is changed in the configuration.

HuskHomesGUI error: API fails to return values stored on database

⚠️ We are aware of an issue with the API preventing the HuskHomesGUI and Placeholders to possibly fail to work and cause console errors. ⚠️

This is due to the change made in the way the API is accessed in the previous version as it is now accessed through an instance meaning the database object is no longer initialized meaning when the API attempts to load objects from the database it fails and throws a NPE.

There are no known workarounds other than reverting to HuskHomes v1.6; we are working on an update to resolve this issue in the near future.

Warp list not correctly hiding inaccessible warps when hiding them is enabled

Relevant code: https://github.com/WiIIiam278/HuskHomes2/blob/master/src/main/java/me/william278/huskhomes2/teleport/ListHandler.java#L216-L222
Might need a bit of a change to the way lists are handled to accommodate for removing items like this on the fly.

Huskhomes phome chat GUI does not escape formating codes

The base formating codes for the default game are used in the Chat GUI for the phones list (,to he assumed for warps GUI and Homes GUI too).

This leads to obfuscation, strike through, bolding etc when using certain characters in conjuction with symbols.

Allow warp from console

It'd be great to be able to warp players from console.

Syntax could be:

/warp <warp> <player>

Permission could be

huskhomes.warp.others

RTP protection check seemingly not working

The check for dangerous blocks to teleport to via RTP appears to not be working - this needs further investigating

Random teleportation fail but still cost money.

If /rtp command can't find a safe place to teleport the player, the teleportation will be canceled, but still cost money from the player, and show "Teleport Success".

Event canceling

track making events cancellable again with high priority, example as that is currently breaking HT functionality too

Further info needed on what "breaking HT functionality" means so it can be added to HuskTownsDocs Tracker

Add support for having multiple clusters of servers on a bungee network

Add an option in config.yml that essentially acts as an identifier number for different server clusters (cluster_id)
This cluster ID would then be appended to each plugin message sent and when a message is received HuskHomes would check that the cluster ID matches, else ignore the message.
This could perhaps be extended to allow multiple clusters to use the same homes database by adding a field in the TeleportationPoint object and thus in SQL for cluster ID.
This would allow total separation of teleportation systems between clusters.

Add option to charge per /back usage

Add ability to customize items per page on lists

E.g add a setting so that more than 10 warps can appear per page on /warplist, etc

Empty pages on public home list displays "There are no warps" message instead of homes