> For the complete documentation index, see [llms.txt](https://docs.cozycrafters.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cozycrafters.net/plugin-docs/cozyclaims.md).

# CozyClaims

## CozyClaims

### What It Does

CozyClaims is a GUI companion addon for GriefPrevention. GriefPrevention remains the source of truth for claim data; CozyClaims provides menus and helper actions for common claim tasks.

Players open the claims menu with `/claims`. Staff open the admin menu with `/claimsadmin`.

### Main Features

* Main claims menu with claim tool, claim list, current claim, trust, tutorial, and claim block options.
* My Claims menu for browsing, searching, sorting, and opening a player's own claims.
* Current Claim actions for the claim the player is standing in.
* Claim teleport button, if enabled in config.
* Claim border display button, if enabled in config.
* Claim rename, pin, and icon selection helpers.
* Trust menus for adding, viewing, and removing trusted players.
* Claim block information menu.
* Tutorial menu that explains the basic GriefPrevention claim flow.
* Admin menu for reload, stale claim-name cleanup, player browsing, and claim inspection.
* Optional GPFlags or GriefPreventionFlags claim flag menu, if the integration is available and enabled.
* Optional BanFromClaim claim ban menu, if the integration is available and enabled.
* Optional Oraxen display item support for configured GUI items.
* Admin action logging for completed admin menu actions.

### Basic Admin Workflow

1. Install and configure GriefPrevention. CozyClaims is designed to work as a companion to it.
2. Give normal players `cozyclaims.use` and the feature permissions you want them to access.
3. Use `/claimsadmin` to open the admin menu.
4. Use `/claimsadmin reload` after changing CozyClaims config or messages.
5. Use `/claimsadmin inspect <player>` or the admin player list to review a player's claims.
6. If GPFlags or BanFromClaim features are used, confirm the matching external plugin and permissions are configured too.

### Notes

* GriefPrevention is listed as a soft dependency, but the default config requires it before the claims menu opens.
* CozyClaims does not replace GriefPrevention claim storage or claim rules.
* The `/claims` command is player-only.
* `/claimsadmin` without arguments opens the admin menu, but only for players with `cozyclaims.admin`.
* Admin inspect is read-only for claim flags in the source defaults.
* BanFromClaim actions can also require `bfc.ban`, `bfc.unban`, or `bfc.list` when `banfromclaim.use-player-permissions` is enabled.
* GPFlags actions can also require matching `gpflags.flag.<flag>` permissions or `gpflags.*` when `flags.yml` uses player permissions.
* `/claim` is not registered in the confirmed source. The confirmed player command is `/claims`, with aliases `/claimmenu` and `/claimhelp`.

### Common Use Cases

<table><thead><tr><th width="274.39453125">Use Case</th><th>How CozyClaims Helps</th></tr></thead><tbody><tr><td>Player wants to manage claims</td><td>Open <code>/claims</code>, then use My Claims or Current Claim.</td></tr><tr><td>Player needs a claim tool</td><td>Use the Claim Tool button in the claims menu, if enabled.</td></tr><tr><td>Player wants to trust someone</td><td>Open <code>/claims</code>, choose Trust Players, select a claim, then add trust.</td></tr><tr><td>Player wants to find a claim</td><td>Use My Claims search and sort, if enabled.</td></tr><tr><td>Player wants to rename or mark a claim</td><td>Open a claim's actions menu, then use Rename, Pin, or Change Icon.</td></tr><tr><td>Staff need to inspect claims</td><td>Use <code>/claimsadmin inspect &#x3C;player></code> or the admin player list.</td></tr><tr><td>Staff changed config or messages</td><td>Run <code>/claimsadmin reload</code>.</td></tr><tr><td>Staff need to remove stale CozyClaims claim names</td><td>Run <code>/claimsadmin cleanupnames</code> or use the admin menu cleanup button.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.cozycrafters.net/plugin-docs/cozyclaims.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
