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

# Modern UI - Installation

> Step by step instructions to install this resource

<Steps>
  <Step title="Add to 'resources' directory" stepNumber={1}>
    Extract the `lation_ui` zip folder directly into the root `resources` directory of your server.

    <Warning>
      Do not place this resource in a `[subfolder]` - it should be placed directly in the root.
    </Warning>
  </Step>

  <Step title="Update server.cfg" stepNumber={2}>
    Open your `server.cfg` and add `ensure lation_ui` before *all* other resources; including your framework & `ox_lib` itself!

    ```text theme={null}
    ensure lation_ui
    ensure ox_lib
    ensure qbx_core
    ensure [standalone]
    .. etc
    ```
  </Step>

  <Step title="Add ACE permissions" stepNumber={3}>
    Open your `server.cfg` and add the following ACE permission:

    ```text theme={null}
    add_ace group.admin lation_ui.admin allow
    ```

    This grants admins access to the `/uitheme` command, which opens the in-game theme editor used to style the UI server-wide.

    <Warning>
      If you are on the Qbox framework, the recommended place to paste the above permission is inside the `permissions.cfg` file instead of `server.cfg`.
    </Warning>
  </Step>

  <Step title="Allow player themes" stepNumber={4}>
    <Info>
      This is an optional step.
    </Info>

    If you would like to allow players to personalize their own UI with the `/uisettings` command, add the following convar to your `server.cfg`:

    ```cfg theme={null}
    setr lation_ui:allowUserThemes 1
    ```

    Player themes are stored client-side per player - no database required. Anything a player doesn't customize inherits from your server theme.
  </Step>

  <Step title="Use our ox_lib" stepNumber={5}>
    <Check>
      This is an optional but highly recommended step!
    </Check>

    We maintain an official fork of ox\_lib that's identical to the original, but with one enhancement: automatic Modern UI detection. When Modern UI is installed, it uses it. When it's not, it works exactly like standard ox\_lib - no configuration needed!

    <Icon icon="palette" /> **Beautiful UI** - *Automatic Modern UI styling is used when detected*\
    <Icon icon="rotate" /> **Drop-in Replacement** - *Works identical to standard ox\_lib; because it is!*\
    <Icon icon="rocket" /> **Zero Coding** - *Automatically detects & switches to Modern UI*\
    <Icon icon="wrench" /> **Always Updated** - *Regularly syncs with official ox\_lib releases*

    <Card title="ox_lib" icon="download" href="https://github.com/IamLation/ox_lib/releases/latest" cta="Download Now" />
  </Step>

  <Step title="Restart server" stepNumber={6}>
    Finally, perform a full server restart. Failure to perform a full restart after installation will cause errors.
  </Step>
</Steps>

<Note>
  Once completed, use the command `/uitheme` in-game to style the UI to match your server!
</Note>
