# Configuration

> Configuration reference for ML PropsCarry

Category: ITEM CARRY · Source: https://miciomods.it/docs/ml-propscarry-configuration · Last updated: 2026-07-13

## Overview

- `shared/config.lua`: Core settings, commands, editor, item definitions, bone list, theme colors

All item positions are stored per-player via KVP. No server config file.

## General

**shared/config.lua**

```lua
Config.Debug = false
Config.Locale = 'en'
Config.Theme = 'default'
Config.WeaponComponents = true
Config.FlashlightPersist = true
Config.UpdateInterval = 1000
```

- `Debug`: Console output for troubleshooting
- `Locale`: Language code for translations
- `Theme`: UI theme for editor gizmo and silhouette
- `WeaponComponents`: Render weapon attachments (scopes, suppressors, grips) on holstered weapons
- `FlashlightPersist`: Remember flashlight on/off state per weapon serial across holster/draw
- `UpdateInterval`: Milliseconds between inventory sync checks

## Commands

**shared/config.lua**

```lua
Config.Commands = {
    Edit = 'carryedit',
    Reset = 'carryreset',
    ConfigEditor = 'carryadmin',
}
```

- `Edit`: Open the position editor for an item (`/carryedit [itemName]`)
- `Reset`: Reset an item's position to default (`/carryreset [itemName]`)
- `ConfigEditor`: Open the admin config editor (`/carryadmin`, requires admin permissions)

## Position Validation

**shared/config.lua**

```lua
Config.MaxPositionOffset = 0.30
Config.MinPropDistance = 0.12
```

- `MaxPositionOffset`: Maximum allowed offset from default position per axis (meters). Prevents props being placed far from the body.
- `MinPropDistance`: Minimum distance from bone center. Prevents props being hidden inside the player model.

## Editor

**shared/config.lua**

```lua
Config.Editor = {
    PositionStep = 0.01,
    RotationStep = 1.0,
    Silhouette = { Enabled = true },
}
```

- `PositionStep`: Meters moved per keypress in the editor
- `RotationStep`: Degrees rotated per keypress
- `Silhouette.Enabled`: Show a glowing outline on the prop being edited (uses theme color)

The editor supports both a 3D gizmo (mouse drag) and keyboard controls (numpad).

## Item Definitions

Each item maps an inventory item to a 3D prop with bone attachment and per-gender offsets.

**shared/config.lua**

```lua
Config.Items = {
    {
        name = 'weapon_carbinerifle',
        prop = 'w_ar_carbinerifle',
        bone = 24818,
        isWeapon = true,
        defaultPosition = {
            male = {
                x = -0.02, y = -0.14, z = 0.13,
                rx = 0.0, ry = 2.5, rz = 5.0,
            },
            female = {
                x = 0.08, y = -0.14, z = 0.12,
                rx = 0.0, ry = 0.0, rz = 0.0,
            },
        },
    },
}
```

- `name`: Inventory item name (case-insensitive match)
- `prop`: GTA prop or weapon model name
- `bone`: GTA ped bone hash for attachment (see `Config.BoneList`)
- `isWeapon`: `true` = use weapon asset loader (supports components/tints), `false` = use standard prop
- `defaultPosition`: Separate offsets for male and female peds. `x`/`y`/`z` = position, `rx`/`ry`/`rz` = rotation in degrees

Players can customize these positions per-item using `/carryedit`. Custom positions are stored server-side in KVP.

> **TIP:** Admin Config Editor
>
> Use `/carryadmin` to add new items, pick bones and set positions from in-game. Saves go to the database and apply to every connected player live, no restart.