> ## Documentation Index
> Fetch the complete documentation index at: https://docs.awokenlabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Drop Awoken Elevators in, grant yourself the creator, and build your first lift in-game.

## Asset download

Once you buy from our official website, the asset lands in your [Cfx.re portal](https://portal.cfx.re/). Download it from there. The asset must sit on the keymaster account that made the purchase, or transfer it across first.

## What you need

<CardGroup cols={2}>
  <Card title="Required" icon="circle-check">
    **ox\_lib** and **oxmysql**. Database tables are created automatically.
  </Card>

  <Card title="Optional" icon="circle-plus">
    **ox\_target** for the button players aim at. Without it, elevators use ox\_lib's text UI instead.
  </Card>
</CardGroup>

Works on **QBox, QBCore, and ESX**, detected automatically, and **standalone** with no framework at all. A framework is only needed for job and gang restrictions.

## Install

<Steps>
  <Step title="Drop the folder in place">
    Put the **`awoken_elevators`** folder (the one from `releases/`) into your server's `resources/`. Keep the folder name exactly `awoken_elevators`.
  </Step>

  <Step title="Grant the creator permission">
    ```cfg server.cfg theme={"dark"}
    add_ace group.admin awoken_elevators.creator allow
    ```
  </Step>

  <Step title="Set the ensure order">
    ```cfg server.cfg theme={"dark"}
    ensure ox_lib
    ensure oxmysql
    ensure qbx_core            # your framework: qbx_core / qb-core / es_extended
    ensure ox_target           # optional
    ensure awoken_elevators
    ```
  </Step>

  <Step title="Start the server">
    The database tables build themselves, so **there is no SQL file to import**.
  </Step>
</Steps>

## Updating

Re-download the asset from your Cfx.re portal, replace the folder, and restart with `ensure awoken_elevators`. Your elevators live in the database, not in the folder, so updating never touches them.

<Warning>
  Replacing the folder overwrites `config/`. Back it up first if you've changed anything in there.
</Warning>

## First check

In-game, run `/elevators`. If the creator opens, you're live.

<CardGroup cols={2}>
  <Card title="Build your first elevator" icon="pen-ruler" href="/resources/awoken-elevators/creator">
    Place a lift in-game, floor by floor.
  </Card>

  <Card title="Configuration" icon="sliders" href="/resources/awoken-elevators/configuration">
    The config file, the in-game settings, and theming.
  </Card>
</CardGroup>