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
Does this support 1.16.2 yet?
In reply to Forge_User_73068527:
Hi,
I am in the process of upgrading it to MC Version 1.16.1. I am unaware of a version 1.16.2.
Best Regards,
Xquiset
In reply to Xquiset:
Hello,
I have just uploaded the latest version (SetHomes V1.2.7) that adds in support for MC V1.16.1. We just need to wait for approval and then it should be available for download. This usually takes about 1-3 days.
Best Regards,
Xquiset
Can this support version 1.12.2
In reply to mc_han123:
Hi,
I do not believe this supports version 1.12.2. I first wrote the plugin on version 1.13 and have not tested any version lower than that. You're welcome to try it out, but I will not guarantee any success. Please us know what you find if you do decide to test it out.
Best Regards,
Xquiset
Great plugin! Though would it be possible to make the player titles and sounds configurable?
In reply to CJCheese8:
Hi,
I will add this to the next feature update. Thank you for the kind input.
Best Regards,
Xquiset
Xquiset,
I have sent you a direct message about an error I am getting. I have Vault and LuckPerms installed on a 1.15.2 server. The error is only from 2 users trying to set / delete or perform a /home. It previously worked for them and they have not changed IGN's .....
Could you reply at your earliest convenience?
In reply to Kheama:
In reply to bigkierul:
Hi,
Sorry for the delayed reply. You will need to install a permissions plugin that is compatible with the "Vault" plugin. The list of compatible plugins can be found on their plugin page here: https://dev.bukkit.org/projects/vault. You will also need to install the "Vault" plugin if you do not have it installed already.
Best Regards,
Xquiset
I added the plugin, but how do I make that everyone has deop (I cannot trust them), but they can still use the command?
This is my Config:
max-homes: 3
default: true
max-homes-msg: §4You have reached the maximum amount of saved homes!
tp-delay: 3
tp-cooldown: 10
tp-cancelOnMove: true
tp-cancelOnMove-msg: §4Movement detected! Teleporting has been cancelled!
tp-cooldown-msg: §4You must wait another %s second(s) before teleporting!
auto-update: true
In reply to Forge_User_47307821:
Hi,
Sorry for the delayed reply. You will need to install a permissions plugin if you do not have one installed already. Then you will need to give whomever you want to allow the use of named homes the, homes.sethome permission. I highly suggest that you install a permission plugin that is compatible with the "Vault" plugin. The list of compatible plugins can be found on their plugin page here: https://dev.bukkit.org/projects/vault. I also recommend that you install the "Vault" plugin if you do not have it installed already.
Best Regards,
Xquiset
how do i create a group for the setmax?
In reply to jakefrostycs:
Hi,
Sorry for the delayed reply. In order to create a group you must install a "Vault" compatible permissions plugin. Depending on which permissions plugin you choose will determine how you will then create a group. You may find a list of the compatible permission plugins with "Vault" here: https://dev.bukkit.org/projects/vault. You must also have "Vault" installed along side my "SetHomes" plugin for this to work properly.
Best Regards,
Xquiset
Hey, I am having a problem similar to other people mention. which is I am only able to create a home by using "/sethome"
Whenever I try to create another home or name the first home, for example: "/sethome home1" then I get an error message:
an internal error occurred while attempting to perform this command
and here is the server log: https://dev.bukkit.org/paste/7e427ef1
Thank you for assisting me
In reply to radio4444:
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
In reply to Xquiset:
Yea, I already have installed a permission plugin called PoweRank. However it seems the vault plugin does not support PoweRank.
So I assume that I have to install one of the permission plugins that is supported by the vault plugin. If that's the case, then I will try it out soon. And reply back if it works or not.
Thank you for your reply.
hi,i'm trying to edit the config file but it reset everytime : (
In reply to Forge_User_93094889:
Hi,
Could you tell me what you're trying to edit within the config? You must save the file after editing, and reload the server to see the desired changes in game. I'm not exactly sure what could be going wrong here.
Best Regards,
Xquiset
Hello,
I'm also getting the message:
"An internal error occurred while attempting to perform this command"
If trying to set more than one home. Am I missing a config?
Thanks!
In reply to letsmineworld:
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