lation ui

lation ui (lation_ui) is the interface your other scripts call. It gives them thirteen components through client exports: notifications, a context menu, a list menu, a radial menu, alert and input dialogs, a progress bar, text UI, a timeline, a drawer, and three minigames (skill check, signal breach and pattern lock). Admins restyle all of it in game with the theme editor, players can keep a theme of their own if you allow it, and lation interact, lation banking, lation shops and lation jobs follow the same theme.

Works on Qbox, QBCore and ESX, and on servers with no framework: lation ui doesn't call one.

RequirementsCopy Anchor Link

InstallCopy Anchor Link

Follow the install guide, then:

ensure lation_ui
ensure ox_lib            # if you run it

# scripts that call exports.lation_ui go below
ensure my_script

add_ace group.admin lation_ui.admin allow

setr lation_ui:allowUserThemes 1

There is no SQL to import and nothing to add to a framework. Every option and convar is on the configuration page.

When you update, copy the new files over the old folder. The server theme lives in data/theme.json, which isn't part of the download, so it stays. If you delete the folder first, keep a copy of data/theme.json and put it back afterwards.

First startCopy Anchor Link

On start, lation ui loads the server theme from data/theme.json. On a fresh install there is no file yet, so the built-in theme is used. When Config.version is on, it also checks for a newer version and prints a notice in the console only when one is out. Players see nothing until a script calls an export.

Check it works. Run this from any client script:

Copy Text

exports.lation_ui:notify({
    title = 'Success',
    message = 'It works!',
    type = 'success'
})

In game, run /uitheme as an admin to set your server's look. Pick a preset, change the colors, corners and font, and press Save. Every player sees it at once. The theming page covers the editor.

Point your scripts at it: call the exports from your own scripts (start with shared options), or run the ox_lib fork below for scripts written for ox_lib.

Using it with ox_lib scriptsCopy Anchor Link

The lation ox_lib fork forwards lib.* interface calls to lation ui, so scripts written for ox_lib show lation ui components without code changes. Run it in place of ox_lib, with ensure lation_ui above ensure ox_lib. Scripts that don't use ox_lib call the exports directly.

lation ui also takes ox_lib-shaped data where it can: description and the inform type in notifications, option tables keyed by title in context menus, a bare list of fields in input dialogs, and a list menu shaped like lib.registerMenu.

TroubleshootingCopy Anchor Link

Next stepsCopy Anchor Link