Setup and Installation Guide

This guide explains how to correctly install and configure C7 Framework V3 on your FiveM server. Follow each step carefully to ensure the framework loads and functions as intended.

1. Requirements

Before installing the framework, ensure your server meets the following:

• Latest recommended FiveM artifacts

• OxMySQL installed and running (support for other database scripts is coming soon)

• A MySQL database (MariaDB recommended)

• C7-Notifications installed (for popup support) - you can download this for free on our tebex shop.

2. Download the Bundled Resource

1

Download the latest release of the C7 Framework V3

This folder should contain:

• c7-scripts-framework-v3;

2

Download the latest release of C7 Notifications

You can download this for free on our tebex shop.

3

Download the latest release of other modules

If you want the other modules: Chat, Jail, Scoreboard, and Blips, you can download them from your portal seperately.

4

Extract the .zip file's

5

Place the folders into your server's resource directory

Your resources folder should look like the following:

resources/
└── [c7-scripts]
    └── c7-scripts-framework-v3
    └── c7-scripts-chat (optional module)
    └── c7-scripts-jail (optional module)
    └── c7-scripts-blips (optional module)
    └── c7-scripts-scoreboard (optional module)
    └── c7-scripts-notifications (required/dependency)

You should not change the name of the folders as this will prompt errors. Keep it as what it comes as.

3. Add to server.cfg

Add the following line to your server.cfg, preferably after your MySQL and connection resources:

ensure oxmysql
ensure c7-scripts-notifications (start first)
ensure c7-scripts-framework-v3 (start second)
ensure c7-scripts-chat (start third)
ensure c7-scripts-blips (start fourth)
ensure c7-scripts-jail (start fifth)
ensure c7-scripts-scoreboard 

4. Configuring the scripts to the framework

c7-scripts-framework-v3 (config.lua):

Open c7-scripts-framework-v3/config/config.lua and adjust the settings:

Core Settings

• Max character slots

• Nearest postal script

• Departments

• Genders

• Permissions (optional Discord role enforcement)

• Discord configuration

• Theme colours

• Spawn locations

• Webhook URLs

c7-scripts-chat

Click here to view the documentation for this script.

This script is also sold separately. Click here to view listing.

c7-scripts-blips (config.lua):

Open c7-scripts-blips/config/config.lua and adjust the settings to match your framework's departments:

-- ============================================================
--  DEPARTMENT DEFINITIONS
-- ============================================================
-- NOTE:
--
-- lawEnforcement = true  → This department is tracked
-- canSeeLawEnforcement   → They can see LE blips
-- excludeDepartments     → Specific departments they cannot see
-- colour                 → Blip colour (GTA colour index)
-- ============================================================

Config.DepartmentSettings = {

    ["LSPD"] = {
        lawEnforcement       = true,
        canSeeLawEnforcement = true,
        excludeDepartments   = {},
        colour               = 29 -- blue
    },

    ["BCSO"] = {
        lawEnforcement       = true,
        canSeeLawEnforcement = true,
        excludeDepartments   = {},
        colour               = 5 -- light brown/tan
    },

    ["SAHP"] = {
        lawEnforcement       = true,
        canSeeLawEnforcement = true,
        excludeDepartments   = {},
        colour               = 46 -- dark blue
    },

    ["SAFR"] = {
        lawEnforcement       = true,
        canSeeLawEnforcement = true,
        excludeDepartments   = {},
        colour               = 46 -- dark blue
    },

    ["Civilian"] = {
        lawEnforcement       = false,
        canSeeLawEnforcement = false,
        excludeDepartments   = {},
        colour               = 4
    }
    
}

c7-scrips-jail (config.lua):

Open c7-scripts-jail/config/config.lua and adjust the settings to match your framework's departments:

-- ==============================
-- FRAMEWORK CONFIGURATION
-- ==============================

-- === STANDALONE MODE ===
Config.use_Standalone_Framework = false  -- Set to true to use standalone permissions, must have "use_C7Framework" set to false to work.
Config.use_Ace_Permission = false        -- If true, players must have ACE permission "command.jailMenu"
                                         -- If false, anyone can open the jail menu when Standalone is enabled
-- === C7FW FRAMEWORK MODE ===
Config.use_C7Framework = true
Config.C7_Allowed_Departments = {
    "LSPD",
    "BCSO",
    "SAHP",
}

c7-scripts-scoreboard (config.lua):

Open c7-scripts-scoreboard/config/config.lua and adjust the settings to match your framework's departments:

-- =========================================================
-- Keybind
-- =========================================================
Config.keybindInputType = "MOUSE_BUTTON"
Config.keybind = "MOUSE_MIDDLE" 

-- =========================================================
-- Server / UI Info
-- =========================================================
Config.ServerName    = "C7 SCRIPTS PLAYER LIST"
Config.ServerSubtitle = "Patrol Server #1"
Config.AOP           = "City of Scripts"

Config.MaxPlayersOverride = 0 -- If 0, will use sv_maxclients convar.

Config.HeaderImage = "https://cdn.c7hghs.co.uk/u/SYPmn9.png" -- change to any banner you want
Config.DiscordLink = "https://discord.c7scripts.com" -- Optional Discord link shown at bottom
Config.DepartmentFallback = "Civilian" -- Fallback department if framework data not available

Config.DeptColors = {
    ["LSPD"] = "#4c8bf5",
    ["SAHP"] = "#e1c16e",
    ["BCSO"] = "#d4af37",
    ["Fire"] = "#e74c3c",
    ["Civilian"] = "#bdc3c7",
}

5. Database Setup

C7 Framework V3 handles most data automatically. However, ensure:

• OxMySQL is connected

• Your database is reachable

• No other scripts override character data

• Your server’s license and identifiers are visible in playerConnecting

You must install c7_fw_characters.sql into your database for this to all work.

6. Starting the Framework

Restart your server or run:

refresh
ensure oxmysql
ensure c7-scripts-notifications (start first)
ensure c7-scripts-framework-v3 (start second)
ensure c7-scripts-chat (start third)
ensure c7-scripts-blips (start fourth)
ensure c7-scripts-jail (start fifth)
ensure c7-scripts-scoreboard

7. In-Game Commands

Framework Commands:

• /framework - will open the character UI manually.

• /sethome - will set the player's home.

Chat Commands (if module is installed):

• /me [message] (Proximity) - sends a me message.

• /mer [message] (Proximity + 3D) - sends a 3D /me.

• /gme [message] (Global) - sends a global me message.

• /do [message] (Proximity) - sends a do message.

• /ooc [message] (Proximity) - sends an out of character message.

• /gooc [message] (Global) - sends an out of character message.

• /cctv [message] (Global) - sends a CCTV message.

• /med [message] (Proximity + 3D) - sends a medical message.

• /darkweb [message] (Global) - sends a dark web message.

• /ad [message] (Global) - sends an advertisement message.

• /w (or) /whisper [message] - sends a whispered 3D message, does not appear in chat.

• /nd911 [message] (Global) - sends a 911 message for no dispatch.

• /nda911 [message] (Global) - sends an anonymous 911 message for no dispatch.

• /nd311 [message] (Global) - sends a 311 message for no dispatch.

• /nda311 [message] (Global) - sends an anonymous 311 message for no dispatch.

Jail Menu Commands (if module is installed):

• /jail

Blips Script Commands (if module is installed):

• /blips (toggles your blips on or off)

8. Verify the Installation

To confirm the framework is working:

1. Connect to the server

2. On first join, the cinematic character UI should appear

3. Create a character, update it, delete it etc.

4. Select a spawn location

5. Disconnect and reconnect to confirm data saves

6. Test deleting & editing characters

7. Check Discord for webhook logs (if configured)

8. Check chat commands are working (if installed)

9. Check the jail script is working (if installed)

10. Check the blips are working (if installed)

9. Common Issues

UI does not open on join

• Ensure ensure c7-framework-v3 is placed after database resources

• Confirm no other resource forces NUI focus

• Check server console for missing dependencies

Characters are not saving

• Verify OxMySQL is connected

• Check database credentials in your server’s config

• Ensure no MySQL errors appear in the console

Webhooks are not sending

• Check webhook URLs

• Ensure they are valid Discord webhook endpoints

• Confirm the server can reach external URLs