SHOPPING CART

Onex

Command Palette

Search for a command to run...

MAIN SETTINGS#

The main configuration file (config/main.lua) controls debug mode, camera settings, commands, and core behavior.

Debug Mode#

config/main.lua
Config.Debug = false

Enable debug mode to see additional console output for troubleshooting.

ValueDescription
trueEnable debug logging
falseDisable debug logging (production)

Face Settings#

Configure the limits for face customization sliders:

config/main.lua
Config.FaceSettings = { face = { min = 0, max = 45 }, -- Face 1 (Father) face2 = { min = 0, max = 45 }, -- Face 2 (Mother) race = { min = 0, max = 45 } -- Race/ethnicity }
SettingMinMaxDescription
face045First parent face options
face2045Second parent face options
race045Race/ethnicity options

Clothes Toggle Functions#

Configure what happens when players toggle clothes on/off in the menu:

config/main.lua
Config.ChangeClothesState = { Cap = function(ped) ClearPedProp(ped, 0) -- Remove hat end, Glasses = function(ped) ClearPedProp(ped, 1) -- Remove glasses end, Closet = function(ped) -- Remove shirt/jacket SetPedComponentVariation(ped, 11, 15, 0, 2) SetPedComponentVariation(ped, 8, 15, 0, 2) SetPedComponentVariation(ped, 3, 15, 0, 2) end, Shoe = function(ped) SetPedComponentVariation(ped, 6, 34, 0, 2) -- Remove shoes end }

These functions are called when players click the clothes on/off toggles in the UI.

Clothes Download Command#

Enable or disable the clothes preview download command:

config/main.lua
Config.ClothesDownload = { enable = true, command = 'downloadclothes' }
OptionTypeDefaultDescription
enablebooleantrueEnable the download command
commandstring'downloadclothes'Command name to trigger download

This command downloads clothing preview images for offline use or UI customization.

Routing Bucket#

Isolate players during character creation to prevent interaction with the world:

config/main.lua
Config.Bucket = { Enable_on_First_Character = true, BucketEnable_Command = 'onex-creation:server:ChangeRoutingBucket', BucketDisable_Command = 'onex-creation:server:ResetRoutingBucket' }
OptionTypeDefaultDescription
Enable_on_First_CharacterbooleantrueUse routing bucket for new characters
BucketEnable_CommandstringeventEvent to enable bucket
BucketDisable_CommandstringeventEvent to disable bucket

Routing buckets prevent other players from seeing or interacting with a player during character creation.

Camera Offsets#

Configure camera positions for different viewing angles:

config/main.lua
Config.CameraOffsets = { [1] = { x = 0.0, y = 0.9, z = 0.65 }, -- Face view [2] = { x = 0.0, y = 1.8, z = 0.2 }, -- Full body [3] = { x = 0.0, y = 1.2, z = -0.5 }, -- Lower body [4] = { x = 0.5, y = 0.8, z = 0.3 }, -- Side view [5] = { x = -0.5, y = 0.8, z = 0.3 } -- Other side }
CameraXYZBest For
10.00.90.65Face, hair, makeup
20.01.80.2Full body overview
30.01.2-0.5Pants, shoes
40.50.80.3Left side view
5-0.50.80.3Right side view

Utility Commands#

Enable or disable utility commands and set their names:

config/main.lua
Config.UitilityCommands = { admin_creation = { active = true, command = 'acreation' }, Refreshskin = { active = true, command = 'refreshskin' }, Propfix = { active = true, command = 'propfix' } }
CommandDefault NameDescription
admin_creation/acreationOpen admin creation menu (requires group.admin)
Refreshskin/refreshskinReload player's skin from database
Propfix/propfixFix attached props/accessories

Image Scale Tree#

Configure preview image scaling and positioning for each category:

config/main.lua
Config.ImageScaleTree = { face_skin = { scale = 1.0, offsetX = 0, offsetY = 0 }, mask = { scale = 1.2, offsetX = 0, offsetY = -10 }, hair = { scale = 1.1, offsetX = 0, offsetY = -5 }, torso = { scale = 0.8, offsetX = 0, offsetY = 20 }, pants = { scale = 0.7, offsetX = 0, offsetY = 40 }, shoes = { scale = 0.9, offsetX = 0, offsetY = 50 }, -- ... more categories }
PropertyTypeDescription
scalenumberImage scale multiplier
offsetXnumberHorizontal offset in pixels
offsetYnumberVertical offset in pixels

Auto Camera Change#

Automatically switch camera angles when changing categories:

config/main.lua
Config.AutoCameraChange = { Enable = true, CategoryCameras = { face_skin = 1, mask = 1, hair = 1, torso = 2, pants = 3, shoes = 3, hat = 1, glass = 1, -- ... more mappings } }
OptionTypeDefaultDescription
EnablebooleantrueEnable automatic camera switching
CategoryCamerastablemappedCategory to camera ID mapping

When enabled, the camera automatically adjusts to show the relevant body part when switching between clothing categories.

Legacy Face Data#

Preserve old face data format for existing characters:

config/main.lua
Config.Stay_on_Old_Face_for_old_characters = true
ValueDescription
trueKeep legacy face data format for old characters
falseConvert all characters to new format

Only set to false after migrating all existing player data to the new schema.

Next Steps#