C7 Framework Version 1.4.0

This guide explains how to update your current C7 Framework V3 version to v1.4.0

01. What's new?

Additions:

• Added new automatic database manipulation

  • The script will now automatically install and update the database without requiring any manual SQL injection.

• Added a new department grade (rank) system (with Discord Role Integration);

  • Characters can now have a rank under their current department, useful for other scripts and requiring a certain rank to allow access etc.

  • This can be turned off in the configuration if you don't want it.

Changes:

• Updated the UI style to remove shadows from certain elements, primarily modals, making it harder to read and blurrier.

• Updated the dropdown fields to a custom dropdown style.

Developers:

• Added a whole bunch of new developer exports:

  • New: GetCharGrade (Click to read more)

  • New: GetCharJailedStatus (Click to read more)

  • New: GetCharJailedExpiry (Click to read more)

  • New: GetCharCreatedAt (Click to read more)

  • New: GetCharLastLocation (Click to read more)

  • New: GetCharLastLocationCoords (Click to read more)

  • New: GetCharLastPlayed (Click to read more)

  • New: GetCharDiscordID (Click to read more)

  • New: GetCharSteamID (Click to read more)

  • Updated: GetCharCopy (Click to read more)

• Added new developer events:

  • C7FW:ForceCreateCharacter (Click to read more)

    • Forcibly creates a new character.

  • C7FW:ForceEditCharacter (Click to read more)

    • Forcibly edits a character.

  • C7FW:ForceRemoveCharacter (Click to read more)

    • Forcibly removes a character.

02. Downloading the Updated Resource

1

Download the latest update of the C7 Framework V3;

This folder should contain the folder: c7-scripts-framework-v3

2

Extract the .zip file's

3

Replace the following files:

• client/client.lua

• server/server.lua

• server/version.lua

• html/css/style.css

• html/js/app.js

• html/index.html

4

Removing the following files:

These files are no longer necessary due to the new automatic database manipulation feature:

• c7_fw_characters.sql

• c7_fw_characters_patch.sql

03. Updating your Configuration File

1

Adding Automatic Database Manipulation

Firstly, you want to add the new automatic database manipulation lines. These new configuration lines will:

• Automatically create the C7 Framework database when you first install the resource.

• Automatically update the C7 Framework database when it detects an update. This will patch your current database. This will not overwrite any existing data.

You must add the following lines of code BELOW "Config.Debug"

Config.Debug = true

-- ADD THESE LINES:
Config.AutoInsertDatabase = true -- Keep true.
Config.AutoUpdateDatabase = true -- Keep true, unless you don't care about updates...

2

Adding the new Grades System

Secondly, you want to add the new 'Grades' feature to your configuration file, you must add the following code BELOW "Config.discordServerID"

Config.discordServerID = "YOUR_SERVER_ID"

-- ADD THIS LINE:
Config.enableGrades = true -- If false, the grades system will not be active.

Thirdly, you want to implement the grades feature into your departments themselves. Below is how you can add the configuration lines safely.

Demonstration:

Config.Departments = {
    ["civilian"] = {
        mainPermissions = {
            everyoneCanUse = true,
            allowedDiscordRoles = {
                "1439128964298965052",
            }
        },
        departmentTitle = "Civilian",
        spawnLocations = {
        { x = 205.82, y = -933.63, z = 30.69, h = 140.0, title = "Legion Square" },
        { x = 299.12, y = -586.47, z = 43.29, h = 70.0,  title = "Pillbox Hill" },
        { x = -35.12, y = -1102.72, z = 26.42, h = 170.0, title = "Alta Street Apartments" },
        { x = -1224.61, y = -1484.79, z = 4.36, h = 125.0, title = "Del Perro Pier" },
        { x = -1034.74, y = -2738.10, z = 20.17, h = 330.0, title = "LSIA Airport" },
        { x = 1864.74, y = 3678.17, z = 33.68, h = 210.0, title = "Sandy Shores" },
        { x = 1704.22, y = 4823.23, z = 41.06, h = 90.0,  title = "Grapeseed" },
        { x = -447.16, y = 6029.46, z = 31.49, h = 45.0,  title = "Paleto Bay" },
        { x = 740.33, y = 233.12, z = 92.51, h = 200.0, title = "Rockford Hills" },
        { x = -555.29, y = -180.41, z = 38.22, h = 90.0,  title = "Weazel News" }
        }, -- ENSURE THERE IS A COMMA HERE
        -- YOU WANT TO ADD THIS TO ALL OF YOUR DEPARTMENTS:
        departmentGrades = {
            { grade = "Civilian III", allowedDiscordRoles = "" },
            { grade = "Civilian II",  allowedDiscordRoles = "" },
            { grade = "Civilian I",   allowedDiscordRoles = "" },
        } -- NO COMMA
    }
}

Code line template:

departmentGrades = {
    { grade = "Civilian III", allowedDiscordRoles = "" },
    { grade = "Civilian II",  allowedDiscordRoles = "" },
    { grade = "Civilian I",   allowedDiscordRoles = "" },
}

Leave allowedDiscordRoles blank to give access to this grade to anyone. Else, put a Discord Role ID to limit who can use it. (i.e. allowedDiscordRoles = "12345678912345678")

04. What's next/planned?

There is currently a few things planned for the next update of C7 Framework, this includes:

• Full ImperialCAD integration;

• Full SonoranCAD integration.

• Character Favouriting:

  • You can set a character as your 'favourite' so whenever you open the framework for the first time, it will always load to your favourited character making it accessible quicker.