Quick Start

Basic Commands

Command	Usage	Who sees it
`/me`	`/me does something`	Nearby players (10m)
`/do`	`/do the sky is blue`	Nearby players (10m)
`/ooc`	`/ooc random talk`	Nearby players (50m)
`/msg`	`/msg 5 hello!`	Only player 5
`/twitter`	`/twitter check it out`	Everyone
`/dice`	`/dice 20`	Nearby players (15m)
`/try`	`/try to pick lock`	Nearby players, 50/50 result

Customization Examples

Disable a Command

Edit config/config.lua:

Config.Commands.dice.enabled = false

Change Command Appearance

Config.Commands.me = {
    enabled = true,
    command = "me",
    range = 15.0,      -- Increase visibility range
    badge = {
        label = 'ACTION',  -- Change badge text
        color = '#FF5555'  -- Change to red
    }
}

Create a Custom Channel

Edit config/channels.lua:

Config.Channels = {
    {
        id    = 'support',
        label = 'Support',
        color = '#27ae60',
        participants = {
            read  = { 'ALL' },
            write = { { type = 'job', value = 'support' } },  -- Only support can write
        },
    },
}

Create a Custom Template

Edit config/templates.lua:

Config.Theme['my:custom'] = T.build()
    :bg('#1a1a2e')
    :tag('CUSTOM', '#00d4ff')
    :author({ bold = true })
    :text(': ')
    :message()
    :done()

Create a Job Radio

Edit config/config.lua:

Config.JobWhisper = {
    policeRadio = {
        enabled = true,
        command = "r",
        description = "Police Radio",
        channel = 'police',
        template = T.Presets.jobWhisper('RADIO', '#3498db'),
        sender = { job = "police", grade = 0 },
        receivers = {
            { job = "police", grade = 0 },
        },
    },
}

Common Questions

Q: How do I hide player names?

A: Use /mask to toggle identity masking. Then use {Masked:...} placeholders.

Q: Can I add a command just for admins?

A: Create a channel with admin ACE permission:

{
    id = 'admin',
    label = 'Admin',
    participants = {
        read  = { { type = 'admin' } },
        write = { { type = 'admin' } },
    },
}

Q: How do I change colors?

A: Edit templates in config/templates.lua:

Config.Theme['cmd:me'] = T.build()
    :bg('#ff0000')  -- Red background
    :message({ color = '#ffff00' })  -- Yellow text
    :done()

Q: Where do job ads appear?

A: They appear in the main chat with special formatting. Configure in Config.JobAds.

Q: Can messages be logged to Discord?

A: Yes! Configure webhooks in config/log/config.lua:

Config.Webhooks = {
    ["chat"] = "https://discord.com/api/webhooks/YOUR_WEBHOOK_URL",
}

Q: How do I make a command work only nearby?

A: Set range and optionally los (line-of-sight):

Config.Commands.me = {
    range = 10.0,   -- 10 metres
    los   = true,   -- Can't see through walls
}