Set Homes
SetHomes
A simple homes plugin with the ability to create, delete, and teleport to many different homes. Have the ability to control a blacklist of worlds in which players will be restricted from setting homes. Using the config you can control setting such as a maximum number of homes, teleport cooldown, teleport delay, and their respective messages that get displayed to the user.
Installation
Simply place the downloaded jar into your server plugins folder.
NOTE! For "MAX HOMES" to work you must meet one of the soft dependencies below, and setup groups for the respective permissions plugin. You will then also need to setup max-homes in the config.yml. An example max-homes setup can be found below the default config
Soft Dependencies
- LuckPerms permission plugin, or Vault plugin, as well as, a permissions plugin supported by Vault
Commands
- /sethome [HomeName] [HomeDescription] - This command will allow the issuer to set a home with a given name and description of their choosing at your standing location. If no name and description are given then you will set a default home at your standing location.
- /home [HomeName] - This command will teleport the user to the given "HomeName". If no home name is given then the user is teleported to their default home that was set by /sethome
- /home-of [PlayerName] [HomeName] - This command will allow players with the "homes.home-of" permission to teleport to any players set home. If no home name is provided it will assume the default home as the desired destination.
- /delhome [HomeName] - This command will delete the home at the given home name. If no home name is given then it will attempt to remove the default home.
- /delhome-of [PlayerName] [HomeName] - This command will allow players with the "homes.delhome-of" permission to delete any players set home. If no home name is given it will assume the default home as the home desired for deletion.
- /uhome <HomeName> <HomeDescription> - This command will allow players with the "homes.uhome" permission to update any of there already set homes. If no description is given, and there was one previously set before it will reuse the old one.
- /uhome-of <PlayerName> <HomeName> - This command will allow players with the "homes.uhome-of" permission to update a home for any player. If no home name is supplied then it will update the supplied players default home.
- /homes [PlayerName] - This command will list all of the players currently set homes if there are any. Players with the "home.gethomes" permission can use the extra PlayerName parameter to list the homes of a specific player.
- /blacklist [Add/Remove] [WorldName] - This command is used to both add and remove worlds to/from the blacklist. If passed no other arguments it will list all worlds currently blacklisted.
- /setmax <GroupName> <Amount> - This command will allow players with the "homes.setmax" permission to set a maximum number of allowed homes for a specific permission group. For example if you wanted to only allow the default permission group 4 homes you execute the command, "/setmax default 4".
- /strike - Have fun admins.
Permissions
- homes.* - A player given this permission will be allowed all commands under the Set Homes plugin
- homes.home - A player with this permission is allowed to teleport to named homes
- homes.sethome - A player with this permission is allowed to set named homes
- homes.strike - Give the power to others!
- homes.blacklist_list - A player given this permission will be able to list worlds in the blacklist
- homes.blacklist_add - A player given this permission will be able to add worlds to the blacklist
- homes.blacklist_remove - A player given this permission will be able to remove worlds from the blacklist
- homes.config_bypass - A player given this permission can set homes in blacklisted worlds, and doesn't have to wait for cooldown or teleport delays. They will also be able to exceed the max home limit.
- homes.gethomes - Give the ability to list any players active homes
- homes.home-of - Give the ability to teleport to one of any players active homes
- homes.delhome-of - Give the ability to delete one of any players active homes
- homes.uhome - Give the ability to update homes
- homes.uhome-of - Give the ability to update other players homes
- homes.setmax - Give the ability to set a maximum number of homes for a permission group
Default Config
# -------------------------- # SetHomes Config # -------------------------- # Messages: # You can use chat colors in messages with this symbol §. # I.E: §b will change any text after it to an aqua blue color. # Color codes may be found here https://www.digminecraft.com/lists/color_list_pc.php # Time: # Any time value is based in seconds. # Things to Note: # Set any integer option to 0 for it to be ignored. # The max-homes does not include the default un-named home. # Use %s as the seconds variable in the cooldown message. max-homes: default: 0 max-homes-msg: §4You have reached the maximum amount of saved homes! tp-delay: 3 tp-cooldown: 0 tp-cancelOnMove: false tp-cancelOnMove-msg: §4Movement detected! Teleporting has been cancelled! tp-cooldown-msg: §4You must wait another %s second(s) before teleporting!
Example Max-Homes setup
max-homes: default: 1 free: 3 subscriber: 5 admin: 0
F.A.Q
- Q: How can I give players permission to set named homes?
A: You will need to install a permissions plugin, either LuckPerms, or Vault & a Vault supported permissions plugin then apply the permission "homes.sethome" to the (player or group) you would like to allow the usage of multiple homes for.
Change Log
- Added support for Minecraft/Craftbukkit V1.16.3.
- Added support for LuckPerms permission plugin
- Made LuckPerms default permission plugin, and set Vault as a rollback before disabling all together
- Changed colors, and layout of list homes message to be more readable
- Fixed error, where SetHomes could not load without Vault
- Removed auto-updater functionality because it was not working properly
- Added server log messages for permissions plugin hooking, and no perms plugin found
Donations
I work on this plugin with the little amount of free time that I have. Please feel free to donate any amount you desire by using the link just below the download button to show your support, and help me stay motivated to keep this project going. Thank You!
In reply to mental_metalhead:
Hi,
Could you explain a little more what it is that's not working? Is the plugin not loading, is the server not loading because of the plugin? Can you post there server logs?
Best Regards,
Xquiset
In reply to Xquiset:
I install the Jar file on my server in plugins for the 1.2.8 and it never starts on sever boot at all not even an error so I rolled back to 1.2.7 and it started working again but I get an error that 1.2.7 tried to update and it failed. Logs wouldn't show you anything because Sethomes 1.2.8 never even shows up.
In reply to mental_metalhead:
Hello again,
Thank you for the information on what happened. I am currently looking into this issue. I will update you here as soon as I figure out what might be happening.
Best Regards,
Xquiset
Hey there :) I have some trouble since updating the plugin to the newest Version, running a 1.16.2 Bukkit-Server:
It says "SuperPerms no group permissions." - What is that? I use MyPermissions, and the group all players are in got the following permissions:
homes.sethome
homes.home
homes.gethomes
homes.uhome
homes.sethome
Can you help me? The error occures when i try to save a new home. I can use existing homes, but when i try to save a new it says ingame "An internal error occured while attempting to perform this command".
Thanks in advance!
In reply to Forge_User_86387630:
Tried a bit, this error occures even when i remove the permissions-plugin.
In reply to Forge_User_86387630:
So, even with the default Bukkit permissions i got this error. But: When i delete the SetHome folder and let the plugin create a new one, it works fine. Any idea?
In reply to Forge_User_86387630:
And another one: Version 1.2.5 is working without any errors. So i stick with it :)
In reply to Forge_User_86387630:
Hi,
This error is caused by not having a Vault compatible permissions plugin. Vault is used so that I can grab "groups" from various different permission plugins out there. You will need to install a permissions plugin that is listed on Vaults plugin page. Sorry for any confusion.
Best Regards,
Xquiset
I'm having an issue where another player and I aren't able to set multiple homes with names anymore. It used to work before I had reset my server but now all me and him get are "An internal issue has occurred" or something around that. Not sure what it could be. I 've updated to the latest version and also tried Vault but Vault made everything worse.
In reply to fishnwitdaboiz:
Hi,
Could you tell me the list of plugins you have installed? I suspect that you do not have a permissions plugin installed that is compatible with Vault. Could you also check here: https://dev.bukkit.org/projects/vault to see if you have a compatible permissions plugin?
Best Regards,
Xquiset
Does this allow me to give per rank multiple homes? For example Newbie gets 1 home, Member gets 2 homes?
In reply to rainb0wtea:
Hi,
The short answer is yes. You will need to have the Vault plugin installed and a Vault compatible permissions plugin with groups setup. Then you can use the /setmax command to set a max home for a specific permission group. You can find a more detailed explanation of the command above.
Best Regards,
Xquiset
This plugin won't work for my server and if I try to open the .jar file it says it is "invalid or corrupt". I have downloaded it multiple times to the same effect. Any advice? I used this plugin previously, and I don't see what I have changed about it for it to be corrupted. Thank you.
In reply to TimTamShortage:
Hi,
What version of MC are you trying to run the plugin on? What version of Spigot/Bukkit are you using?
Best Regards,
Xquiset
Hey Xquiset,
What Permission Do You Use If You Want A Certain Group To Have 5 Homes But Another Group To Have 3?
My Default Homes Is Set To 0 (In The Config.yml)
In reply to Forge_User_39252951:
/setmax <GroupName> <Amount> - This command will set a maximum number of allowed homes for a specific permission group.
Using the latest version of Paper, but it's been like this since the last several versions.
In reply to xpgeeos:
Hi,
I'm not quite sure what "Paper" is. Could you explain that? Also are you using the "Vault" plugin? As of SetHomes V1.2.7 "Vault" is a required dependency. You will need to have it installed along with a compatible permission plugin, the list can be found on their plugin page for everything to work as it is intended. I hope this helps, and sorry for the very long delay in replys.
Best Regards,
Xquiset
Please fix "An internal error occurred while attempting to perform this command". It's getting really annoying being the server admin and not even being able to have multiple homes. Not sure what the issue is. It's updated and I even tried having Vault installed. Didn't fix anything.
In reply to fishnwitdaboiz:
Had the same problem in the last few weeks after upgrading to 1.16
I finally was able to fix that by going to /plugins/sethomes/homes.yml
Check if there is more than one entry with your UUID (maybe even with an old world name)
Delete all the entrys linked to your UUID and then restart the server.
After doing that i was able to set multiple homes again..
cheers
Morfidio