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

# Cuxial Announcements

On-screen announcements for FiveM, with one visual style per job designed in game.

Cuxial Announcements lets the members of a job send an announcement that every player sees on screen. Each job has its own style, designed by staff in an in-game panel with a live preview.

## What it does

* **One command for players.** `/anuncio <message>` sends the text with the style of the player's current job.
* **One style per job**, with its own title, logo and background image.
* **In-game style editor** with a live preview at the real screen position.
* **11 templates, 8 screen positions and 16 entry animations.**
* **Colours, fonts and effects**: gradient, animated border, shimmer, accent line, diagonal stripes and glow.
* **Sound per style**, with its own volume.
* **Cooldown per player** between announcements.
* **Queue**: announcements are shown one at a time, never on top of each other.
* **Styles saved in the database.** The table is created on first start.

## Requirements

| Resource        | Required | Used for                                         |
| --------------- | -------- | ------------------------------------------------ |
| `ox_lib`        | Yes      | Commands and callbacks                           |
| `oxmysql`       | Yes      | Stores the styles                                |
| `cuxial_bridge` | Yes      | Connects to your framework (QBox, QBCore or ESX) |

There are no optional integrations, no inventory items and no target.

## Pages

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Installation</strong></td><td>Dependencies, start order and first style.</td><td><a href="/scripts/interface/cuxial-anuncios/installation.md">Installation</a></td></tr><tr><td><strong>Configuration</strong></td><td>The options in <code>shared/config.lua</code> and what a style contains.</td><td><a href="/scripts/interface/cuxial-anuncios/configuration.md">Configuration</a></td></tr><tr><td><strong>Commands &#x26; permissions</strong></td><td>The two commands and who can use each one.</td><td><a href="/scripts/interface/cuxial-anuncios/commands.md">Commands &amp; permissions</a></td></tr><tr><td><strong>Exports &#x26; events</strong></td><td>Public API for other resources.</td><td><a href="/scripts/interface/cuxial-anuncios/developers.md">Exports &amp; events</a></td></tr><tr><td><strong>Troubleshooting</strong></td><td>Common problems and how to fix them.</td><td><a href="/scripts/interface/cuxial-anuncios/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://docs.cuxial.com/scripts/interface/cuxial-anuncios.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.