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 uses a small, focused set of permission nodes. Player-facing permissions default to all players, while admin and bypass permissions default to operators only. Dynamic home limits are handled through a single tiered permission pattern — no extra configuration is needed beyond assigning the right node in your permissions plugin.

Permission Reference

PermissionDefaultDescription
liric.homes.useAll playersAllows the player to open the /homes GUI.
liric.homes.iconAll playersAllows the player to change a home’s icon by Middle Clicking while holding an item.
liric.homes.bypassOpGrants unlimited homes. The player ignores both default-home-limit and any liric.homes.vip.<N> node.
liric.homes.vip.<N>Not assignedSets the player’s home limit to <N>. Replace <N> with any positive integer (e.g. liric.homes.vip.10).
liric.adminhomes.useOpAllows use of all /adminhomes commands and the admin GUI.
liric.adminhomes.backupOpAllows creating, listing, restoring, and deleting backups via /adminhomes backup.
liric.adminhomes.migrateOpAllows running /adminhomes datamigrate to import homes from EssentialsX.

Home Limit Priority

When LiricHomes calculates how many homes a player is allowed to create, it checks permissions in the following order and stops at the first match:
  1. liric.homes.bypass — if the player holds this node, they have unlimited homes (internally treated as 999).
  2. liric.homes.vip.<N> — LiricHomes scans all liric.homes.vip.* nodes the player holds and uses the highest number found. This means you can safely assign multiple tiers to a player and the largest limit always wins.
  3. default-home-limit in config.yml — the server-wide fallback for players who hold no vip node.
Home limit permissions are only evaluated when home-backend: PLUGIN is set in config.yml. In ESSENTIALS mode, limits are controlled by EssentialsX’s own essentials.sethome.multiple.<group> permission system.

Dynamic Home Limits with liric.homes.vip.<N>

The <N> suffix is a plain integer — there are no predefined group names. Any number you put there becomes the limit for players who hold that node. Common examples:
Permission NodeHome Limit
liric.homes.vip.11 home
liric.homes.vip.33 homes
liric.homes.vip.55 homes
liric.homes.vip.1010 homes
liric.homes.vip.2525 homes
liric.homes.vip.5050 homes
liric.homes.bypassUnlimited
Because LiricHomes always selects the highest value, you do not need to remove a lower-tier node before assigning a higher one.

Setting Limits with LuckPerms

Use the following commands to assign a home limit to an individual player or a group:
lp user <player> permission set liric.homes.vip.10 true
Assign liric.homes.vip.<N> to your rank groups rather than individual players. For example, give your vip group liric.homes.vip.5 and your mvp group liric.homes.vip.15. Players inherit the correct limit automatically when they are added to a group.

Admin Permission Notes

liric.adminhomes.use grants access to all /adminhomes subcommands, including reload and settings. If you want to allow trusted moderators to manage homes but not touch backups or run migrations, grant liric.adminhomes.use while keeping liric.adminhomes.backup and liric.adminhomes.migrate restricted to administrators.