⚙️Configuration

Overview

The Advanced Gyms System is highly customizable through two main configuration files:

• config.lua - Core framework setup

• configGyms.lua - Gym locations, equipment, skills, and all gameplay settings

Core Configuration (config.lua)

Framework Setup

TMC = exports.core:getCoreObject()

Config = {}
Config.Gyms = {}

This file establishes the connection to your TMC Framework. Modify the export name if your core resource uses a different identifier.

Gym Locations Configuration

Adding a New Gym

Each gym location in configGyms.lua follows this structure:

Config.Gyms.Locations = {
    ['Your Gym Name'] = {
        enabled = true,  -- Set to false to disable this gym
        BusinessSetup = {
            -- Business and membership settings
        },
        Zones = {
            Building = {
                -- Zone definitions
            },
            Tasks = {
                -- Equipment locations
            }
        }
    }
}

Business Setup (Optional)

Configure gym as a player-owned business with membership system:

BusinessSetup = {
    job = 'gymname',  -- Job name for gym employees
    EmployeeWorkoutFree = true,  -- Employees can workout without membership
    ReturnPaymentsPercent = 100,  -- Percentage of membership fees going to business account
    
    memberships = {
        ['Standard'] = {
            label = 'Standard Membership',
            item = 'gymname_membership',  -- Item given to player
            price = 100,  -- Price per day
            maxdays = 30,  -- Maximum membership duration
            allowedEquiptment = {
                'Weights',
                'Pushups',
                'Situps',
                'Pullups'
            }
        },
        ['Premium'] = {
            label = 'Premium Membership',
            item = 'gymname_membership_premium',
            price = 150,
            maxdays = 30,
            allowedEquiptment = {
                'Weights',
                'Pushups',
                'Situps',
                'Pullups',
                'Treadmills',
                'Boxing Bags',
                'Punching Machine'
            }
        }
    }
}

Configuration Options:

• job - The job identifier that allows access to management features

• EmployeeWorkoutFree - If true, employees can use equipment without membership

• ReturnPaymentsPercent - Percentage of membership payments that go to the business bank account (0-100)

• memberships - Table of available membership tiers

Membership Tiers:

• label - Display name shown to players

• item - Item identifier that represents the membership card

• price - Cost per day of membership

• maxdays - Maximum duration in days (prevents infinite memberships)

• allowedEquiptment - Array of equipment types this membership can access

Zone Configuration

Boundary Zone

Define the perimeter of your gym building:

['Boundary'] = {
    points = {
        vector2(-1261.79, -349.76),
        vector2(-1254.36, -346.04),
        vector2(-1247.92, -359.29),
        -- Add more points to trace the outline
    },
    options = {
        minZ = 34.0,  -- Minimum height
        maxZ = 38.0   -- Maximum height
    }
}

Tips for Boundary Zones:

• Walk around the perimeter of your gym MLO

• Use /coords or similar to capture corner points

• Order points in a clockwise or counter-clockwise pattern

• Ensure minZ/maxZ captures all floors

Membership Zone

Define where workers manage memberships:

['Membership'] = {
    center = vec3(-1255.86, -354.11, 36.96),  -- Center point
    length = 1.2,  -- Size in one direction
    width = 1.8,   -- Size in perpendicular direction
    options = {
        heading = 295,  -- Rotation angle
        minZ = 34.56,
        maxZ = 38.56
    }
}

This zone typically goes at a front desk or reception area.

Clothing Change Zone (Optional)

Create zones where players can change outfits:

['Clothing Change'] = {
    {
        center = vec3(-1530.97, -894.14, -5.62),
        length = 2.6,
        width = 3.2,
        options = {
            heading = 320,
            minZ = -8.02,
            maxZ = -4.02
        }
    },
    -- Can add multiple locker room zones
}

Punching Machines (Optional)

Configure interactive punching machines:

['Punching Machines'] = {
    {
        coords = vector4(-1529.38, -890.36, -5.60, 46.0),  -- X, Y, Z, Heading
        propName = 'box_machine',  -- Prop model name
        offsets = {
            x = 0.30,  -- Fine-tune prop positioning
            y = 0.25
        }
    },
    -- Can add multiple machines
}

Equipment Locations

Define coordinates for each type of workout equipment:

Tasks = {
    ['Weights'] = {
        vector3(-1268.16, -366.05, 36.98),
        vector3(-1269.95, -362.52, 36.98),
        vector3(-1266.75, -356.59, 36.96),
        -- Add more weight station locations
    },
    
    ['Treadmills'] = {
        vector3(-1257.60, -366.59, 37.12),
        vector3(-1258.92, -367.64, 37.12),
        -- Add more treadmill locations
    },
    
    ['Pushups'] = {
        vector3(-1261.73, -358.53, 36.99),
        vector3(-1260.34, -360.94, 36.99)
    },
    
    ['Pullups'] = {
        vector3(-1271.73, -360.16, 36.96),
        vector3(-1257.54, -358.78, 36.96)
    },
    
    ['Situps'] = {
        vector3(-1263.27, -363.05, 36.99),
        vector3(-1264.51, -360.05, 36.99)
    },
    
    ['Boxing Bags'] = {
        vector3(-1525.47, -886.93, -5.62),
        vector3(-1520.86, -890.77, -5.62)
    }
}

Equipment Types:

• Weights - Strength training, builds "Stength" skill, causes "Push" fatigue

• Treadmills - Cardio training, builds "Stamina" skill, causes "Cardio" fatigue

• Pushups - Bodyweight push exercise, builds "Stength" skill, causes "Push" fatigue

• Pullups - Bodyweight pull exercise, builds "Stength" skill, causes "Pull" fatigue

• Situps - Core training, builds "Lung Capacity" skill, causes "Core" fatigue

• Boxing Bags - Combat training, builds "Stength" skill, causes "Boxing" fatigue

Set an equipment type to false if your gym doesn't have it:

['Treadmills'] = false,  -- This gym has no treadmills

Skill System Configuration

Base Skills

Configure how skills progress and degrade:

Config.Gyms.Skills = {
    -- Starting skill values for new players
    DefaultValues = {
        ['Stamina'] = 20,
        ['Stength'] = 20,
        ['Lung Capacity'] = 20
    },
    
    -- Maximum skill level (100 = 100%)
    MaxSkillLevel = 100,
    
    -- How much skill gained per workout session
    ProgressionPerWorkout = {
        ['Stamina'] = 2,
        ['Stength'] = 2,
        ['Lung Capacity'] = 2
    },
    
    -- Skill degradation over time
    Degradation = {
        enabled = true,
        checkInterval = 86400000,  -- 24 hours in milliseconds
        decayRate = 1,  -- Amount lost per interval
        
        -- Skills won't decay below this level
        minimumSkillLevel = {
            ['Stamina'] = 20,
            ['Stength'] = 20,
            ['Lung Capacity'] = 20
        }
    }
}

Skill Progression Tips:

• Lower ProgressionPerWorkout for slower, more realistic progression

• Increase checkInterval to reduce how often skills decay

• Set enabled = false to disable skill degradation entirely

• Adjust decayRate for faster or slower skill loss

Equipment Configuration

Control workout duration and effects for each equipment type:

Config.Gyms.Equipment = {
    ['Weights'] = {
        WorkoutTime = 10000,  -- Duration in milliseconds (10 seconds)
        Skills = {'Stength'},  -- Which skills this improves
        FatigueCategory = 'Push',  -- Which fatigue type this causes
        FatigueIncrease = 15  -- How much fatigue is gained
    },
    
    ['Treadmills'] = {
        WorkoutTime = 15000,  -- 15 seconds
        Skills = {'Stamina'},
        FatigueCategory = 'Cardio',
        FatigueIncrease = 20
    },
    
    ['Pushups'] = {
        WorkoutTime = 8000,
        Skills = {'Stength'},
        FatigueCategory = 'Push',
        FatigueIncrease = 12
    },
    
    ['Pullups'] = {
        WorkoutTime = 8000,
        Skills = {'Stength'},
        FatigueCategory = 'Pull',
        FatigueIncrease = 12
    },
    
    ['Situps'] = {
        WorkoutTime = 8000,
        Skills = {'Lung Capacity'},
        FatigueCategory = 'Core',
        FatigueIncrease = 10
    },
    
    ['Boxing Bags'] = {
        WorkoutTime = 12000,
        Skills = {'Stength'},
        FatigueCategory = 'Boxing',
        FatigueIncrease = 15
    }
}

Fatigue System Configuration

Manage player exhaustion and recovery:

Config.Gyms.Fatigue = {
    -- Enable or disable the fatigue system
    enabled = true,
    
    -- Maximum fatigue level (100 = completely exhausted)
    maxLevel = 100,
    
    -- Fatigue threshold before workouts are blocked
    blockWorkoutThreshold = 85,  -- Can't workout above 85% fatigue
    
    -- Injury chance when working out while fatigued
    injuryChance = {
        enabled = true,
        threshold = 75,  -- Start rolling for injury above 75% fatigue
        baseChance = 10,  -- 10% base chance
        increasePerPoint = 2  -- +2% per fatigue point above threshold
    },
    
    -- Natural fatigue recovery over time
    passiveRecovery = {
        enabled = true,
        recoveryRate = 1,  -- Points recovered
        recoveryInterval = 300000  -- Every 5 minutes
    },
    
    -- Fatigue reduction from consumables
    consumableReduction = {
        ['inferno_energy_focus'] = 20,
        ['gymnasium_energy_focus'] = 20,
        ['pumpnrun_energy_focus'] = 20
    }
}

Fatigue Categories:

• Push - Upper body pushing movements (weights, pushups)

• Pull - Upper body pulling movements (pullups)

• Core - Abdominal and core exercises (situps)

• Cardio - Cardiovascular activities (treadmills)

• Boxing - Combat sports training (boxing bags)

Balancing Fatigue:

• Lower blockWorkoutThreshold to force more rest periods

• Increase recoveryRate for faster natural recovery

• Decrease recoveryInterval to recover fatigue more frequently

• Adjust injuryChance values for more/less risk

Punching Machine Configuration

Minigame Settings

Configure the difficulty and scoring for the punching machine minigame:

Config.Gyms.PunchingMachines = {
    Minigame = {
        random = true,  -- Randomize difficulty each attempt
        difficulty = 'medium',  -- Default when random = false
        
        difficultySettings = {
            easy = {
                timeLimit = 500,  -- Time in centiseconds (500 = 5 seconds)
                maxKeys = 30,  -- Total keys to complete
                targetScore = 25,  -- Keys needed for perfect
                maxMisses = 8,  -- Wrong keys allowed
                perfectScore = 999,  -- Score for perfect completion
                partialScoreMultiplier = 15,  -- Points per key
                failScoreMultiplier = 10,  -- Points per key when failed
                minScore = 75,  -- Minimum for partial completion
                minFailScore = 50  -- Minimum when failed
            },
            
            medium = {
                timeLimit = 400,  -- 4 seconds
                maxKeys = 50,
                targetScore = 40,
                maxMisses = 5,
                perfectScore = 999,
                partialScoreMultiplier = 12,
                failScoreMultiplier = 8,
                minScore = 60,
                minFailScore = 40
            },
            
            hard = {
                timeLimit = 300,  -- 3 seconds
                maxKeys = 70,
                targetScore = 60,
                maxMisses = 3,
                perfectScore = 999,
                partialScoreMultiplier = 10,
                failScoreMultiplier = 6,
                minScore = 120,
                minFailScore = 50
            }
        }
    }
}

Difficulty Tuning:

• timeLimit - Lower for faster/harder gameplay

• maxKeys - More keys = longer sequences

• targetScore - Keys needed to achieve perfect score

• maxMisses - More misses = more forgiving

• perfectScore - The maximum score achievable

• Multipliers - Adjust point values for partial/failed attempts

Localization Configuration

Notification Messages

Customize all player-facing notification messages:

Config.Gyms.Locale = {
    Notifications = {
        EnteredGym = {
            text = 'You entered %s. Time to get those gains!',
            type = 'success'
        },
        
        LeftGym = {
            text = 'You left %s. Great workout!',
            type = 'info'
        },
        
        AlreadyOnTask = {
            text = 'You are already working out...',
            type = 'error'
        },
        
        NoMembership = {
            text = 'You need a valid gym membership to use this equipment.',
            type = 'error'
        },
        
        WrongMembership = {
            text = 'Your membership tier does not include access to this equipment.',
            type = 'error'
        },
        
        TooFatigued = {
            text = 'You are too fatigued to continue. Rest up!',
            type = 'error'
        },
        
        FatigueGained = {
            text = 'Fatigue +%d%% (%s)',
            type = 'info'
        },
        
        InjuryDueFatigue = {
            text = 'You strained something from overtraining. Take a break!',
            type = 'error'
        },
        
        SkillIncreased = {
            text = '%s increased to %.1f%%!',
            type = 'success'
        }
    }
}

Prompt Messages

Configure interaction prompt text:

Config.Gyms.Locale = {
    Prompts = {
        ['Membership Counter'] = {
            Title = 'Membership Desk',
            Description = 'Manage gym memberships',
            Icon = 'fa-solid fa-id-card',
            AutoComplete = false
        },
        
        ['Clothing Change'] = {
            Title = 'Change Clothes',
            Description = 'Access your wardrobe',
            Icon = 'fa-solid fa-shirt',
            AutoComplete = false
        },
        
        ['Punching Machine'] = {
            use = {
                Title = 'Use Punching Machine',
                Description = 'Test your punching power!',
                Icon = 'fa-solid fa-boxing-glove',
                AutoComplete = false
            },
            scores = {
                Title = 'View High Scores',
                Description = 'Check the leaderboard',
                Icon = 'fa-solid fa-medal',
                AutoComplete = false
            }
        },
        
        ['Equipment'] = {
            ['Weights'] = {
                Title = 'Lift Weights',
                Description = 'Build strength and muscle',
                Icon = 'fa-solid fa-dumbbell',
                AutoComplete = false
            },
            
            ['Treadmills'] = {
                Title = 'Use Treadmill',
                Description = 'Improve cardio and stamina',
                Icon = 'fa-solid fa-person-running',
                AutoComplete = false
            },
            
            ['Pushups'] = {
                Title = 'Do Pushups',
                Description = 'Upper body workout',
                Icon = 'fa-solid fa-hand-fist',
                AutoComplete = false
            },
            
            ['Pullups'] = {
                Title = 'Do Pullups',
                Description = 'Build back and arm strength',
                Icon = 'fa-solid fa-arrows-up-down',
                AutoComplete = false
            },
            
            ['Situps'] = {
                Title = 'Do Situps',
                Description = 'Core strengthening',
                Icon = 'fa-solid fa-repeat',
                AutoComplete = false
            },
            
            ['Boxing Bags'] = {
                Title = 'Hit Boxing Bag',
                Description = 'Practice your punches',
                Icon = 'fa-solid fa-hand-back-fist',
                AutoComplete = false
            }
        }
    }
}

Permission Configuration

Set required permission levels for admin commands:

Config.Gyms.Permissions = {
    gymstats = 'admin',  -- View player stats
    resetgymstats = 'admin',  -- Reset player stats
    setgymstat = 'god',  -- Modify specific stat values
    setfatigue = 'admin',  -- Modify fatigue levels
    testskilldegrade = 'god',  -- Test skill degradation (dev only)
    cleanpunchscores = 'admin'  -- Clean database scores
}

Permission Levels:

• player - All players

• moderator - Moderator access

• admin - Administrator access

• god - Full admin/developer access

Advanced Configuration Tips

Creating Balanced Progression

1. Start Low, Climb Slow - Set ProgressionPerWorkout to 1-2 for realistic progression

2. Match Fatigue to Duration - Longer workouts should give more fatigue

3. Vary Equipment - Have different equipment improve different skills

4. Reasonable Decay - Daily decay of 1 point keeps players engaged without frustration

Membership Pricing Strategy

1. Daily Pricing - Set prices per day to make calculations transparent

2. Tier Benefits - Clearly differentiate membership tiers with equipment access

3. Revenue Balance - Adjust ReturnPaymentsPercent based on server economy

4. Max Duration - Prevent exploits with reasonable maxdays limits

Performance Optimization

1. Limit Equipment Locations - Only add as many positions as your MLO supports

2. Reduce Check Intervals - Increase degradation/recovery intervals to reduce database calls

3. Zone Optimization - Keep boundary zones simple with fewer points

Balancing Multiple Gyms

When running multiple gym locations:

• Give each gym unique equipment layouts

• Vary membership prices by location prestige

• Consider different skill progression rates per gym

• Create location-specific benefits (e.g., boxing gym focuses on combat skills)

Next Steps

After configuring your gyms, check out the FAQ for common questions and troubleshooting tips.