> ## Documentation Index
> Fetch the complete documentation index at: https://pumpkings.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# LiricHomes Permissions: Home Limits and Admin Nodes

> Full list of LiricHomes permission nodes, how dynamic home limits work with the liric.homes.vip pattern, and the bypass and admin permissions.

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

| Permission                 | Default      | Description                                                                                                 |
| -------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------- |
| `liric.homes.use`          | All players  | Allows the player to open the `/homes` GUI.                                                                 |
| `liric.homes.icon`         | All players  | Allows the player to change a home's icon by Middle Clicking while holding an item.                         |
| `liric.homes.bypass`       | Op           | Grants unlimited homes. The player ignores both `default-home-limit` and any `liric.homes.vip.<N>` node.    |
| `liric.homes.vip.<N>`      | Not assigned | Sets the player's home limit to `<N>`. Replace `<N>` with any positive integer (e.g. `liric.homes.vip.10`). |
| `liric.adminhomes.use`     | Op           | Allows use of all `/adminhomes` commands and the admin GUI.                                                 |
| `liric.adminhomes.backup`  | Op           | Allows creating, listing, restoring, and deleting backups via `/adminhomes backup`.                         |
| `liric.adminhomes.migrate` | Op           | Allows 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.

<Note>
  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.
</Note>

## 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 Node      | Home Limit |
| -------------------- | ---------- |
| `liric.homes.vip.1`  | 1 home     |
| `liric.homes.vip.3`  | 3 homes    |
| `liric.homes.vip.5`  | 5 homes    |
| `liric.homes.vip.10` | 10 homes   |
| `liric.homes.vip.25` | 25 homes   |
| `liric.homes.vip.50` | 50 homes   |
| `liric.homes.bypass` | Unlimited  |

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:

<CodeGroup>
  ```bash Player theme={null}
  lp user <player> permission set liric.homes.vip.10 true
  ```

  ```bash Group theme={null}
  lp group vip permission set liric.homes.vip.10 true
  ```

  ```bash Bypass (unlimited) theme={null}
  lp user <player> permission set liric.homes.bypass true
  ```
</CodeGroup>

<Tip>
  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.
</Tip>

## 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.
