For the complete documentation index, see llms.txt. This page is also available as Markdown.

1️⃣Installation

Please Follow the instruction on this page

Getting Started

Drag and Drop am-trucking to your resources folder

Add ensure am-trucking in your server.cfg file

Database

Run the file am-trucking.sql or execute this code in your database

CREATE TABLE IF NOT EXISTS `am_trucking_players` (
    `citizenid` VARCHAR(255) NOT NULL,
    `profile_name` VARCHAR(25) DEFAULT NULL,
    `avatar_url` TEXT DEFAULT NULL,
    `onboarding_completed` ENUM('no', 'yes') NOT NULL DEFAULT 'no',
    `reputation` INT NOT NULL DEFAULT 0,
    `skill_points` INT NOT NULL DEFAULT 0,
    `skills` JSON NOT NULL DEFAULT ('{}'),
    `total_income` INT NOT NULL DEFAULT 0,
    `leaderboard_income` INT NOT NULL DEFAULT 0,
    `total_jobs` INT NOT NULL DEFAULT 0,
    `leaderboard_jobs` INT NOT NULL DEFAULT 0,
    `total_distance_traveled` DECIMAL(10,1) NOT NULL DEFAULT 0.0,
    `leaderboard_distance_traveled` DECIMAL(10,1) NOT NULL DEFAULT 0.0,
    `company_id` INT DEFAULT NULL,
    `company_owner_cut_percent` INT NOT NULL DEFAULT 10,
    `created_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    `updated_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`citizenid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

CREATE TABLE IF NOT EXISTS `am_trucking_companies` (
    `id` INT NOT NULL AUTO_INCREMENT,
    `name` VARCHAR(100) NOT NULL,
    `owner_citizenid` VARCHAR(255) NOT NULL,
    `logo` TEXT DEFAULT NULL,
    `balance` INT NOT NULL DEFAULT 0,
    `employee_count` INT NOT NULL DEFAULT 0,
    `total_income` BIGINT NOT NULL DEFAULT 0,
    `total_jobs` INT NOT NULL DEFAULT 0,
    `created_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    `updated_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`),
    UNIQUE KEY `uk_company_name` (`name`),
    UNIQUE KEY `uk_company_owner` (`owner_citizenid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

CREATE TABLE IF NOT EXISTS `am_trucking_company_trucks` (
    `id` INT NOT NULL AUTO_INCREMENT,
    `company_id` INT NOT NULL,
    `plate` VARCHAR(12) NOT NULL,
    `model` VARCHAR(50) NOT NULL,
    `label` VARCHAR(100) DEFAULT NULL,
    `status` ENUM('available', 'busy') NOT NULL DEFAULT 'available',
    `added_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`),
    KEY `idx_company_trucks_company` (`company_id`),
    CONSTRAINT `fk_company_trucks_company` FOREIGN KEY (`company_id`) REFERENCES `am_trucking_companies` (`id`) ON DELETE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

CREATE TABLE IF NOT EXISTS `am_trucking_company_invites` (
    `id` INT NOT NULL AUTO_INCREMENT,
    `company_id` INT NOT NULL,
    `citizenid` VARCHAR(255) NOT NULL,
    `invited_by` VARCHAR(255) NOT NULL,
    `created_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`),
    UNIQUE KEY `uk_invite` (`company_id`, `citizenid`),
    CONSTRAINT `fk_invite_company` FOREIGN KEY (`company_id`) REFERENCES `am_trucking_companies` (`id`) ON DELETE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

CREATE TABLE IF NOT EXISTS `am_trucking_job_history` (
    `id` INT NOT NULL AUTO_INCREMENT,
    `citizenid` VARCHAR(255) NOT NULL,
    `company_key` VARCHAR(50) DEFAULT NULL,
    `job_type` VARCHAR(50) NOT NULL,
    `job_label` VARCHAR(100) DEFAULT NULL,
    `payment` INT NOT NULL DEFAULT 0,
    `route_type` VARCHAR(50) DEFAULT NULL,
    `completed_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`),
    KEY `idx_job_history_citizen` (`citizenid`),
    KEY `idx_job_history_date` (`completed_at`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

CREATE TABLE IF NOT EXISTS `am_trucking_admin_logs` (
    `id` INT NOT NULL AUTO_INCREMENT,
    `admin_name` VARCHAR(100) NOT NULL,
    `admin_citizenid` VARCHAR(255) NOT NULL,
    `action` VARCHAR(255) NOT NULL,
    `details` TEXT DEFAULT NULL,
    `created_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    PRIMARY KEY (`id`),
    KEY `idx_admin_logs_date` (`created_at`),
    KEY `idx_admin_logs_admin` (`admin_citizenid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Last updated