Skip to content

Commit f23ae1c

Browse files
RestoreMonarchyRestoreMonarchy
committed
improve readme
1 parent d57770a commit f23ae1c

File tree

1 file changed

+57
-51
lines changed

1 file changed

+57
-51
lines changed

‎README.md‎

Lines changed: 57 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,29 @@
11
# MoreHomes
2-
Allow players to claim and teleport to multiple beds.
2+
3+
A plugin for Unturned that allows players to claim and teleport to multiple beds.
34

45
## Features
5-
* Allow players to claim multiple beds
6-
* Cooldown and delay system for home teleportation
7-
* Cancel teleportation if the player moves
8-
* Integrates with Telepoertation plugin for Combat and Raid mode checks
9-
* VIP permission system for cooldown, delay, and max homes
10-
* As of version **v1.9.0,** `MoreHomesData.json` is stored in the map level data folder instead of the plugin directory
6+
- Claim multiple beds as homes
7+
- Teleport to your homes with simple commands
8+
- Configurable cooldown and delay system
9+
- Teleportation cancels if player moves
10+
- Works with Teleportation plugin to check combat and raid status
11+
- VIP system for special cooldowns, delays, and home limits
1112

1213
## Commands
13-
### Player
14-
* **/home** – Teleport to the first home in the list
15-
* **/home \<name\>** – Teleport to the home with the given name
16-
* **/homes** – Lists all your homes
17-
* **/destroyhome \<name\>** – Removes the home with the given name
18-
* **/renamehome \<name\> \<new_name\>** – Renames the home with the given name
19-
### Admin/Console
20-
* **/restorehomes** - Collects all the homes from the map and restores them to `MoreHomesData.json`
2114

22-
## Player Permissions
23-
```xml
24-
<Permission Cooldown="0">home</Permission>
25-
<Permission Cooldown="0">homes</Permission>
26-
<Permission Cooldown="0">destroyhome</Permission>
27-
<Permission Cooldown="0">renamehome</Permission>
28-
```
15+
### Player Commands
16+
- `/home` - Teleport to your first home
17+
- `/home <name>` - Teleport to a specific home
18+
- `/homes` - List all your homes
19+
- `/destroyhome <name>` - Delete a home
20+
- `/renamehome <name> <new_name>` - Rename a home
21+
22+
### Admin Commands
23+
- `/restorehomes` - Rebuild homes database from all beds on the map (console only)
2924

3025
## Configuration
26+
3127
```xml
3228
<?xml version="1.0" encoding="utf-8"?>
3329
<MoreHomesConfiguration xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
@@ -55,33 +51,43 @@ Allow players to claim and teleport to multiple beds.
5551
</MoreHomesConfiguration>
5652
```
5753

58-
## Translations
54+
### Configuration Options
55+
56+
- `MessageColor` - Color of plugin messages to players
57+
- `MessageIconUrl` - URL of the icon shown in messages
58+
- `DefaultHomeCooldown` - Seconds players must wait between using home teleport
59+
- `DefaultHomeDelay` - Seconds players must wait before teleportation happens
60+
- `DefaultMaxHomes` - Maximum number of homes a player can have
61+
- `TeleportHeight` - Height offset when teleporting to a bed
62+
- `CancelOnMove` - Whether teleportation should cancel if player moves
63+
- `MoveMaxDistance` - How far a player can move before teleport cancels
64+
- `BlockUnderground` - Prevent teleporting to beds located underground
65+
66+
## VIP System
67+
68+
The VIP system uses permission tags to give players special benefits:
69+
70+
- `VIPCooldowns` - Custom cooldown times for VIP players
71+
- `VIPDelays` - Custom delay times for VIP players
72+
- `VIPMaxHomes` - Custom maximum home limits for VIP players
73+
74+
Each VIP setting contains:
75+
- `PermissionTag` - The permission node that players need to have
76+
- `Value` - The numeric value for that permission
77+
78+
For example:
79+
- `<VIPPermission PermissionTag="morehomes.vip" Value="3" />` in VIPMaxHomes means players with "morehomes.vip" permission can have 3 homes
80+
- `<VIPPermission PermissionTag="morehomes.star" Value="5" />` in VIPCooldowns means players with "morehomes.star" permission have a 5 second cooldown
81+
82+
The plugin always uses the best value for the player:
83+
- For cooldowns and delays: the lowest value from applicable permissions
84+
- For max homes: the highest value from applicable permissions
85+
86+
## Player Permissions
87+
5988
```xml
60-
<?xml version="1.0" encoding="utf-8"?>
61-
<Translations xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
62-
<Translation Id="HomeCooldown" Value="Please wait [[b]]{0}[[/b]] seconds before using home again" />
63-
<Translation Id="HomeDelayWarn" Value="You will be teleported to your home [[b]]{0}[[/b]] in seconds" />
64-
<Translation Id="MaxHomesWarn" Value="You have reached the maximum number of beds" />
65-
<Translation Id="BedDestroyed" Value="Home unavailable: bed destroyed or unclaimed. Teleportation canceled" />
66-
<Translation Id="WhileDriving" Value="You can't teleport while driving" />
67-
<Translation Id="NoHome" Value="No matching home found for teleportation" />
68-
<Translation Id="HomeSuccess" Value="You were teleported to [[b]]{0}[[/b]] home" />
69-
<Translation Id="HomeList" Value="Your homes [[b]][{0}/{1}][[/b]]: " />
70-
<Translation Id="NoHomes" Value="You don't have any claimed beds" />
71-
<Translation Id="DestroyHomeFormat" Value="Usage: /destroyhome [[name]]" />
72-
<Translation Id="HomeNotFound" Value="No home found with the name [[b]]{0}[[/b]]" />
73-
<Translation Id="DestroyHomeSuccess" Value="Home [[b]]{0}[[/b]] has been removed" />
74-
<Translation Id="RenameHomeFormat" Value="Usage: /renamehome [[current name]] [[new name]]" />
75-
<Translation Id="HomeAlreadyExists" Value="You already have home with the name [[b]]{0}[[/b]]" />
76-
<Translation Id="RenameHomeSuccess" Value="Home renamed from [[b]]{0}[[/b]] to [[b]]{1}[[/b]]" />
77-
<Translation Id="WhileRaid" Value="You can't teleport while in raiding mode" />
78-
<Translation Id="WhileCombat" Value="You can't teleport while in combat mode" />
79-
<Translation Id="RestoreHomesSuccess" Value="[[b]]{0}[[/b]] homes have been restored" />
80-
<Translation Id="RemoveHome" Value="Your [[b]]{0}[[/b]] home has been removed" />
81-
<Translation Id="HomeClaimed" Value="New home claimed with the name [[b]]{0}[[/b]]" />
82-
<Translation Id="HomeTeleportationFailed" Value="Failed to teleport to [[b]]{0}[[/b]] home" />
83-
<Translation Id="HomeDestroyed" Value="Your [[b]]{0}[[/b]] home was destroyed" />
84-
<Translation Id="HomeCanceledYouMoved" Value="Home teleportation canceled because you moved" />
85-
<Translation Id="CantTeleportToBedUnderground" Value="You can't teleport to [[b]]{0}[[/b]] home, because it's underground." />
86-
</Translations>
87-
```
89+
<Permission Cooldown="0">home</Permission>
90+
<Permission Cooldown="0">homes</Permission>
91+
<Permission Cooldown="0">destroyhome</Permission>
92+
<Permission Cooldown="0">renamehome</Permission>
93+
```

0 commit comments

Comments
 (0)