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

# CozyMarket

## CozyMarket

### What It Does

CozyMarket is a Paper plugin for Cozy Crafters that adds server market tools on top of QuickShop-Hikari.

It gives players a `/market` GUI for browsing QuickShop shops, searching listings, viewing shops by owner, creating buy orders, browsing public orders, and toggling item frame visibility.

### Main Features

<table><thead><tr><th width="236.59765625">Feature</th><th>What It Does</th></tr></thead><tbody><tr><td>Market browser</td><td>Opens a GUI for browsing QuickShop-Hikari shops.</td></tr><tr><td>Search</td><td>Lets players search market listings by item text.</td></tr><tr><td>Player shop view</td><td>Lets players browse one player's shop listings.</td></tr><tr><td>Market categories</td><td>Shows configured market categories from <code>categories.yml</code>.</td></tr><tr><td>Market Orders</td><td>Lets players create material-based buy orders and lets other players fulfil them.</td></tr><tr><td>Item frame visibility</td><td>Lets players make an existing item frame or glow item frame visible or invisible.</td></tr><tr><td>Admin tools</td><td>Provides reload, status, category audit, and shop lookup commands.</td></tr><tr><td>PlaceholderAPI support</td><td>Registers CozyMarket placeholders when PlaceholderAPI is installed.</td></tr><tr><td>CozyStats support</td><td>Reports market opens, searches, and listing clicks when CozyStats is installed and enabled.</td></tr><tr><td>Oraxen GUI icon support</td><td>Allows configured GUI/category icons to use Oraxen custom items when Oraxen is installed.</td></tr></tbody></table>

### Basic Admin Workflow

1. Install QuickShop-Hikari. CozyMarket requires it.
2. Install optional integrations only if needed: PlaceholderAPI, CozyStats, Vault, or Oraxen.
3. Give players the default player permissions, or manage them explicitly with a permissions plugin.
4. Use `/market` to confirm the market GUI opens.
5. Use `/market admin stats` or `/cozymarket-admin stats` to check plugin status.
6. Edit `config.yml`, `messages.yml`, or `categories.yml` as needed.
7. Run `/market admin reload`, `/cozymarket-admin reload`, or `/market reload` after config changes.

### Notes

* QuickShop-Hikari is required. CozyMarket disables itself if QuickShop-Hikari is missing or not enabled.
* Market Orders require Vault and a Vault economy provider. If either is missing, order commands stay unavailable.
* `/order`, `/orders`, and `/orders mine` can also be disabled with `orders.enabled`.
* Market Orders are material-based. By default, damaged items, items with extra metadata, tools, weapons, armor, shulker boxes, books, potions, suspicious stew, and player heads are blocked or rejected.
* Players cannot fulfil their own orders.
* Cancelling or expiring an order refunds only the unfulfilled remaining balance. Delivered items remain claimable.
* `/frame` only changes the visibility of an existing item frame or glow item frame the player is looking at. It does not give, spawn, replace, or edit the item inside the frame.
* The `/frame` command can be restricted by world. Players with `cozymarket.frame.admin` bypass the world restriction.
* Category-specific permissions are supported by the category file schema, but no category permission nodes are documented in the shipped `categories.yml`.

### Common Use Cases

<table><thead><tr><th width="240.85546875">Use Case</th><th>Command</th></tr></thead><tbody><tr><td>Browse all market listings</td><td><code>/market</code></td></tr><tr><td>Search for an item</td><td><code>/market search iron ingot</code></td></tr><tr><td>Browse one player's listings</td><td><code>/market player PlayerName</code></td></tr><tr><td>Create a buy order</td><td><code>/order iron ingot</code></td></tr><tr><td>Browse active buy orders</td><td><code>/orders</code></td></tr><tr><td>Manage your own orders</td><td><code>/orders mine</code></td></tr><tr><td>Hide an item frame border</td><td><code>/frame invisible</code></td></tr><tr><td>Show an item frame border again</td><td><code>/frame visible</code></td></tr><tr><td>Reload CozyMarket config and cache</td><td><code>/market admin reload</code> or <code>/cozymarket-admin reload</code></td></tr><tr><td>Check plugin status</td><td><code>/market admin stats</code> or <code>/cozymarket-admin stats</code></td></tr></tbody></table>

### Confirmed Dependencies and Integrations

<table><thead><tr><th width="181.9375">Plugin</th><th width="130.32421875">Type</th><th>Notes</th></tr></thead><tbody><tr><td>QuickShop-Hikari</td><td>Required</td><td>Used as the shop source for the market browser.</td></tr><tr><td>PlaceholderAPI</td><td>Optional</td><td>Registers <code>%cozymarket_total_shops%</code>, <code>%cozymarket_player_shops%</code>, <code>%cozymarket_last_refresh%</code>, and <code>%cozymarket_status%</code>.</td></tr><tr><td>CozyStats</td><td>Optional</td><td>Reports market opens, searches, and listing clicks when enabled.</td></tr><tr><td>Vault</td><td>Optional</td><td>Required for Market Orders escrow payments and fulfilment payouts.</td></tr><tr><td>Oraxen</td><td>Optional</td><td>Supports custom GUI/category icons for display only.</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/cozymarket.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.
