SimpleHomes is a stable base homes plugin. It offers all the essential features necessary in a home plugin and some additional useful permissions. Advanced features such as moving homes, renaming homes, or sharing homes with other players are not present in SimpleHomes. I have plans for a more advanced homes plugin that will include those. Stay tuned! SimpleHomes is just meant to be as advertised: simple and easy to use.
- User data stored in separate JSON files.
- Paginated homes list with clickable text to traverse pages/go to homes.
- All messages sent by the plugin are changeable/translatable.
- Full PlaceholderAPI support.
- Metrics through bStats.
- Boss bar for teleport delay.
- Permission-based max homes.
- Completely open-source.
There are only five commands in SimpleHomes.
/sethome [name]- Set a new home at your current location./home [player|name] [name]- Teleport to a certain home./homes [player]- View a paginated list of homes./delhome [player|name] [name]- Delete a certain home./simplehomes [help|reload]- Get help or reload the plugin.
There are a number of permissions available to modify what certain players can do.
These are given to all players automatically, but can be negated with a permission manager such as LuckPerms:
simplehomes.sethome- Allows players to set a home.simplehomes.home- Allows players to go to one of their homes.simplehomes.homes- Allows players to view a list of their homes.simplehomes.delhome- Allows players to delete one of their homes.simplehomes.nether- Allows players to set homes in the nether dimension.simplehomes.end- Allows players to set homes in the end dimension.
These are only given to opped players automatically:
simplehomes.delhome.other- Allows players to delete another player's home.simplehomes.home.other- Allows players to travel to another player's home.simplehomes.homes.other- Allows players to view another player's homes.simplehomes.reload- Allows players to reload the plugin.simplehomes.sethome.unlimited- Allows players to set unlimited homes.simplehomes.delay.bypass- Allows players to bypass the teleport delay.
To set a player's max homes limit with permissions use simplehomes.sethome.max.<integer>, replacing <integer> with the number of max homes.
Note: If you set a lower home limit than what has been set before, the lower limit will not overwrite the higher limit. Meaning if a player has, for example, a home limit of 5, and you set it to 3 via permissions, it will remain 5. To lower it, you must manually edit the player's JSON file.
The default config.yml is available here where a handful of configuration options can be changed. To make these changes take effect run /simplehomes reload. If you have questions about the configuration or want to suggest a new configuration option, you can discuss that in Discord.
All messages sent by SimpleHomes are stored in the lang.yml file here and can be changed/translated. Color codes and other formatting are done using MiniMessage. Legacy color codes (&c, &l, etc.) will not work. Those are being removed from Minecraft entirely soon.
If you need help with the plugin and can't find the answer here, then the best way to get help is to join my Discord. Make sure you read the frequently asked channel before posting in the bug-reports channel (if it's a bug) or in the simple-homes channel (for general help).
If you have discovered a bug, you can either join my Discord and report it there or open an issue here on GitHub.
SimpleHomes stores homes using JSON. When the plugin is installed the playerdata folder is created and every player has a file named with their unique id. When homes are set/deleted the file updates in real time. The plugin also depends heavily on adventure by Kyori for components in chat. SimpleHomes has an API and documentation for that is coming.
SimpleHomes is open-source and licensed under the MIT License, so if you want to use any code contained in the plugin or clone the repository and make some changes, go ahead!
If you've found a bug within the plugin and would like to just make the changes to fix it yourself, you're free to do so and make a pull request on GitHub. If you make significant contributions to the project, and by significant I mean one little PR to fix a tiny bug doesn't count as significant, you can earn the Contributor role in my Discord.
I'm a full-time developer who makes and supports these plugins in my free time (when I have any). As a long-time supporter of open source, most of my plugins are free. If you enjoy my plugins and would like to support me, you can buy me coffee over on PayPal. Donations of any amount are appreciated, and a donation of $10 or more will get you the Supporter role in my Discord!