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

# Installation

Installation of Crystal Bridge

{% hint style="info" %}
**Warning**

The resource folder must be named exactly `crystal_bridge` for the script and its exports to function correctly. Do not rename it!

This resource was tested on server artifacts `28954` and may not work correctly on older builds.
{% endhint %}

#### 🔍 Before you start

Before proceeding with the installation, make sure you have all the necessary [dependencies](/crystal-studios-docs/crystal-bridge/dependencies.md) installed and updated on your server.

#### 🛠️ Installation Steps

{% stepper %}
{% step %}

#### **Place the resource**

Drop the `crystal_bridge` folder into your server's `resources` directory.
{% endstep %}

{% step %}

#### **Configure your server.cfg**

Open your `server.cfg` file. It is crucial to start the bridge **AFTER** your core framework but **BEFORE** any other scripts that rely on it.

Ensure your load order looks like this:

```cfg
ensure qb-core # or es_extended / qbx_core
ensure qb-inventory # or ox_inventory
ensure crystal_bridge
```

{% 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://crystal-studios.gitbook.io/crystal-studios-docs/crystal-bridge/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.