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:
Hi,
Its been discovered that this error is caused by not having a permissions plugin installed. Could you please try installing one to see if that fixes your issue? If you do have a permissions plugin installed could you please check to see if it supported by the Vault plugin (https://dev.bukkit.org/projects/vault)?
Best Regards,
Xquiset
Hey,
At the moment I can only set a default home, if I try to set another home I get the message: An internal error occurred while attempting to perform this command
any suggestions on how to fix this?
In reply to steen135:
Hi,
Could you please reply with a paste link containing your server log at the time of this error? You can create a paste here: https://dev.bukkit.org/paste
Best Regards,
Xquiset
In reply to Xquiset:
https://dev.bukkit.org/paste/d98154c7
Let me know if you need additional information
In reply to steen135:
Hi,
It looks like the Vault plugin is saying that you don’t have any groups setup within your permissions plugin. Do you have any permissions plugin installed with a default group, or have you setup a max homes for the group assigned to the player?
Best Regards,
Xquiset
In reply to Xquiset:
I didn't have any permission plugin installed, i installed bPermissions and now it works
In reply to steen135:
Hi,
Thats great to hear I'm glad it appears to be working now.
Best Regards,
Xquiset
Hi, could you please add an option to bypass cooldown. I really need it for my server which runs on 1.14.4. Thanks
In reply to uwygrt:
Hi,
There are a two ways that you could already accomplish this. You could add the permission homes.config_bypass to the player/group, but beware that this permission will basically disable all cooldowns for who ever has it. You could set the cooldown time to 0 and that will disable it for everybody. Hope this helps.
Best Regards,
Xquiset
I have 2 problems with this plugin at the moment. My Max homes is set to 5 but a number of players have more than that. I only have 1 group so its not a VIP or group issue. Why is it ignoring the max homes settings? Also I tried to set a cooldown, but that too is being ignore and people can use the command at will.
In reply to Kheama:
Hi,
The setting within the config for max homes acts more like a cap on the number of homes that a player can set. If you made the change to the config, after some people had more than 5 homes already, it will not delete random homes. It will disallow those players to set any more homes. Is this the behavior you're seeing? Could you paste your config here, using the paste functionality available here on bukkit dev: https://dev.bukkit.org/paste. Then all you need to do is give me the link.
Best Regards,
Xquiset
homes.setmax ---- como se usa este permiso?
Instead of commands, do you think it would be possible to set an item, something that does not stack (maybe a totem of undying) for example with the r-click function so when you click it, then you'd teleport home?
I really like the idea behind this plugin, I am just not a big fan of using commands if possible.
I don't really mind the commands when setting it up, but when using it. It would be nice for immersion to not have to type in a command.
Additionally if the player can pick what item with get that function, you could share it with friends so they could teleport to your home.
Example I configure my home location, name, and item (totem of undying) then anyone can teleport to my home if they know it, and if someone made gold boots as their item, and they told me I could hold onto a pair and use them that way.
Just an idea
also, what does Strike do?
In reply to Ry852:
Hi,
This sounds like an amazing idea. I will add it to the list of requested features for a future update. Also strike is just a little gimmick command. It will give the player a fishing rod that when clicked spawns a lightning bolt where the player is looking.
Best Regards,
Xquiset
Hey!
Got the PlugIn on my server, and so far it runs great. However, I noticed some players have like 10 "Homes" and some accounts can only have a Default home. I am up to date on the PlugIn but I am unsure how to help them. Is there a simple way to limit "homes" to 5 and allow everyone to use the command? Because whenever I try to do the homes.sethome permission it says error.
In reply to Purplechicken97:
Hi,
It sounds like you have not used the max-homes setting within the config.yml. By default this is set to '0' which disables the max-homes setting. I suggest you try and use that to limit your users homes. I am putting out an update soon that will allow you to limit the number of homes for an individual permission group. As for the permission error, are you using a permissions plugin? If so, which one are you using? This error by the way would be why some people can only have default homes, since that is the only functionality given to people with no permissions.
Best Regards,
Xquiset
In reply to Xquiset:
I am using the PlugIns;
Player Heads 5.2.8
Shop Keepers 2.9.3
EssentialsX 2.17.2
KingdomCraft Free 5.1.5
Set Homes 1.2.5
World Edit 7.1.0
MultiVerse Inventories 3.0.0
Also, the server hoster I am using has tiers for players, but all accounts have the same tier so I am unsure if that will effect anything
In reply to Purplechicken97:
Hi,
From what I can see you do not have a permissions plugin installed. I suggest that you ask your hosting service if the tiers have any ability to apply player permissions, and if so how you can set them up. If not I would suggest looking around for a permissions plugin. The one I use to test is called PermissionsEx, but it appears there download is now gone. Some others that I have heard of are bPermissions and PermissionsBukkit. Hope that helps in some way.
Best Regards,
Xquiset
Hey dude, is this plugin compatible with the multiverse plugin? Or did I not install this plugin properly?
When I was trying to /sethome and /home in the second world, I got an error in game saying: "An internal error occurred while attempting to perform this command".
Any assistance would be great, thanks!
In reply to uncledons:
Hi,
I’m sorry, but I am unfamiliar with the multiverse plugin. I do not know for certain whether or not my plugin is compatible with it. Would you mind explaining what the multiverse plugin does? Could you also post a copy of your server logs at the time this error occured?
Best Regards,
Xquiset