bunchy7s/bhomes
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add info to readme

Browse source
This commit is contained in:
Professor Doom 2026-06-21 19:13:09 -05:00
parent 88f246b48e
commit fe477d1857
1 changed files with 25 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,10 +1,12 @@
# BHomes
A simple home-management plugin for Paper servers. BHomes provides persistent SQLite storage, configurable limits, teleport cooldown/delay handling, and optional LuckPerms-based group limits.
A simple home-management plugin for Paper servers, forked from [SiDaHomes](https://github.com/SiDaStuff/sidahomes).
BHomes provides persistent SQLite storage, configurable limits, teleport cooldown/delay handling, optional LuckPerms-based group limits, and a full TPA system with blocked player management.
## About
BHomes is designed for servers that want reliable player homes without unnecessary complexity. It supports modern Paper command registration, async data operations, and configurable limits.
BHomes is designed for servers that want reliable player homes without unnecessary complexity. It supports modern Paper command registration, synchronous data operations (Folia-compatible), and configurable limits.
## Requirements
@ -30,6 +32,12 @@ BHomes is designed for servers that want reliable player homes without unnecessa
| `/home` | List your homes |
| `/home <name>` | Teleport to one of your homes |
| `/delhome <name>` | Delete one of your homes |
| `/tpa <player>` | Request to teleport to a player |
| `/tpahere <player>` | Request a player to teleport to you |
| `/tpablock <player>` | Toggle blocking TPA requests from a player |
| `/tpaaccept [player]` | Accept a pending TPA request |
| `/tpaccept [player]` | Alias for `/tpaaccept` |
| `/tpadeny [player]` | Deny a pending TPA request |
### Admin
@ -49,6 +57,7 @@ BHomes is designed for servers that want reliable player homes without unnecessa
| `bhomes.sethome` | `true` | Set homes |
| `bhomes.home` | `true` | Use `/home` |
| `bhomes.delhome` | `true` | Delete own homes |
| `bhomes.tpa` | `true` | Use TPA commands |
| `bhomes.bypass.cooldown` | `op` | Bypass teleport cooldown |
| `bhomes.bypass.delay` | `op` | Bypass teleport delay |
| `bhomes.admin.list` | `op` | List player homes |
@ -67,7 +76,20 @@ Main settings are in `plugins/BHomes/config.yml`:
- `limits`: default and group-based home limits
- `cooldown`: teleport cooldown settings
- `teleport`: delay and movement-cancel behavior
- `messages`: MiniMessage-formatted plugin messages
- `tpa`: TPA request timeout configuration
- `messages`: MiniMessage-formatted plugin messages (includes TPA messages with clickable accept/deny buttons)
## TPA Features
- **`/tpa <player>`** — Send a teleport request to a player
- **`/tpahere <player>`** — Ask a player to teleport to you
- **`/tpablock <player>`** — Toggle blocking TPA requests from a player
- **`/tpaaccept [player]`** — Accept a pending request (with optional player name to accept a specific one)
- **`/tpadeny [player]`** — Deny a pending request
- **Clickable accept/deny buttons** — Received requests show green `[ACCEPT]` and red `[DENY]` buttons in chat
- **Request timeout** — Configurable expiry via `tpa.timeout` in config.yml
- **Blocked players** — Stored in the same SQLite database, persisted across restarts
- **Folia-compatible** — Uses player-based schedulers for teleport delays
## Build From Source