> 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/cozyhomes.md).

# CozyHomes

### What It Does

CozyHomes is a homes plugin for saving player home locations and teleporting back to them.

Players can save named homes, open a homes menu, teleport to homes, delete homes, and manage saved homes through GUI menus.

### Main Features

<table><thead><tr><th width="283.04296875">Feature</th><th>Details</th></tr></thead><tbody><tr><td>Player homes</td><td>Players can save named homes with <code>/sethome &#x3C;name></code>.</td></tr><tr><td>Home teleporting</td><td>Players can teleport with <code>/home &#x3C;name></code> or by left-clicking a home in the menu.</td></tr><tr><td>Homes GUI</td><td><code>/homes</code> and <code>/home</code> with no name open the homes menu.</td></tr><tr><td>Home management</td><td>Players can rename homes, delete homes, update a home location, favorite homes, and change home icons from the GUI.</td></tr><tr><td>Home limits</td><td>The default limit is 1 home. Numbered permissions using <code>cozyhomes.limit.</code> can raise the limit up to the configured maximum of 54.</td></tr><tr><td>Teleport warmup and cooldown</td><td>The default warmup is 3 seconds and the default cooldown is 10 seconds. Movement or damage cancels the warmup by default.</td></tr><tr><td>Protection checks</td><td>Setting or moving homes can be blocked in protected areas. GriefPrevention and WorldGuard checks are enabled by default when those plugins are installed.</td></tr><tr><td>Admin home management</td><td>Admins can open a GUI to review player homes, teleport to them, and delete them.</td></tr><tr><td>Essentials import</td><td>Admins can import homes from Essentials userdata, with a dry run option.</td></tr></tbody></table>

### Basic Admin Workflow

1. Give normal players `cozyhomes.use` if your permissions setup does not already grant default permissions.
2. Assign numbered limit permissions such as `cozyhomes.limit.3` to ranks that should have more homes.
3. Give staff or admins `cozyhomes.admin` for full admin access, or assign narrower admin permissions as needed.
4. Use `/cozyhomes info` to check current limits, teleport settings, import path, and protection status.
5. Use `/homesadmin` to review saved homes, teleport to a player's home, or delete a player's home.
6. If migrating from Essentials, run `/cozyhomes import essentials dryrun` before running the real import.

### Notes

Home names may use letters, numbers, underscores, and hyphens, up to 24 characters.

The plugin lists GriefPrevention and WorldGuard as soft dependencies. They are used only for protection checks when installed and enabled.

No Vault, PlayerPoints, PlaceholderAPI, or economy behavior was documented in the confirmed source files.

Common player use cases include saving a base, teleporting home, organizing homes in the GUI, favoriting important homes, and updating a saved home's location.

Common admin use cases include checking plugin settings, reloading config/messages, importing Essentials homes, reviewing saved homes, teleporting to a saved home for moderation, and deleting a saved home when needed.


---

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