Ares Hydraulics - Configuration Guide

This guide is split into smaller pages:

• Installation

• Framework and inventory config

• Item system

• Commands and keybinds

• Jump mechanics tuning

• Hydraulics detection

• Notifications and messages

• Quick reference

• Troubleshooting

• Video and resources

---

🚀 Installation

Requirements

• ares-core (dependency)

• ox_lib (required)

• Framework: ESX, QBCore/QBOX, or Standalone

• Optional: ox_inventory, qb-inventory, or ESX inventory

Setup Steps

1. Extract ares_hydraulics to your resources folder

2. IMPORTANT: Folder must be named exactly ares_hydraulics

3. Add to server.cfg:

ensure ares-core
ensure ares_hydraulics

1. Add Item to Database (if using item-based system):

-- For ox_inventory
INSERT INTO `items` (`name`, `label`, `weight`, `stack`, `close`, `description`) 
VALUES ('hydraulic_kit', 'Hydraulic Kit', 50, true, true, 'Install hydraulics on lowriders');

-- For QBCore
-- Add to qb-core/shared/items.lua
['hydraulic_kit'] = {
    ['name'] = 'hydraulic_kit',
    ['label'] = 'Hydraulic Kit',
    ['weight'] = 50,
    ['type'] = 'item',
    ['image'] = 'hydraulic_kit.png',
    ['unique'] = false,
    ['useable'] = true,
    ['shouldClose'] = true,
    ['description'] = 'Install hydraulics on lowriders'
}

-- For ESX
-- Add to your ESX database items table

⚠️ Critical: Renaming the resource folder will break the script.

---

⚙️ Framework Configuration

Config.Framework = 'auto'
Config.Inventory = 'auto'
Config.RequireItem = true
Config.Debug = true

Framework Detection

Setting	Options	Description
Framework	'auto', 'esx', 'qb-core', 'qbox', 'standalone'	Player/inventory management system
Inventory	'auto', 'ox_inventory', 'qb-inventory', 'esx'	Inventory system for item checks
RequireItem	boolean	Require hydraulic kit item to use system
Debug	boolean	Enable debug console logs

Automatic Detection (Recommended):

Config.Framework = 'auto'  -- Detects ESX, QBCore, or QBOX
Config.Inventory = 'auto'  -- Detects ox_inventory, qb-inventory, or ESX

Manual Override:

Config.Framework = 'esx'
Config.Inventory = 'ox_inventory'

Standalone Mode (No Framework):

Config.Framework = 'standalone'
Config.RequireItem = false  -- No item requirement in standalone

Production Settings

Config.Debug = false  -- ALWAYS disable in production

---

📦 Item System

Inventory Item Aliases

Maps logical item names to framework-specific inventory items:

Config.InventoryAliases = {
    ['hydraulic_kit'] = {
        ['ox_inventory'] = 'hydraulic_kit',
        ['qb-inventory'] = 'hydraulic_kit',
        ['esx'] = 'hydraulic_kit'
    }
}

Why Aliases? Different inventory systems may use different item names. This ensures compatibility across all systems.

Adding Custom Item Names:

Config.InventoryAliases = {
    ['hydraulic_kit'] = {
        ['ox_inventory'] = 'hydraulic_system',      -- Custom name for ox
        ['qb-inventory'] = 'lowrider_hydraulics',   -- Custom name for QB
        ['esx'] = 'hydraulic_kit'                   -- Custom name for ESX
    }
}

Item Requirement Toggle

Config.RequireItem = true   -- Players MUST have hydraulic_kit item
Config.RequireItem = false  -- All players can use hydraulics (no item needed)

When to Disable:

• Standalone servers without inventory systems

• Free-for-all hydraulics (no item cost)

• Testing/development environments

When to Enable:

• Roleplay servers with economy

• Servers selling hydraulic kits

• Controlled access to hydraulics feature

---

🎮 Hydraulics Commands

Main Command

Config.Command = 'hydraulics'

Usage: /hydraulics

What it does:

• Opens the hydraulics control UI

• Shows available controls and key bindings

• Displays vehicle hydraulics status

Customizing Command:

Config.Command = 'hydro'      -- Use /hydro instead
Config.Command = 'lowrider'   -- Use /lowrider instead

---

⌨️ Jump Key Configuration

Default Jump Key Settings

Config.JumpKey = {
    defaultKey = 'G',
    playerCanConfigure = true
}

Setting	Type	Description	Default
defaultKey	string	Default key for hydraulic jump	'G'
playerCanConfigure	boolean	Allow players to change their jump key	true

Player Key Customization

Players can change their own key:

/myjumpkey [key]

Examples:

/myjumpkey H       -- Set jump key to H
/myjumpkey SPACE   -- Set jump key to SPACE
/myjumpkey E       -- Set jump key to E

Valid Key Names:

• Single letters: A-Z

• Function keys: F1-F12

• Special keys: SPACE, LSHIFT, LCTRL, LALT

• Number keys: 0-9

📚 Full Key List: FiveM Control Reference

Admin Key Configuration

Admins can set keys for players:

/setjumpkey [player_id] [key]

Examples:

/setjumpkey 5 H        -- Set player ID 5's jump key to H
/setjumpkey 12 SPACE   -- Set player ID 12's jump key to SPACE

Disabling Key Configuration

Disable for everyone:

Config.JumpKey = {
    defaultKey = 'G',
    playerCanConfigure = false  -- No one can change keys
}

Key Configuration Permissions:

• When playerCanConfigure = true: Both players and admins can change keys

• When playerCanConfigure = false: Key changes are disabled

---

🚗 Jump Mechanics

Jump Cooldown System

Config.JumpCooldown = {
    enabled = true,
    duration = 3  -- seconds
}

Purpose: Prevents spam-jumping and maintains realistic hydraulics behavior

Setting	Type	Description	Recommended
enabled	boolean	Enable/disable jump cooldown	true
duration	integer	Seconds between jumps	3

Customizing Cooldown:

-- Fast-paced servers
Config.JumpCooldown = {
    enabled = true,
    duration = 1  -- 1 second cooldown
}

-- Realistic servers
Config.JumpCooldown = {
    enabled = true,
    duration = 5  -- 5 second cooldown
}

-- No cooldown (not recommended)
Config.JumpCooldown = {
    enabled = false,
    duration = 0
}

Jump Timing Settings

Config.JumpLockMs = 900
Config.JumpResetDelayMs = 900

Setting	Type	Description	Default
JumpLockMs	integer	Duration jump input is locked (milliseconds)	900
JumpResetDelayMs	integer	Delay before jump can be triggered again (ms)	900

Technical Explanation:

• JumpLockMs: How long the jump animation/physics runs before control returns

• JumpResetDelayMs: Delay to prevent accidental double-jumps

⚠️ Warning: Values below 500ms may cause physics glitches

Jump Force Configuration

Config.JumpForce = 3.0
Config.VerticalBoost = 4.0
Config.VerticalBoostSpeedGate = 100.0

Setting	Type	Description	Recommended Range
JumpForce	float	Base jump power	2.0 - 5.0
VerticalBoost	float	Additional upward force	3.0 - 6.0
VerticalBoostSpeedGate	float	Min speed (km/h) for boost	80.0 - 120.0

Force Calculation

Stationary Jump:

Total Force = JumpForce + VerticalBoost
Example: 3.0 + 4.0 = 7.0 total upward force

Moving Jump (above speed gate):

If speed >= VerticalBoostSpeedGate:
    Total Force = JumpForce + VerticalBoost + (speed bonus)

If speed < VerticalBoostSpeedGate:
    Total Force = JumpForce only

Tuning Examples

Low Jumps (Realistic):

Config.JumpForce = 2.0
Config.VerticalBoost = 2.5
Config.VerticalBoostSpeedGate = 120.0

Medium Jumps (Default):

Config.JumpForce = 3.0
Config.VerticalBoost = 4.0
Config.VerticalBoostSpeedGate = 100.0

High Jumps (Fun Mode):

Config.JumpForce = 5.0
Config.VerticalBoost = 7.0
Config.VerticalBoostSpeedGate = 80.0

Stunt Server:

Config.JumpForce = 8.0
Config.VerticalBoost = 10.0
Config.VerticalBoostSpeedGate = 60.0
Config.JumpCooldown.duration = 1

---

🔍 Hydraulics Detection System

The detection system determines which vehicles can use hydraulics.

Config.HydraulicsDetection = {
    RequireHydraulicsForUI = true,
    useModSlot38 = true,
    useModelWhitelist = true,
    modelWhitelist = { ... },
    itemWhitelist = { ... },
    useDatabaseCheck = true,
}

Detection Methods

Method	Priority	Description
useModSlot38	1st	Checks if vehicle has Lowrider mod slot 38 installed
useModelWhitelist	2nd	Checks if vehicle model is in whitelist
itemWhitelist	3rd	Checks if player has hydraulic item in inventory
useDatabaseCheck	4th	Checks database for custom hydraulic installations

Mod Slot 38 Detection

useModSlot38 = true

What is Mod Slot 38?

• GTA V's official lowrider hydraulics modification

• Available on Benny's Original Motor Works vehicles

• Visually adds hydraulic pumps to vehicle

Vehicles with Mod Slot 38:

• All Benny's lowriders (Faction, Buccaneer, Chino, etc.)

• Some custom vehicle mods

When to Use:

• ✅ Servers using vanilla lowriders

• ✅ Want automatic detection without configuration

• ❌ Custom vehicles without mod slot 38

Model Whitelist

useModelWhitelist = true
modelWhitelist = {
    'faction2','buccaneer2','chino2','moonbeam2','primo2',
    'sabregt2','slamvan3','voodoo','peyote3','tornado5',
    'minivan2','virgo2'
}

Purpose: Manually specify which vehicle models can use hydraulics

Adding Custom Vehicles:

modelWhitelist = {
    -- Vanilla lowriders
    'faction2','buccaneer2','chino2',
    
    -- Custom addon vehicles
    'impala64',        -- Custom Impala
    'cadillac59',      -- Custom Cadillac
    'monte_carlo',     -- Custom Monte Carlo
    
    -- Funny additions
    'faggio',          -- Scooter with hydraulics!
    'bus',             -- Party bus mode
}

Getting Vehicle Model Names:

1. Sit in vehicle

2. Type /carname (if you have such command) or check vehicle spawn name

Item-Based Hydraulics

itemWhitelist = {
    'hydraulic_kit',
}

How It Works:

• Player has hydraulic_kit in inventory

• Any vehicle becomes hydraulic-enabled

• Item is NOT consumed (reusable)

Use Cases:

• Portable hydraulics system

• Rental hydraulics service

• Economy-based hydraulic access

Multiple Item Support:

itemWhitelist = {
    'hydraulic_kit',
    'premium_hydraulics',
    'custom_lowrider_kit',
}

Database Check

useDatabaseCheck = true

Purpose: Check database for permanent hydraulic installations

When to Enable:

• ✅ Using custom garage scripts (Lunar Garages, etc.)

• ✅ Permanent hydraulic installations via mechanic jobs

• ✅ Vehicle customization systems that save to database

When to Disable:

• ❌ Not using database-based vehicle mods

• ❌ Using only mod slot 38 or whitelist detection

• ❌ Standalone mode

UI Requirement

RequireHydraulicsForUI = true

When true: UI only shows for vehicles with hydraulics When false: UI shows for all vehicles (but hydraulics won't work without detection)

Recommendation: Leave as true to prevent confusion

---

📢 Notifications

Notification Settings

Config.NotifyTitle = 'Ares Hydraulics'
Config.Messages = {
    notDriver = 'You must be the driver to use hydraulics.',
    noHydros  = "This vehicle doesn't have hydraulics installed.",
    usageSetKeyAdmin = 'Usage: /setjumpkey [player_id] [key]',
    usageSetKeyPlayer = 'Usage: /myjumpkey [key] (e.g., /myjumpkey H)',
    adminKeyDisabled = 'Jump key configuration is disabled for admins!',
    playerKeyDisabled = 'Jump key configuration is disabled for players!',
}

Customizing Messages

Change Notification Title:

Config.NotifyTitle = 'Lowrider System'  -- Custom title

Customize Messages (supports multiple languages):

Config.Messages = {
    notDriver = 'Solo el conductor puede usar hidráulicos.',  -- Spanish
    noHydros  = 'Ce véhicule n\'a pas d\'hydraulique.',       -- French
    -- etc...
}

Add Emoji/Unicode:

Config.Messages = {
    notDriver = '🚗 You must be the driver to use hydraulics.',
    noHydros  = '⚠️ This vehicle doesn\'t have hydraulics installed.',
}

---

🎨 Customization

Detection Strategy Examples

Strategy 1: Whitelist Only (Most Common)

Config.HydraulicsDetection = {
    RequireHydraulicsForUI = true,
    useModSlot38 = false,
    useModelWhitelist = true,
    modelWhitelist = { ... },  -- Your vehicle list
    useDatabaseCheck = false,
}
Config.RequireItem = false

Strategy 2: Item-Based System

Config.HydraulicsDetection = {
    RequireHydraulicsForUI = true,
    useModSlot38 = false,
    useModelWhitelist = false,
    itemWhitelist = {'hydraulic_kit'},
    useDatabaseCheck = false,
}
Config.RequireItem = true

Strategy 3: Mod Slot Only (Vanilla Servers)

Config.HydraulicsDetection = {
    RequireHydraulicsForUI = true,
    useModSlot38 = true,
    useModelWhitelist = false,
    useDatabaseCheck = false,
}
Config.RequireItem = false

Strategy 4: Everything Enabled (Most Permissive)

Config.HydraulicsDetection = {
    RequireHydraulicsForUI = true,
    useModSlot38 = true,
    useModelWhitelist = true,
    modelWhitelist = { ... },
    itemWhitelist = {'hydraulic_kit'},
    useDatabaseCheck = true,
}
Config.RequireItem = false  -- Item gives access, not required

---

📊 Quick Reference

Recommended Production Settings

-- Framework
Config.Framework = 'auto'
Config.Inventory = 'auto'
Config.RequireItem = true
Config.Debug = false  -- CRITICAL: Disable in production

-- Commands
Config.Command = 'hydraulics'
Config.JumpKey.defaultKey = 'G'
Config.JumpKey.playerCanConfigure = true

-- Jump Mechanics
Config.JumpCooldown.enabled = true
Config.JumpCooldown.duration = 3
Config.JumpForce = 3.0
Config.VerticalBoost = 4.0

-- Detection
Config.HydraulicsDetection.RequireHydraulicsForUI = true
Config.HydraulicsDetection.useModSlot38 = true
Config.HydraulicsDetection.useModelWhitelist = true
Config.HydraulicsDetection.useDatabaseCheck = true

Common Modifications

Task	Setting	Recommended Value
Disable item requirement	Config.RequireItem	false
Change jump key	Config.JumpKey.defaultKey	'H', 'SPACE'
Faster jumps	Config.JumpCooldown.duration	1-2 seconds
Higher jumps	Config.JumpForce	4.0-6.0
Add custom vehicle	Config.HydraulicsDetection.modelWhitelist	Add model name
Change command	Config.Command	'hydro', 'lowrider'

---

🆘 Troubleshooting

Hydraulics Not Working

Issue: Vehicle has hydraulics but system doesn't detect them

Solutions:

• ✅ Check vehicle is in modelWhitelist

• ✅ Verify useModSlot38 or useModelWhitelist is enabled

• ✅ Ensure player is driver (not passenger)

• ✅ Check player has hydraulic_kit item (if RequireItem = true)

• ✅ Enable Config.Debug = true and check console

Jump Key Not Working

Issue: Pressing jump key does nothing

Solutions:

• ✅ Check key isn't bound to another resource

• ✅ Verify player is in a vehicle with hydraulics

• ✅ Check cooldown hasn't expired yet

• ✅ Try changing jump key with /myjumpkey [newkey]

Item Not Found Error

Issue: "Item not found" when using hydraulics

Solutions:

• ✅ Verify item exists in database

• ✅ Check Config.InventoryAliases matches your item name

• ✅ Ensure inventory system is detected correctly

• ✅ Set Config.RequireItem = false to disable item requirement

Vehicle Jumps Too High/Low

Solutions:

• Too high: Reduce Config.JumpForce and Config.VerticalBoost

• Too low: Increase Config.JumpForce and Config.VerticalBoost

• Inconsistent: Adjust Config.VerticalBoostSpeedGate

Custom Vehicles Not Detected

Solutions:

1. Get exact vehicle spawn name

2. Add to modelWhitelist:

modelWhitelist = {
    'faction2',
    'your_custom_vehicle',  -- Add here
}

1. Restart resource

---

🎥 Video Tutorials

https://youtu.be/cm32UJr-3lw?si=n4aInrfaC0dobQTC

---

📚 Additional Resources

• Discord Support: discord.gg/eDEJUawmMh

• FiveM Docs:

  • Vehicle Mods

  • Controls

  • Blips