Cuxial Screens turns monitors and TVs of the world into screens players can use. Walking up to one and pressing the interaction key opens Cuxial OS, a desktop with windows, apps and per-character files, drawn on the model itself.
It runs on QBox, QBCore and ESX through Cuxial Bridge. It comes included with Cuxial Casino, where it powers the boss computer, but it is a standalone script and works on its own.
What it does
- Screens in the world. Any model with a screen face listed in
data/models.luacan be a screen: a prop the script creates, or a monitor that is already part of a map. Five monitors are included, one per aspect ratio (16:9, 21:9, 16:10, 4:3 and 9:16). - Cuxial OS. Boot animation, sign-in screen, desktop with movable icons, taskbar, Start menu, notifications, resizable windows with snapping and keyboard shortcuts.
- Built-in apps. Files (plain and rich text documents), Notes, Calculator, Browser and Settings. Files and notes are saved per character in the database.
- Browser with an allow list. Only the sites you define can be opened: pages built from blocks (headings, text, lists, tables, notices, links, images) or external
https://sites. - Personal settings. Light and dark theme, accent colour, wallpaper and system volume, saved per character.
- PIN lock. A screen can ask for a PIN to sign in, with a lockout after a number of failed attempts.
- Access by job, grade and boss. Each screen can be limited to jobs with a minimum grade and, optionally, to bosses. Apps can also be limited by gang. Staff can always enter.
- Apps from other resources. Any resource can add its own app to Cuxial OS. It opens in a window, follows the theme and talks to its server through the screen session.
- Mirror mode. Nearby players can watch on the same screen what its user is doing, read only. Screens can also show the mirror of another screen, like a wall display or a projector.
- Staff panel.
/screensadminplaces screens in the world, sets who can use them, which apps they show and their PIN, and edits the system settings and the browser sites live.
Requirements
| Resource | Required | Used for |
|---|---|---|
| OneSync | Yes | Declared as a dependency |
ox_lib | Yes | Callbacks, commands, translations |
oxmysql | Yes | Profiles, files, notes, placed screens, settings and the staff log |
cuxial_bridge 2.22.1 or later | Yes | Framework, target and the API other resources use to add apps and screens |
| Framework | Yes | One of qbx_core (QBox), qb-core (QBCore) or es_extended (ESX) |
| Target | Yes | sleepless_interact, ox_target or qb-target, through Cuxial Bridge |
object_gizmo | No | The Place button of the staff panel, to move a new screen with a gizmo. Without it, use Here or Find on map |
Pages
InstallationDependencies, start order, the database and your first screen.ConfigurationEvery option of
shared/config.lua and the files in data/.Commands & permissionsStaff commands, keys and the Cuxial OS shortcuts.Exports & eventsRegister screens and apps from your resources, and the kit for app pages.TroubleshootingCommon problems and how to fix them.