T2B HomeSystem
Easy to use HomeSystem, Manage, Edit
and Delete your Personal and Shared Homes!
Main GUI
In the Main GUI, you can quickly access your personal and shared homes.
Additionally, at the header, you can view your count of current and maximum personal/shared homes.
If you are an admin, a third button will appear, allowing you to access the Admin Settings Page.
Personal Home GUI
Here, you can view all your personal homes and easily manage them. Additionally, you have shortcuts for advanced use:
- Left-click: Teleport
- Drop (Q): Delete
- Right-click: Edit Home (Change Color, Update Position...)
Furthermore, there is a green button at the bottom in the middle to create a home with a random name.
Admin GUI
In the Admin GUI, you can control the HomeSystem. At the top, you'll find a header with information about the plugin. Below that, there are three buttons:
- Change Background:
- Modify the background for the entire system.
- Home Manager (Coming Soon):
- View and manage homes for your players.
- Reset Configs:
- Reset the config.yml and the messages.yml. Please note that this action does not reset the homes from the players!
Shared Homes
In the Shared Home GUI, you can view homes that have been shared with you. You have the option to teleport to these homes and also remove them from your list. To share a home, use the command.
Commands
You can also access all features from the GUI using commands, and you can do even more with commands!
Notice: All commands have a tab-completer!
Here's a brief explanation of the brackets used in the commands:
- [] ← These brackets indicate that the argument in the command is optional; you do not need to provide one.
- <> ← These brackets indicate that the argument must be given; otherwise, it won't work.
Now, here is a list of all commands:
- /home [name]:
- If no name is given, it will open the Home GUI; otherwise, it will teleport you to the specified home.
- /sethome [name]:
- If you don't provide a name, it will pick a random one for you.
- /homes:
- Directly opens your personal homes.
- /sharedhomes:
- Directly opens your shared homes.
- /sharedhome <name> <add> <player_name>:
- Gives a player permissions to use this home.
- /sharedhome <name> <remove> <player_name>:
- Removes a player, preventing them from accessing your home.
- /sharedhome <name> <list>:
- Displays all players who have access to this home.
Permissions
Here is a full list of permissions:
- t2bhomesystem.home
- Permission to use the /home command.
- t2bhomesystem.sethome
- Permission to use the /sethome command.
- t2bhomesystem.delhome
- Permission to use the /delhome command.
- t2bhomesystem.homes
- Permissions for the /homes command.
- t2bhomesystem.sharedhomes
- Permissions for the /sharedhomes command.
- t2bhomesystem.sharedhome
- Permissions for the /sharedhome command.
- t2bhomesystem.maxpersonalhomes.10
- This permission sets the maximum personal homes for the rank; replace the '10' with your preferred number. Use '*' for the maximum (Max 45).
- t2bhomesystem.maxsharedhomes.10
- This permission sets the maximum shared homes for the rank; replace the '10' with your preferred number. Use '*' for the maximum (Max 45).
Configs
If you run the plugin on your server, in the Plugins folder, there will be a new folder called "T2BHomeSystem." Inside, you'll find three files, and here's a brief explanation. Additionally, each config has a restore mechanism; if it gets corrupted, it will reset itself upon restarting the server. To reset a specific config, delete the respective file or use the Admin Settings in-game to reset it. To reset all homes, simply delete the homes.yml file.
- config.yml
- Stores general configurations such as the background color for the menus.
- messages.yml
- Stores all messages from the plugin. You can edit every single message, and the prefix is also editable here.
- homes.yml
- The heart of the plugin, where all home data is stored. Do not modify this file if you are not familiar with its structure. Any unintended changes may result in a reset of all homes.