> For the complete documentation index, see [llms.txt](https://grp-development.gitbook.io/solid-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://grp-development.gitbook.io/solid-scripts/resources/solid-chat/installation.md).

# Installation

Get SOLID Chat running on your server in a few minutes.

{% stepper %}
{% step %}
**Download the resources**

After your purchase, download `solid-chat` from [portal.cfx.re](https://portal.cfx.re) under Assets > Granted Assets.

For job and gang channels on QBCore, Qbox or ESX, also install `solid-bridge`. Without it the chat runs standalone and channels use ace permissions.
{% endstep %}

{% step %}
**Add them to server.cfg**

Start `solid-bridge` after your framework, and `solid-chat` before the resources that send chat messages. Put your own framework in place of `qb-core`.

{% code title="server.cfg" %}

```cfg
ensure qb-core
ensure solid-bridge
ensure solid-chat
```

{% endcode %}

{% hint style="info" %}
Remove `ensure chat` from your server.cfg. If you leave it in, SOLID Chat stops the default chat on start anyway, so the two never show at the same time.
{% endhint %}

{% hint style="warning" %}
Keep the folder name `solid-chat`. Other resources reach the chat through `exports['solid-chat']`.
{% endhint %}
{% endstep %}

{% step %}
**Give your staff access**

`/chatsetup` and `/clearall` use the staff check of solid-bridge, set in `BridgeConfig.Staff` in its config. Without solid-bridge, players with the `command` ace count as admins.

For the Staff tab, `/staff` and the announcement channel, add:

{% code title="server.cfg" %}

```cfg
add_ace group.admin solidchat.staff allow
add_ace group.admin solidchat.announce allow
```

{% endcode %}
{% endstep %}

{% step %}
**Restart and set it up**

Restart your server, join, and press `T` to chat. Type `/chatsetup` to open the settings panel. Every change applies to every player right away.
{% endstep %}
{% endstepper %}

#### How to update

{% stepper %}
{% step %}
**Download the new version**

The server console tells you on start when an update is out. Download it from [portal.cfx.re](https://portal.cfx.re) under Assets > Granted Assets.
{% endstep %}

{% step %}
**Replace the folder**

Delete the old `solid-chat` folder and put the new one in its place. Your settings are saved on the server, not in the files, so they stay exactly as they are.

{% hint style="info" %}
If you changed any text in the `locales` folder, copy those changes into the new files.
{% endhint %}
{% endstep %}

{% step %}
**Restart the server**

The new version is live for every player.
{% endstep %}
{% endstepper %}


---

# 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, and the optional `goal` query parameter:

```
GET https://grp-development.gitbook.io/solid-scripts/resources/solid-chat/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.