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

# CozyRentals

### What It Does

CozyRentals manages rentable physical shop stalls for Cozy Crafters SMP.

Players can browse available stalls, rent a stall, manage their current rental, add prepaid rent, customize public stall details, and give up a stall. Staff can create and manage stall records, WorldGuard regions, rental access, rental status, and rent processing.

### Main Features

<table><thead><tr><th width="204.828125">Feature</th><th>Description</th></tr></thead><tbody><tr><td>Stall directory</td><td>Players can open a public stall directory with <code>/stalls</code> or <code>/stall rent</code>.</td></tr><tr><td>My Stall menu</td><td>Players can manage their current rented stall with <code>/rental</code> or <code>/stall mine</code>.</td></tr><tr><td>Rental confirmation</td><td>Renting uses a confirmation menu before the stall is assigned.</td></tr><tr><td>Prepaid rent deposits</td><td>Players can deposit prepaid rent when Vault economy is available and they have the required permissions.</td></tr><tr><td>Rent processing</td><td>CozyRentals can process due rent on a schedule and can also be processed manually by staff.</td></tr><tr><td>Grace and expiry</td><td>If rent cannot be paid from prepaid balance, the plugin can start a grace period and later mark the stall expired.</td></tr><tr><td>Player unrent</td><td>Players can give up a rented stall. The source confirms configurable refunds from remaining prepaid balance.</td></tr><tr><td>Stall customization</td><td>Primary renters can set a public name, description, and icon when those features are enabled.</td></tr><tr><td>Helper members</td><td>Staff can add, remove, and list helper members for rented stalls.</td></tr><tr><td>Staff admin GUI</td><td><code>/rentaladmin</code> opens an admin player status GUI for stored rental rows.</td></tr><tr><td>WorldGuard regions</td><td>Staff-created stalls are backed by WorldGuard regions when WorldGuard and WorldEdit are available.</td></tr><tr><td>Oraxen GUI visuals</td><td>Fixed GUI controls can use optional Oraxen item IDs with Bukkit material fallbacks.</td></tr><tr><td>CozyStats reporting</td><td>Optional CozyStats reporting is confirmed for rental deposits and rent paid from prepaid balance.</td></tr></tbody></table>

### Basic Admin Workflow

1. Install the required server dependencies for your setup.
2. Give players the default player permissions, or assign them through your permissions plugin.
3. Give market staff only the management permissions they need.
4. Use `/stall select` to select two corners for a stall.
5. Use `/stall create <name>` to create the stall record and WorldGuard region.
6. Use `/stall setrent <stall> <amount>` if the stall needs a custom weekly rent.
7. Use `/stall setdisplay <stall> <display name>` and `/stall setteleport <stall>` if needed.
8. Use `/stall list`, `/stall info <stall>`, `/stall audit`, and `/stall sync <stall>` to check and maintain stalls.
9. Use `/stall processrent` for a manual rent-processing pass when needed.
10. Use `/stall expired` and `/rentaladmin` to review expired or active rentals.

### Notes

* Main command: `/cozyrentals`.
* Confirmed aliases: `/rentals`, `/stall`, `/stalls`, and `/rental`.
* `/stalls` with no subcommand opens the stall directory.
* `/rental` with no subcommand opens the player's rental menu.
* `/rentaladmin` opens the admin rental status GUI.
* WorldGuard and WorldEdit are soft dependencies, but WorldGuard-backed stall creation depends on them being available.
* Vault is a soft dependency. Deposits and economy behavior require an available Vault economy provider.
* PlaceholderAPI is listed as a soft dependency and detected as an integration, but no PlaceholderAPI expansion was confirmed in source.
* QuickShop is not listed as a plugin dependency, but the default WorldGuard flags include QuickShopHikari region flags.
* Oraxen support is visual-only for configured fixed GUI controls. Player-selected stall icons still use Bukkit materials from the configured allowed list.
* PlayerPoints support was not confirmed in source.
* Lifetime payment history is not documented in source. The README states `/rentaladmin` uses current stored prepaid balance and does not fabricate lifetime payment history.

### Common Use Cases

<table><thead><tr><th width="277.15234375">Use Case</th><th>Command</th></tr></thead><tbody><tr><td>Open the public stall directory</td><td><code>/stalls</code></td></tr><tr><td>Manage your current stall</td><td><code>/rental</code></td></tr><tr><td>Add prepaid rent</td><td><code>/stall deposit</code></td></tr><tr><td>Rename your stall</td><td><code>/stall setname &#x3C;name></code></td></tr><tr><td>Set your stall description</td><td><code>/stall setdescription &#x3C;description></code></td></tr><tr><td>Give up a stall</td><td><code>/stall unrent [stall]</code></td></tr><tr><td>Create a stall from a selection</td><td><code>/stall create &#x3C;name></code></td></tr><tr><td>View stall details</td><td><code>/stall info &#x3C;stall></code></td></tr><tr><td>Assign a renter manually</td><td><code>/stall assign &#x3C;player> &#x3C;stall></code></td></tr><tr><td>Release a stall after cleanup</td><td><code>/stall release &#x3C;stall> confirm</code></td></tr><tr><td>Open the admin rental GUI</td><td><code>/rentaladmin</code></td></tr><tr><td>Reload config and messages</td><td><code>/stall reload</code></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/cozyrentals.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.