SimpleHomes
A straightforward mod that gives every player the ability to create a single home point for quick travel around the world.
Required Dependencies
This mod requires the installation of BFAPI.
Available Commands
| Command | Permission | Operator Level | Purpose |
|---|---|---|---|
| sethome | simplehomes.use | 0 | Sets the home point at the player's current location |
| home | simplehomes.use | 0 | Teleports the player to their established home point |
Configuration Settings
The configuration file is located at simplehomes.json in the config directory.
| Parameter | Type | Description | Default Value |
|---|---|---|---|
| homePermission | String | Permission for using the /home command | simplehomes.use |
| homeSetMessage | Text | Message when setting the home point | Your home has been set |
| homeStorage | JsonObject | Storage for home point coordinates | {} |
| warmup | Integer | Wait time before teleportation (in seconds) | 5 |
| noHomeMessage | Text | Message when no home point is set | You do not have a home set! |
| forceHomeToBeBed | Boolean | Whether to bind home point to respawn point | false |
| failedToTeleportDueToMovement | Text | Message when moving during teleportation | Teleport to home canceled as you moved! |
| sendTextViaActionBar | Boolean | Send messages via action bar or chat | true |
| teleportSucceeded | Text | Message for successful teleportation | Teleported to your home! |
| teleportWait | Text | Message when teleportation preparation begins | Teleporting shortly, please do not move |
| cooldown | Integer | Cooldown time between /home uses (in seconds) | 30 |
| cooldownMessage | Text | Cooldown message | You are on cooldown! |
{
"homePermission": "simplehomes.use",
"homeSetMessage": {
"color": "gold",
"text": "Your home has been set"
},
"homeStorage": {},
"warmup": 5,
"noHomeMessage": {
"color": "red",
"text": "You do not have a home set!"
},
"forceHomeToBeBed": false,
"failedToTeleportDueToMovement": {
"color": "red",
"text": "Teleport to home canceled as you moved!"
},
"sendTextViaActionBar": true,
"teleportSucceeded": {
"color": "gold",
"text": "Teleported to your home!"
},
"teleportWait": {
"color": "gold",
"text": "Teleporting shortly, please do not move"
},
"cooldown": 30,
"cooldownMessage": {
"color": "red",
"text": "You are on cooldown!"
}
}