📦Installation

Download the Resource

• Download the gymsv2 resource package

• Extract the files to your server's resources directory

File Structure

Verify the resource contains the following files:

• fxmanifest.lua

• config.lua

• configGyms.lua

• gym/client.lua

• gym/server.lua

• punchingmachines/client.lua

• punchingmachines/server.lua

• html/

• stream/

Database Setup

1. Run SQL Migration

Execute the SQL file to create the required database tables and columns:

ALTER TABLE `players` 
ADD COLUMN IF NOT EXISTS `gym_skills` LONGTEXT DEFAULT NULL;

UPDATE `players` 
SET `gym_skills` = JSON_OBJECT(
    'Stamina', JSON_OBJECT('current', 20, 'lastUpdated', UNIX_TIMESTAMP() * 1000),
    'Stength', JSON_OBJECT('current', 20, 'lastUpdated', UNIX_TIMESTAMP() * 1000),
    'Lung Capacity', JSON_OBJECT('current', 20, 'lastUpdated', UNIX_TIMESTAMP() * 1000)
)
WHERE `gym_skills` IS NULL OR `gym_skills` = '';

ALTER TABLE `players` 
ADD COLUMN IF NOT EXISTS `gym_fatigue` LONGTEXT DEFAULT NULL;

UPDATE `players` 
SET `gym_fatigue` = JSON_OBJECT(
    'Push', JSON_OBJECT('current', 0, 'lastUpdated', UNIX_TIMESTAMP() * 1000),
    'Pull', JSON_OBJECT('current', 0, 'lastUpdated', UNIX_TIMESTAMP() * 1000),
    'Core', JSON_OBJECT('current', 0, 'lastUpdated', UNIX_TIMESTAMP() * 1000),
    'Cardio', JSON_OBJECT('current', 0, 'lastUpdated', UNIX_TIMESTAMP() * 1000),
    'Boxing', JSON_OBJECT('current', 0, 'lastUpdated', UNIX_TIMESTAMP() * 1000)
)
WHERE `gym_fatigue` IS NULL OR `gym_fatigue` = '';

CREATE TABLE IF NOT EXISTS `gym_memberships` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `citizenid` varchar(50) NOT NULL,
  `gym_name` varchar(100) NOT NULL,
  `membership_type` varchar(50) NOT NULL,
  `created_by` varchar(50) NOT NULL,
  `created_at` bigint(20) NOT NULL,
  `expires_at` bigint(20) NOT NULL,
  `price` int(11) NOT NULL DEFAULT 0,
  `is_active` tinyint(1) NOT NULL DEFAULT 1,
  PRIMARY KEY (`id`),
  KEY `citizenid` (`citizenid`),
  KEY `gym_name` (`gym_name`),
  KEY `expires_at` (`expires_at`),
  KEY `is_active` (`is_active`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

CREATE TABLE IF NOT EXISTS `gym_punching_scores` (
    `id` INT AUTO_INCREMENT PRIMARY KEY,
    `citizenid` VARCHAR(50) NOT NULL,
    `player_name` VARCHAR(100) NOT NULL,
    `score` INT NOT NULL DEFAULT 0,
    `created_at` BIGINT NOT NULL DEFAULT 0,
    INDEX `idx_score` (`score` DESC),
    INDEX `idx_citizenid` (`citizenid`),
    INDEX `idx_created_at` (`created_at`)
);

CREATE INDEX IF NOT EXISTS `idx_players_gym_skills` ON `players` (`gym_skills`(100));
CREATE INDEX IF NOT EXISTS `idx_players_gym_fatigue` ON `players` (`gym_fatigue`(100));

2. Verify Database Tables

After running the SQL, verify these tables exist:

• players - Updated with gym_skills and gym_fatigue columns

• gym_memberships - Stores player membership data

• gym_punching_scores - Stores punching machine leaderboard data

Add Items to Inventory

Add the following items to your inventory system's item configuration:

Inferno Boxing Gym Items

-- Standard Membership
['inferno_membership'] = {
    ['name'] = 'inferno_membership',
    ['label'] = 'Inferno Gym Membership',
    ['weight'] = 0,
    ['type'] = 'item',
    ['image'] = 'inferno_membership.webp',  
    ["unique"] = true,
    ["stackable"] = true,
    ["useable"] = true,
    ["shouldClose"] = true,
    ['description'] = 'This card represents that you are a current member of Inferno Boxing Gym, this card holds a Standard Membership!'
},

-- Premium Membership
['inferno_membership_premium'] = {
    ['name'] = 'inferno_membership_premium',
    ['label'] = 'Premium Inferno Gym Membership',
    ['weight'] = 0,
    ['type'] = 'item',
    ['image'] = 'inferno_membership_premium.webp',
    ["unique"] = true,
    ["stackable"] = true,
    ["useable"] = true,
    ["shouldClose"] = true,
    ['description'] = 'This card represents that you are a current member of Inferno Boxing Gym, this card holds a Premium Membership!'
},

-- Energy Drink
["inferno_energy_focus"] = {
    ["label"] = "Inferno Energy",
    ["weight"] = 50,
    ["type"] = "item",
    ["image"] = "inferno_energy_focus.webp",
    ["unique"] = false,
    ["stackable"] = true,
    ["useable"] = true,
    ["shouldClose"] = true,
    ["description"] = "This gives you an energy boost, will make you feel focused!",
    ['decay'] = 1,
    ['decayRate'] = 101,
    ["metadata"] = {
        uses = 2
    }
},

Gymnasium Items

-- Standard Membership
['gymnasium_membership'] = {
    ['name'] = 'gymnasium_membership',
    ['label'] = 'Gymnasium Gym Membership',
    ['weight'] = 0,
    ['type'] = 'item',
    ['image'] = 'gymnasium_membership.webp',  
    ["unique"] = true,
    ["stackable"] = true,
    ["useable"] = true,
    ["shouldClose"] = true,
    ['description'] = 'This card represents that you are a current member of Muscle Gymnasium Gym, this card holds a Standard Membership!'
},

-- Premium Membership
['gymnasium_membership_premium'] = {
    ['name'] = 'gymnasium_membership_premium',
    ['label'] = 'Premium Gymnasium Gym Membership',
    ['weight'] = 0,
    ['type'] = 'item',
    ['image'] = 'gymnasium_membership_premium.webp',
    ["unique"] = true,
    ["stackable"] = true,
    ["useable"] = true,
    ["shouldClose"] = true,
    ['description'] = 'This card represents that you are a current member of Muscle Gymnasium Gym, this card holds a Premium Membership!'
},

-- Energy Drink
["gymnasium_energy_focus"] = {
    ["label"] = "Gymnasium Energy",
    ["weight"] = 50,
    ["type"] = "item",
    ["image"] = "gymnasium_energy_focus.webp",
    ["unique"] = false,
    ["stackable"] = true,
    ["useable"] = true,
    ["shouldClose"] = true,
    ["description"] = "This gives you an energy boost, will make you feel focused!",
    ['decay'] = 1,
    ['decayRate'] = 101,
    ["metadata"] = {
        uses = 2
    }
},

Pump & Run Gym Items

-- Standard Membership
['pumpnrun_membership'] = {
    ['name'] = 'pumpnrun_membership',
    ['label'] = 'Pump & Run Gym Membership',
    ['weight'] = 0,
    ['type'] = 'item',
    ['image'] = 'pumpnrun_membership.webp',  
    ["unique"] = true,
    ["stackable"] = true,
    ["useable"] = true,
    ["shouldClose"] = true,
    ['description'] = 'This card represents that you are a current member of Pump & Run Gym, this card holds a Standard Membership!'
},

-- Premium Membership
['pumpnrun_membership_premium'] = {
    ['name'] = 'pumpnrun_membership_premium',
    ['label'] = 'Premium Pump & Run Gym Membership',
    ['weight'] = 0,
    ['type'] = 'item',
    ['image'] = 'pumpnrun_membership_premium.webp',
    ["unique"] = true,
    ["stackable"] = true,
    ["useable"] = true,
    ["shouldClose"] = true,
    ['description'] = 'This card represents that you are a current member of Pump & Run Gym, this card holds a Premium Membership!'
},

-- Energy Drink
["pumpnrun_energy_focus"] = {
    ["label"] = "Pump & Run Energy",
    ["weight"] = 50,
    ["type"] = "item",
    ["image"] = "pumpnrun_energy_focus.webp",
    ["unique"] = false,
    ["stackable"] = true,
    ["useable"] = true,
    ["shouldClose"] = true,
    ["description"] = "This gives you an energy boost, will make you feel focused!",
    ['decay'] = 1,
    ['decayRate'] = 101,
    ["metadata"] = {
        uses = 2
    }
},

Add to Server Configuration

1. Add Resource to server.cfg

Open your server.cfg file and add the following line to ensure the resource starts:

ensure gymsv2

2. Configure Dependencies

Ensure the following resources are running before gymsv2

• TMC Framework Core - Required for framework functions

• oxmysql or equivalent database resource

Install MLO Maps (Optional)

The script supports multiple gym MLO locations. Install the MLO maps you want to use:

Free Options

• Pump & Run Gym - Download from GTA5-Mods

Paid Options

• Inferno Boxing Gym - Purchase from Aura Studio

• Muscle Gymnasium - Purchase from AJaxon

After installing an MLO, enable it in configGyms.lua by setting enabled = true for that gym location.

Test the Installation

1. Start the Server

Start your server and verify the resource loads without errors:

Starting gymsv2...
gymsv2 started successfully

2. Join as Player

• Join your server

• Navigate to a gym location

• Verify you see the gym boundary zone message

• Test entering and exiting the gym

3. Test Membership System

• Have a gym employee create a membership

• Verify the membership item appears in inventory

• Test using gym equipment with the membership

4. Test Punching Machines

• Go to a gym with punching machines enabled

• Test the punching minigame

• Verify scores are saved and displayed on the leaderboard

Permission Configuration

Grant the appropriate permission levels in your permissions system:

• gymstats - View player gym statistics (Default: god)

• resetgymstats - Reset player gym statistics (Default: god)

• setgymstat - Set specific gym stat values (Default: god)

• setfatigue - Modify player fatigue levels (Default: god)

• cleanpunchscores - Clean old punching machine scores (Default: god)

Edit these permissions in configGyms.lua:

Config.Gyms.Permissions = {
    gymstats = 'god',
    resetgymstats = 'god',
    setgymstat = 'god',
    setfatigue = 'god',
    testskilldegrade = 'god',
    cleanpunchscores = 'god'
}

Commands

The following commands are available after installation:

Admin Commands

• /gymstats [player_id] - View a player's gym statistics

• /resetgymstats [player_id] - Reset a player's gym stats to default

• /setgymstat [player_id] [skill_name] [amount] - Set a specific gym stat value

• /setfatigue [player_id] [fatigue_type] [amount] - Set player fatigue level

• /cleanpunchscores - Clean up old punching machine scores from database

Player Commands

Players interact with gyms through in-world zones and prompts - no direct commands are needed for normal gameplay.

Troubleshooting

Resource Won't Start

• Verify TMC Framework core is loaded first

• Check console for error messages

• Ensure all dependencies are installed

Database Errors

• Verify SQL migration ran successfully

• Check database connection in your server configuration

• Ensure proper table permissions

Gym Zones Not Working

• Verify the gym MLO is installed and loaded

• Check configGyms.lua has correct coordinates

• Ensure the gym is set to enabled = true

Membership Items Not Working

• Verify items are added to your inventory system

• Check item images are in the correct directory

• Ensure item names match between config and inventory

Next Steps

Once installation is complete, proceed to the Configuration section to customize gym locations, equipment, skill progression, and more.