?
Host a server
Modrinth App
Sign in
ModsPluginsData PacksShadersResource PacksModpacksServers
Settings

CleanHomeGUI

A lightweight Minecraft Paper plugin that adds a 3-home GUI system with /home, /sethome, and /delhome.

13
1
13
1

Compatibility

Minecraft: Java Edition

1.21.x

Platforms

Links

View source Join Discord server

Tags

Creators

Details

Licensed MIT
Published 3 weeks ago

CleanHomeGUI

CleanHomeGUI is a lightweight and customizable GUI-based home system for Paper servers.
It provides a clean /home experience with teleport countdowns, sounds, backups, and MySQL history โ€” without unnecessary clutter.

โœจ Features

  • โœ… /home GUI system (3 homes)
  • โœ… /home <1-3> teleport support
  • โœ… /sethome and /delhome
  • โœ… Rename homes via right-click in GUI
  • โœ… Action-bar teleport countdown
  • โœ… Cancel teleport when player moves
  • โœ… Configurable cooldown system
  • โœ… Clean GUI with dynamic bed colors
  • โœ… Delete buttons under each home
  • โœ… Custom sounds (UI click, pling, ender pearl)
  • โœ… Fully customizable messages (messages.yml)
  • โœ… YAML backup system (backups.yml)
  • โœ… MySQL coordinate history system
  • โœ… OP-only backup & restore commands
  • โœ… Tab completion for all commands
  • โœ… Reload command (/home reload)
  • โœ… Lightweight & optimized
  • โœ… Supports Paper 1.21+

๐Ÿ“ฆ Commands

Command Description
/home Open home GUI
/home <1-3> Teleport to home
/sethome <1-3> Set a home
/delhome <1-3> Delete a home
/home reload Reload plugin
/home backups <player> View YAML backups
/home history <player> View MySQL history
/home restore <player> <home> <backup> Restore YAML backup
/home restoredb <player> <home> <id> Restore from MySQL

๐Ÿ” Permissions

Permission Description Default
cleanhomegui.reload Allows /home reload OP
cleanhomegui.backup Allows backup & restore commands OP

๐Ÿ—„๏ธ MySQL History

Table created automatically: home_history

Tracks: set, deleted, overwritten, restored

๐Ÿ’พ Backup System

CleanHomeGUI automatically saves backups in: plugins/CleanHomeGUI/backups.yml

Backups are created when:

  • A home is deleted
  • A home is overwritten

โš™๏ธ Configuration

config.yml โ†’ GUI, cooldowns, MySQL, behavior
messages.yml โ†’ all messages
backups.yml โ†’ stored coordinates

โš ๏ธ If you update the plugin:
Delete the plugin folder once to regenerate configs.

๐Ÿš€ Notes

  • MySQL database must exist before startup
  • Plugin auto-creates required tables
  • Works even if MySQL fails (YAML backup fallback)
  • Designed to be simple, fast, and reliable