Documentation

Installation Steps

Step 1: Install dependencies

tc_keys requires the following dependencies:

ox_lib - UI and callback system
tc_lib - Ticker Scripts unified library
oxmysql - Database system (required by tc_lib)

💭 Note: tc_lib must be configured with your framework before installing tc_keys. See the tc_lib documentation for configuration.

Step 2: Download the Script

Download tc_keys from CFX.re Portal or your purchase platform.

Step 3: Add to Resources

Place tc_keys in your resources folder. We recommend organizing Ticker Scripts together:

resources/
├── oxmysql
├── ox_lib
├── [libs]/
│   └── tc_lib/
├── [tc]/
│   └── tc_keys/    <-- Place here

Step 4: Configure Items

tc_keys uses the following items that must be added to your inventory system:

main.lua

-- For ox_inventory, add these to ox_inventory/data/items.lua
['vehicle_key'] = {
    label = 'Vehicle Keys',
    weight = 1,
    stack = false,
    close = true,
    description = "Keys to a vehicle.",
    server = {export = "tc_lib.useItem"}
},
['key'] = {
    label = 'Keys',
    weight = 1,
    stack = false,
    close = true,
    description = "Keys to a door or property.",
    server = {export = "tc_lib.useItem"}
},
['lockpick'] = {
    label = 'Lockpick',
    weight = 160,
    server = {export = 'tc_lib.useItem'}
},
['hotwire_kit'] = {
    label = 'Hotwire Kit',
    weight = 1,
    stack = false,
    close = true,
    description = "Kit for hotwiring vehicles.",
    server = {export = "tc_lib.useItem"}
},
['job_door_key'] = {
    label = 'Job Door Key',
    weight = 1,
    stack = false,
    close = true,
    description = "Keys to a job-based door or property.",
    server = {export = "tc_lib.useItem"}
}

✅ Tip: Item images are included in the _INSTALL/images/ folder. Copy them to your inventory resource's images folder.

Step 5: Configure server.cfg

Add tc_keys to your server.cfg, ensuring dependencies are started first:

main.cfg

# Dependencies
ensure oxmysql
ensure ox_lib
ensure [libs]

# Ticker Scripts
ensure [tc]

Step 6: First Run

On first startup, tc_keys will automatically:

Create the tc_keys_door_locks database table
Initialize the door lock system
Set up all necessary exports

⚠️ Important: All doors are locked by default on server restart for security.

That's it! You're ready to start using tc_keys.

PreviousOverview NextConfiguration

Ticker Scripts Documentation