Configuration
Everything lives in one open file:
- crm-config.lua
An optional last argument on most exports is the template number. If you omit it, the value from this file is used.
crm_config.crm_debug = false
crm_config.crm_test = falseSet crm_test to true and use /testuipack in-game to preview every component.
Language
crm-uipack has its own locale convar (it does not use crm-core:language):
setr crm-uipack:language "en"| Code | Language |
|---|---|
en | English |
fr | French |
bg | Bulgarian |
de | German |
es | Spanish |
hu | Hungarian |
it | Italian |
ar | Arabic |
nl | Dutch |
pt | Portuguese |
ro | Romanian |
Edit wording in crm-locales/crm-<code>.json. Change values only — keep the keys.
Notify
Templates 1–4. Positions: top-left, top, top-right, middle-left, middle, middle-right, bottom-left, bottom, bottom-right (center-* is an alias of middle-*).
Types are defined in crm_config.crm_notify.crm_types. Each type has a title, Font Awesome icon and an RGB colour. You can also set per-type crm_template, crm_position or crm_duration.
crm_config.crm_notify = {
crm_template = 1,
crm_position = 'top-right',
crm_duration = 3000,
crm_show_duration = true,
crm_max = 5,
crm_types = {
primary = { crm_title = 'Info', crm_icon = 'fa-solid fa-circle-info', crm_color = '255, 176, 96' },
success = { crm_title = 'Success', crm_icon = 'fa-solid fa-check-double', crm_color = '41, 207, 103' },
error = { crm_title = 'Error', crm_icon = 'fa-solid fa-circle-xmark', crm_color = '218, 55, 60' },
warning = { crm_title = 'Warning', crm_icon = 'fa-solid fa-triangle-exclamation', crm_color = '251, 209, 40' },
phone = { crm_title = 'Phone', crm_icon = 'fa-solid fa-phone', crm_color = '72, 149, 239' },
bank = { crm_title = 'Bank', crm_icon = 'fa-solid fa-building-columns', crm_color = '46, 204, 113' },
job = { crm_title = 'Job', crm_icon = 'fa-solid fa-briefcase', crm_color = '155, 89, 182' },
-- add your own keys here
},
}Use the type key on notify() as crm_type — see Exports.
Other components
| Component | Templates | Notes |
|---|---|---|
| Text UI | 1–4 | Positions: left, right, top, bottom |
| Progress | 1–4 | Always bottom-center. progressBar and progressCircle share this UI |
| Skill check | 1 ring / 2 bar | crm_duration is the fail timeout in ms if the key is not pressed (default 3500) |
| Alert | 1 center / 2 compact | |
| Input | 1 compact / 2 full-height | Positions: mid, left, right |
| Context | 1 compact (centered) / 2 full-height | Template 2 positions: left, right |
| Keyboard menu | 1 | Positions: top-left, top-right, bottom-left, bottom-right. No mouse cursor |