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
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
- 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!
Hey I was wondering I have luck perms installed but the max homes is not working. Eachtime I add the command maxhomes it says that group does not exist when it does
Is their something that I am doing wrong in the setup
In reply to minecraftian_nation:
Same here.
Although after taking a look at the config.yml I noticed it does change the values. It only replies with "blabla group does not exist".
You didnt do anything wrong, just change the values and take a look at the config,yml at /plugins/SetHomes.
pls delete this comment, i cant delete it myself without getting an error message
In reply to minecraftian_nation:
open the plugin config.yml and set:
max-homes:
default: 5
Hello,
Ive been trying to set up the tp cooldown feature and no matter the number i set for time it has no affect. Is there something im doing wrong? i tried to use the %s thign and it errors in console.
Regards,
Elf
In reply to elfanator:
Hello,
Could you please paste your config.yml here? I suspect there is something wrong with it.
Best Regards,
Xquiset
In reply to Xquiset:
max-homes:
default: 8
max-homes-msg: §4You have reached the maximum amount of saved homes!
tp-delay: 3
tp-cooldown: 10
tp-cancelOnMove: false
tp-cancelOnMove-msg: §4Movement detected! Teleporting has been cancelled!
tp-cooldown-msg: §4You must wait another %s second(s) before teleporting!
In reply to elfanator:
Hello,
I know this is a rather late reply and I apologize for that. I have recently moved and that created a lot of stress. Are you by chance OP when you are testing the cooldown? OP players by default bypass any cooldown or tp delay.
Best Regards,
Xquiset
Hello! love love this plugin!
I have a question tho, im still new to this and I was setting up server for my friends. I am not sure wether is command /back tied to homes plugin or essentials only?
When I port somewhere, then port home and do back command (for example wanna just grab something from home and go back looting), I end up not where I ported from. Any idea what am I doing wrong? <3 Thank you in advance
In reply to its_shewolf:
/back is a feature from essentials. To get it to work with this plugin you have to change "register-back-in-listener" to true. Which can be found in the config file for essentials.
In reply to elfanator:
Oh my.. thank you so much! I can´t believe I missed that! Many thanks ^^
Hey, First of all I love the plugin, its great. Yet, I have a issue with my friend on the server. I am able to make more homes without a problem as a OP, but he is also a OP and everytime he tries to makes more homes with the /sethome (name), then it says "An internal error has occured while attempting to perform this command". Do you know how to fix this? Thanks in advance
In reply to Wild_Sinondo:
Hello,
I think your friend used a special character that should not have been allowed in a home name. Versions of the plugin prior to V1.3.0 accidentally allowed special characters to be used in the home name. You will need to find this home within your homes.yml file, and either remove the entire home entry, or adjust the home name so it no longer contains a special character. Hope this helps. Please let me know if you run into any more issues.
Best Regards,
Xquiset
Hello there! got a problem in here, for some reason when I type /home, I tp looking literally down at the floor, even if I sethome looking at the air it still tps me looking down, there is any fix for it?
In reply to god_prisega:
Hello,
There is an error in the version of the plugin you're using. The values with pitch and yaw are getting swapped when being read from the homes.yml file. I will be putting out an update soon that fixes this issue.
Best Regards,
Xquiset
Hi. a have a question. all players can use /home or inly players with op?
In reply to pgblackofficial9877987:
Hello,
By default all players can use /sethome and /home. However this only allows for one home at a time. Players would need to be given permission to be able to set multiple homes with names and descriptions.
Best Regards,
Xquiset
Hey! Can you help me? I can't see my homes using /homes (i'm OP). When I use /homes, only "---" appear in the chat.
In reply to 0awn:
Hello,
Could you please paste your homes.yml here? I think there may be an issue within it causing the homes to be displayed improperly.
Best regards,
Xquiset
how do i add the max homes to the command? is it homes.setmax.1 ?