Skip to main content

Documentation Index

Fetch the complete documentation index at: https://pumpkings.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

LiricHomes is an advanced, zero-hardcode home management plugin built for Paper 1.21 servers. It wraps EssentialsX’s home system with a fully interactive inventory GUI, giving your players a visual way to teleport, manage, and personalise their homes — all without typing a single command beyond /homes. Every menu is defined in YAML, so you can tailor the look and feel without touching any code.

Key Features

Inventory GUI

Every home appears as a player head or custom icon inside a paginated chest GUI. Players teleport, delete, and configure homes directly from the menu — no extra commands required.

Per-Rank Home Limits

Assign home limits through permission nodes such as liric.homes.vip.5. The plugin automatically picks the highest limit a player holds, with a configurable server-wide default as the fallback.

Flexible Storage

Choose from MySQL, MariaDB, PostgreSQL, SQLite, or YAML flat-file storage. SQLite works out of the box with zero setup, while SQL backends are available for servers that need a shared or centralised database.

Automated Backups

The built-in backup system creates snapshots on a configurable interval and automatically removes the oldest backup once the maximum count is reached — your data stays safe without manual effort.

Admin GUI

Server administrators can open a global home database GUI via /adminhomes, browse every player’s homes with pagination, and manage or delete entries in real time.

PlaceholderAPI Support

Three ready-made %lirichomes_*% placeholders expose home counts, limits, and available slots to scoreboards, tab headers, holograms, and any other PlaceholderAPI-compatible plugin.

EssentialsX Integration

LiricHomes listens to EssentialsX home events, so homes created or deleted with /sethome and /delhome are reflected in the LiricHomes database instantly and automatically.

Data Migration

The built-in migration command imports all existing homes from EssentialsX into LiricHomes’ own storage in one step, making it easy to switch backends without losing player data.

GUI Interaction Reference

Inside the homes GUI, every home icon responds to multiple click types so players can do everything without leaving the menu:
InteractionAction
Left ClickTeleport to the home
Shift + Left ClickDelete the home (confirmation required)
Middle ClickSet the home icon to the item you are holding
Shift + Right ClickOpen per-home settings (rename, display name, relocate)
Middle Click to change a home’s icon requires the liric.homes.icon permission, which is granted to all players by default.

Version

LiricHomes 1.3.5 targets Paper 1.21 and requires Java 17 or newer. EssentialsX is a hard dependency; PlaceholderAPI is optional but recommended for scoreboards and holograms.