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 exposes two root commands: /homes for players and /adminhomes for administrators. Most day-to-day interactions happen through the GUI itself rather than typed commands, but administrators have a rich set of subcommands for managing backups, migrating data from EssentialsX, and tweaking settings in-game.
Player Commands
| Command | Aliases | Description | Permission |
|---|
/homes | /home | Opens the interactive homes GUI for the current player. | liric.homes.use |
/homes is the only command players need. All teleportation, deletion, icon changes, and rename operations happen through clicks inside the GUI.
Admin Commands
All /adminhomes subcommands require the liric.adminhomes.use permission unless a more specific permission is noted. By default this permission is granted to operators only.
General
| Command | Description |
|---|
/adminhomes | Opens the global home database GUI. Displays every home from every player with paginated navigation. |
/adminhomes <player> | Opens a focused GUI showing only the specified player’s homes. Allows viewing, deleting, and managing individual entries. |
/adminhomes settings | Opens the in-game settings panel where you can adjust database behaviour and home limits visually without editing config.yml directly. |
/adminhomes reload | Reloads all YAML configuration files — config.yml, messages.yml, and all menu files — without a server restart. |
Backup Commands
Backup commands require the liric.adminhomes.backup permission (default: op).
| Command | Description |
|---|
/adminhomes backup create [name] | Creates a manual backup immediately. If you omit [name], a timestamp-based name is generated automatically. |
/adminhomes backup list | Lists all available backups along with their creation dates. |
/adminhomes backup <name> | Restores the named backup. Existing home data is replaced with the backup’s contents. A server reload is recommended after restoring. |
/adminhomes backup delete <name> | Permanently deletes the named backup. This action cannot be undone. |
Restoring a backup overwrites all current home data in the database. Always create a fresh backup with /adminhomes backup create before restoring an older one if you want to preserve the current state.
Data Migration
| Command | Description | Permission |
|---|
/adminhomes datamigrate Essentials | Imports all homes from EssentialsX into the LiricHomes database. | liric.adminhomes.migrate |
Data migration is only available when home-backend: PLUGIN is set in config.yml. If you are running home-backend: ESSENTIALS, the command will return an error instructing you to switch modes first.
GUI Interactions
While not typed commands, the following click interactions act as the primary interface for players inside the /homes GUI:
| Interaction | Action |
|---|
| Left Click | Teleport to the home immediately. |
| Shift + Left Click | Open a confirmation menu before deleting the home. |
| Middle Click | Set the home’s icon to the item currently in your main hand. Requires liric.homes.icon. |
| Shift + Right Click | Open the per-home settings panel to rename the home, change its display name, or relocate it to your current position. |
| Slot | Button |
|---|
| 45 (bottom-left) | Previous Page — a red arrow |
| 53 (bottom-right) | Next Page — a green arrow |
The GUI uses a 6-row (54-slot) chest layout. Navigation arrows are fixed at slots 45 and 53, leaving the remaining slots for home icons. When you have more homes than fit on one page, use the arrows to move between pages.
