> ## 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

> One tablet, many apps. Install the platform every Awoken tablet app plugs into.

Awoken Tablet is the device your players carry and the platform other scripts add apps to. On its own it ships three apps: **Groups**, **Notifications** and **Settings**. Everything else arrives as an app from another resource, such as [Awoken Courier](/resources/awoken-courier/installation).

## 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**, **oxmysql**, **ox\_inventory** and [**Awoken Bridge**](/resources/awoken-bridge/installation).
  </Card>

  <Card title="Optional" icon="circle-plus">
    **ox\_target** for the SD reader install point. Without it the point falls back to a marker and an `[E]` prompt.
  </Card>
</CardGroup>

Works on **QBox, QBCore and ESX**. Which one you run is answered by Awoken Bridge, so there is nothing to set here.

<Note>
  ox\_inventory is not a choice for this resource. The SD card slots are an ox\_inventory stash, so the tablet needs it even though the rest of our scripts go through the bridge.
</Note>

## Install

<Steps>
  <Step title="Drop the folder in place">
    Put the **`awoken_tablet`** folder into your server's `resources/`. Keep the folder name exactly `awoken_tablet`: apps call its exports by that name.
  </Step>

  <Step title="Set the ensure order">
    ```cfg server.cfg theme={"dark"}
    ensure ox_lib
    ensure oxmysql
    ensure ox_inventory
    ensure awoken_bridge
    ensure awoken_tablet
    ensure awoken_courier      # every tablet app goes below the tablet
    ```
  </Step>

  <Step title="Add the tablet item">
    Open `install/ox_inventory/items.lua` in the resource and paste the `awoken_tablet` entry into your `ox_inventory/data/items.lua`, inside the table that holds the rest of your items.

    ```lua ox_inventory/data/items.lua theme={"dark"}
    ['awoken_tablet'] = {
        label       = 'Tablet',
        weight      = 200,
        stack       = false,
        close       = true,
        description = 'A sleek personal tablet.',
        client      = {
            export = 'awoken_tablet.useItem',
        },
    },
    ```

    The `client.export` line is what makes using the item open the tablet. Leave it as it is.
  </Step>

  <Step title="Copy the item image">
    Copy `install/ox_inventory/images/awoken_tablet.png` into `ox_inventory/web/images/`.
  </Step>

  <Step title="Restart and test">
    Restart the server. The database tables create themselves on first start, so there is no SQL to run.

    Give yourself the item and use it:

    ```text theme={"dark"}
    /giveitem <yourId> awoken_tablet 1
    ```
  </Step>
</Steps>

## SD cards

The same install folder carries a second item, `awoken_tablet_sd`, the tablet with a card reader fitted. It is only needed if you leave `Config.SdCards.enabled = true`, which is the default.

See [SD cards](/resources/awoken-tablet/sd-cards) for what they are and the two extra steps to set them up.

## Updating

Re-download the asset from your Cfx.re portal, replace the folder, and restart.

<Warning>
  Replacing the folder overwrites `config/config.lua`. Back it up first.
</Warning>

## Next steps

<CardGroup cols={2}>
  <Card title="Configuration" icon="sliders" href="/resources/awoken-tablet/configuration">
    How it opens, the theme, wallpapers, groups and the HUD.
  </Card>

  <Card title="SD cards" icon="sd-card" href="/resources/awoken-tablet/sd-cards">
    Unlock apps with cards that live inside the tablet.
  </Card>

  <Card title="Exports" icon="code" href="/resources/awoken-tablet/exports">
    Notifications, the HUD and groups from your own scripts.
  </Card>

  <Card title="Building an app" icon="cubes" href="/resources/awoken-tablet/building-an-app">
    Add your own app to the home screen.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.