bhomes/README.md

2.4 KiB

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.

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.

Requirements

  • Server: Paper 1.21+
  • Java: 21
  • Optional: LuckPerms (for group-based home limits)

Installation

  1. Build or download the plugin JAR.
  2. Place the JAR in your server plugins/ folder.
  3. Start or restart the server.
  4. Edit plugins/BHomes/config.yml as needed.
  5. Use /bhomesreload after config changes.

Commands

Player

Command Description
/sethome <name> Set a home at your current location
/home List your homes
/home <name> Teleport to one of your homes
/delhome <name> Delete one of your homes

Admin

Command Description
/homeadmin list <player> List a player's homes
/homeadmin delete <player> <home> Delete a player's home
/homeadmin teleport <player> <home> Teleport to a player's home
/homeadmin export Export homes data to CSV
/homeadmin import Import homes data from CSV
/bhomesreload Reload plugin configuration

Permissions

Permission Default Description
bhomes.sethome true Set homes
bhomes.home true Use /home
bhomes.delhome true Delete own homes
bhomes.bypass.cooldown op Bypass teleport cooldown
bhomes.bypass.delay op Bypass teleport delay
bhomes.admin.list op List player homes
bhomes.admin.delete op Delete any player's home
bhomes.admin.teleport op Teleport to any player's home
bhomes.admin.reload op Reload config
bhomes.admin.import op Import homes data
bhomes.admin.export op Export homes data
bhomes.admin.* op All admin permissions

Configuration

Main settings are in plugins/BHomes/config.yml:

  • database: storage backend and file name
  • limits: default and group-based home limits
  • cooldown: teleport cooldown settings
  • teleport: delay and movement-cancel behavior
  • messages: MiniMessage-formatted plugin messages

Build From Source

./gradlew build

Compiled JAR output:

build/libs/