From fe477d1857df53d7a76acfe30479e69118fb1dde Mon Sep 17 00:00:00 2001 From: bunchy7s Date: Sun, 21 Jun 2026 19:13:09 -0500 Subject: [PATCH] add info to readme --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fda55b7..3cb00bf 100644 --- a/README.md +++ b/README.md @@ -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 ` | Teleport to one of your homes | | `/delhome ` | Delete one of your homes | +| `/tpa ` | Request to teleport to a player | +| `/tpahere ` | Request a player to teleport to you | +| `/tpablock ` | 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 `** — Send a teleport request to a player +- **`/tpahere `** — Ask a player to teleport to you +- **`/tpablock `** — 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