> For the complete documentation index, see [llms.txt](https://rayn-scripts.gitbook.io/rayn-scripts-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rayn-scripts.gitbook.io/rayn-scripts-docs/rayn_description/overview.md).

# Overview

Character descriptions and place descriptions left in the world – one clean panel, synced to every nearby player.

Give your roleplay more detail. **rayn\_description** lets players describe their character and leave descriptions of places anywhere in the world – everything managed from one clean, modern panel.

* **Character descriptions** – `/desc` and describe what others can see: appearance, injuries, clothes, smell. The text is shown on the character's body for every nearby player.
* **Place descriptions** – `/scene`, write a text, aim at the spot and press **E**. A live preview shows exactly where it will appear.

The resource is standalone – it works with ESX, QBCore, Qbox or without a framework.

## Where to go next

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-list-check" style="color:$primary;">:list-check:</i></h3></td><td><strong>Requirements</strong></td><td>What your server needs.</td><td><a href="/rayn-scripts-docs/rayn_description/requirements.md">Requirements</a></td></tr><tr><td><h3><i class="fa-rocket" style="color:$primary;">:rocket:</i></h3></td><td><strong>Installation</strong></td><td>Get rayn_description running.</td><td><a href="/rayn-scripts-docs/rayn_description/installation.md">Installation</a></td></tr><tr><td><h3><i class="fa-user" style="color:$primary;">:user:</i></h3></td><td><strong>Character descriptions</strong></td><td>How players describe their character.</td><td><a href="/rayn-scripts-docs/rayn_description/character-descriptions.md">Character descriptions</a></td></tr><tr><td><h3><i class="fa-location-dot" style="color:$primary;">:location-dot:</i></h3></td><td><strong>Place descriptions</strong></td><td>Leave descriptions in the world.</td><td><a href="/rayn-scripts-docs/rayn_description/place-descriptions.md">Place descriptions</a></td></tr><tr><td><h3><i class="fa-sliders" style="color:$primary;">:sliders:</i></h3></td><td><strong>Configuration</strong></td><td>Every option in config.lua.</td><td><a href="/rayn-scripts-docs/rayn_description/configuration.md">Configuration</a></td></tr><tr><td><h3><i class="fa-circle-question" style="color:$primary;">:circle-question:</i></h3></td><td><strong>Troubleshooting</strong></td><td>Fixes for the most common issues.</td><td><a href="/rayn-scripts-docs/rayn_description/troubleshooting.md">Troubleshooting</a></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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://rayn-scripts.gitbook.io/rayn-scripts-docs/rayn_description/overview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.