Set Homes
PLEASE READ!!!
This plugin will no longer be updated. We have released a new an improved version called, Set Homes Two. All future updates will be applied there, however this plugin will not be removed from the projects page so feel free to use it in it's current state as it is stable.
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
Only choose one option below
- LuckPerms permission plugin
- 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
- Set Homes Two released: https://dev.bukkit.org/projects/set-homes-two
- 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
In reply to Xquiset:
Thanks for the reply. Is there a way I can approach you privately about this issue?
Thanks.
In reply to uncledons:
Hi,
Yes, you can private message me here on dev.bukkit.org.
Best Regards,
Xquiset
Hey man what version does this work on?
In reply to spokensanity:
Hi,
Currently the known supported versions are MC 1.15, 1.14, and 1.13.
Best Regards,
Xquiset
so right now im trying to make the teleporting home not auto matic can i get some help with that?
In reply to Whywidow6:
Hi,
I'm not quite sure what you're asking for. Could you elaborate on your question?
Best Regards,
Xquiset
How edit help command?
In reply to Awequr:
Hi,
The help command is not directly editable, as it is apart of Minecraft's core functionality. If there are any issues with the help then please feel free to let me know so that I can fix them in the code.
Best Regards,
Xquiset
In reply to Xquiset:
thanks for the answer
In reply to Awequr:
You’re very welcome
Xquiset
Hi. I love your plugin but sometimes it prevent the server from launching or closing.
[04:04:56 INFO]: [SetHomes] Enabling SetHomes v1.2.5*
It keeps like this for minutes. I dont have time to test if it loads. It happens sometimes, not everytime. Can happen on stop too. If i remove the plugin the server works perfecly. What can i do?
In reply to Forge_User_71555199:
Hi,
I suspect that something did not get setup properly with the plugin. Could you tell me what version of Minecraft you're attempting to run this on? Also what version of bukkit/spigot you're attempting to use?
How do you make it only save/load houses in a certain area?
In reply to somethingaboutdavid223:
Hi,
I'm not quite sure what you mean? Could you please be more specific? What do you mean by "certain area"?
Best Regards,
Xquiset
please plugin version 1.15.2
In reply to Forge_User_67264269:
Hi,
I am in the process of getting it upgraded. Thank you for your patience.
Best Regards,
Xquiset
In reply to Forge_User_67264269:
Hi again,
I'm sorry I don't play minecraft really so I am out of touch with the versions. The plugin already supports Minecraft V1.15.2.
Best Regards,
Xquiset
Is there anyway to limit /home through dimensions? Like you cant /home to a nether unless you're in the nether.
In reply to raisuken:
Hi,
Sorry this currently is not a feature. I will try and get it added into the next feature release.
Best Regards,
Xquiset
As a user giving an argument to the /sethome command returns a permissions error. bPermissions is set to give the homes.sethome permissions to the default group but it can only use the command without arguments. /home works fine.