SethomeLuck

🏠 SetHome Plugin — Paper 1.21.1

Complete SetHome plugin for Paper 1.21.1 featuring LuckPerms integration, cooldown system, teleport delays with cancellation, and fully customizable titles.

---

✅ Features

• Unlimited Homes (restricted per LuckPerms group)
• Group-based Cooldowns (fully configurable)
• Teleport Delay (cancels automatically if the player moves)
• Fully Customizable Titles & Subtitles (supports hex colors &#RRGGBB)
• Automated Saving (homes saved in YAML format)
• Tab-completion enabled for all commands
• Admin Commands (reload, list, delete)

---

📦 Installation

1. Drop the .jar file into your plugins/ directory.
2. Ensure LuckPerms is installed on the server.
3. Start the server — the plugins/SetHome/ folder will generate automatically.
4. Modify config.yml according to your needs.
5. Run /homeadmin reload to apply configuration changes without restarting.

---

🎮 Commands

Command	Description
/sethome <name>	Create a home at your current position
/home <name>	Teleport to a home
/delhome <name>	Delete a home
/listhomes	List your homes
/homeadmin reload	Reload the configuration
/homeadmin list <player>	View a specific player's homes
/homeadmin delete <player> <home>	Delete a specific player's home

---

🔑 Permissions

Permission	Description	Default
sethome.use	Grants access to basic commands	true
sethome.admin	Grants access to admin commands	op
sethome.bypass.cooldown	Bypasses teleport cooldowns	op
sethome.bypass.limit	Bypasses home limits	op

---

⚙️ LuckPerms Configuration

Group Limits (group-homes)

group-homes:
  default: 3
  vip: 6
  vip+: 10
  staff: 20
  admin: -1  # -1 = unlimited

Group Cooldowns (group-cooldowns, in seconds)

group-cooldowns:
  default: 10
  vip: 5
  vip+: 3
  staff: 0
  admin: 0

Note: If a player belongs to multiple groups, the group with the highest limit (or the lowest cooldown) takes priority.

---

🎨 Title Customization

Titles support:

• Legacy color codes like &a, &b, &l, etc.
• Hex color codes like &#RRGGBB

Example in config.yml:

titles:
  teleport-success:
    enabled: true
    title: '&#00FF7F&l✔ Arrived'
    subtitle: '&7Welcome to &a{home}&7!'
    fade-in: 10
    stay: 40
    fade-out: 20

Available Placeholders

Placeholder	Available in
{home}	All titles
{seconds}	teleport-delay

---

🏗️ Compilation

Prerequisites: Java 21, Maven

mvn clean package

The compiled jar file can be found in target/SetHome-1.0.0.jar.

---

📁 Project Structure

SetHome/ ├── src/main/java/fr/sethome/ │ ├── SetHomePlugin.java # Main class │ ├── commands/ │ │ ├── SetHomeCommand.java │ │ ├── HomeCommand.java # Teleportation + cooldown + delay │ │ ├── DelHomeCommand.java │ │ ├── ListHomesCommand.java │ │ ├── HomeAdminCommand.java │ │ └── SetHomeTabCompleter.java │ ├── listeners/ │ │ └── PlayerMoveListener.java # Cancellation on movement │ ├── managers/ │ │ ├── ConfigManager.java # Config loading + LP groups │ │ ├── HomeManager.java # Home CRUD operations + YAML saving │ │ └── CooldownManager.java # Cooldown + pending tasks │ └── utils/ │ └── TitleUtil.java # Adventure API title sending └── src/main/resources/ ├── plugin.yml ├── config.yml └── homes.yml