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!
i have a question.
how do i add people to a group for a amount of homes?
In reply to gwnthijmen07:
Hello,
Are you using a permissions plugin supported by "SetHomes" on your server? If so then I would recommend googling a tutorial for setting up groups with it. Otherwise you can read about the permission plugins that "SetHomes" currently supports in the F.A.Q section above.
Best Regards,
Xquiset
Hi. This plugin is very nice. However, when I run /home and teleport, I am looking right up. Is this a specification?
In reply to nanasi_33:
Hello,
No, this is not a specification. The /sethome saves the exact x, y, z, yaw, and pitch values of the player when they issue the command. You were more than likely looking straight up when you issued the /sethome command to save this home.
Best Regards,
Xquiset
In reply to Xquiset:
Thanks for the reply.
In reply to nanasi_33:
Of course, no problem.
Best Regards,
Xquiset
In reply to Xquiset:
Hello again,
I was working on the code and have found that I accidentally swapped the values for yaw and pitch in a piece of the code. This may cause the player to look in a completely different direction than when they actually saved the home. I am working on finalizing a fix for this, and a few other additions. Once I finalize everything I will be uploading V1.3.1.
Best Regards,
Xquiset
Hello!
I have a little problem with permissions. The /sethome command works, but only players with /op can set up more than one house.
A player with no op says he has no permissions.
In reply to marczuspl:
Hello,
You will need to install a permissions plugin if you do not have one installed already. I would recommend using LuckPerms, as it is rather easy to setup, and there are some good tutorials out there for it. You can read the F.A.Q above for a bit more info on the supported permission plugins. The permissions for SetHomes can also be found above in the Permissions section. That should get you started I believe. Please let me know if you have any other questions.
Best Regards,
Xquiset
In reply to Xquiset:
Thanks you very much :D
In reply to marczuspl:
No problem!
Best Regards,
Xquiset
the /sethome doesn't work for some reason, please help?
In reply to lwkylion:
Hello,
I'd be happy to help. First I am going to need some more information though. Is there an error being thrown when you run the command? Is the home simply not saving? What exactly is it that is not working?
Best Regards,
Xquiset
Hello
it's a great plugin but i've got a problem:
i have installed all stuff needed for the plugin but i also have worldguard installed.
Is there a way to use you plugin even with the worldguard one installed?
It only says "An internal error occured while attemting to perform this command."
Please help :|
In reply to gaudizocker:
Hello,
Could you please post a link to a paste of the console when this happens? This will help me better determine what the issue really is. Thank you.
Best Regards,
Xquiset
Hello, thats a great plugin, but I have a problem. When I do /setmax "group" "max",
it says to me that the group does not exist, (with all the groups), I actually use LuckPerms, and the groups names were corrects
In reply to Jackof35:
Hello,
This is a bug with the current version of the plugin. When I get the next version approved this will be fixed. For now you can either build from source on GitHub, or try and setup the max homes in the config instead. Sorry for the trouble!
Best Regards,
Xquiset
it keeps saying that the group does not exist
In reply to ihateantonios:
Hello,
This is a bug with the current version of the plugin. When I get the next version approved this will be fixed. For now you can either build from source on GitHub, or try and setup the max homes in the config instead. Sorry for the trouble!
Best Regards,
Xquiset
Hey, loving the plugin. Is there any way to change the number of max homes without a permission plugin? When i start the server the console says it's skipping the max-home config becuase there was nopermissions-plugin found. And if not, which permission plugin do you recommend that is easy to use?