# NavItems — item shift right-click shortcuts for HuskHomes
**Summary**
Turns a few vanilla items into fast travel tools. NavItems adds concise usage **lore** to those items (without renaming) and runs HuskHomes commands on **shift + right-click**:
* **Compass** → `/warplist`
* **Recovery Compass** → `/homelist`
* **Goat Horn** → `/sethome home-` (number is global, never re-used)
* **Book** → `/phomeslist` (public homes)
---
## Features
* **Shift+Right-click while holding item to trigger**
* **Always-on instructive lore**
* **Unique home names**: `home-1`, `home-2`, `home-3`… stored in `plugins/NavItems/data.yml` so numbers never repeat across restarts.
* **Namespaced command first, fallback second** (e.g. `huskhomes:warplist` → `warplist`).
* **Light cooldown** (configurable) to prevent accidental double-fires.
* `/navitems [player]` helper command to hand out the four items (with lore).
---
## Dependencies
* **Required:** **HuskHomes** https://modrinth.com/plugin/huskhomes (the commands this plugin runs come from HuskHomes).
* **Required:** **Updated HuskHomes GUI** https://modrinth.com/plugin/updated-huskhomesgui — if missing, it will only list warps and homes by triggering `/warplist`, `/homelist`, or `/phomeslist`
> Players still need the relevant HuskHomes permissions to use the lists or set homes. NavItems only triggers the commands; HuskHomes handles access.
---
## Commands & permissions
**Commands**
* `/navitems [player]` — gives Compass, Recovery Compass, Goat Horn, Book (all with usage lore)
**Permissions**
* `navitems.use` — allow using the items (right-click actions)
* `navitems.give` — allow `/navitems` (default: op)
Example (LuckPerms):
```
/lp group default permission set navitems.use true
/lp user permission set navitems.give true
```
---
## Configuration
`plugins/NavItems/config.yml`
```yaml
commands:
warplist: "huskhomes:warplist"
homelist: "huskhomes:homelist"
phomeslist: "huskhomes:phomeslist"
sethome: "huskhomes:sethome %name%"
homeNamePrefix: "home-"
cooldownMs: 600
```
* Change the command strings or the name prefix if you like.
* Namespaced commands ensure HuskHomes is targeted even if other plugins add similar commands.
---
## Compatibility
* **Server:** Paper / Purpur (Paper recommended)
* **Minecraft:** 1.21.x
* **Java:** 21
---
## Installation
1. Drop the JAR into `/plugins`.
2. Start the server once (generates `config.yml` & `data.yml`).
3. Grant `navitems.use` (and, if desired, `navitems.give`).
4. (Optional) Install the **updated unofficial HuskHomes GUI** to get menu UIs for the lists.
---
## FAQ
**Does this rename items?**
No — only lore is added. Names remain vanilla.
**What if another plugin uses these items too?**
NavItems cancels the interaction after firing the command and has a short cooldown. You can also withhold `navitems.use` from groups that shouldn’t trigger it.
**Can I map different items or commands?**
Yes — edit `config.yml`. The code is small and easy to extend if you want deeper customization.
---
## Changelog (latest)
**1.2.0**
* Right-click actions for Compass / Recovery Compass / Goat Horn / Book
* Always-on lore for those vanilla items
* Global, persistent `home-` naming
* Namespaced HuskHomes commands with fallback
* `/navitems` helper command