server/config.lua

The server config file for 'orbit-dynamichud'.

🖥️ Server Configuration

The server/config.lua file controls server-side command permissions and availability for Orbit Dynamic HUD.

This configuration determines which administrative commands are enabled and which permission groups are allowed to use them.

It acts as the permission layer for command features documented in the Commands section.

---

🎯 Purpose

This file allows you to:

• Enable or disable HUD-related commands

• Restrict commands to specific permission groups

• Control access without editing command logic

• Maintain consistent permission handling across frameworks

The configuration is designed to work with permission systems such as:

• ox_lib groups

• QBCore permissions

• ACE / custom group wrappers

---

🧩 Command Structure

Each command follows this structure:

commandName = {
    enabled = true,
    allow = 'group.admin'
}

Fields

Field	Description
enabled	Enables or disables the command entirely
allow	Permission group required to use the command

If allow is an empty string, the command is available to everyone.

---

💰 Cash Command

Displays a player’s cash balance in chat.

Behavior

• Shows the caller’s cash by default

• Accepts a player ID to check another player

• Requires permission if configured

Typical use cases:

• Staff checks

• Support situations

• Debugging economy issues

---

🏦 Bank Command

Displays a player’s bank balance.

Behavior

• Same permission logic as the cash command

• Useful for economy monitoring and support

---

😰 Set Stress Command

Allows staff to set a player’s stress value.

Behavior

• Can target self or another player

• Values are clamped within the allowed range

• Updates the player state bag used by the HUD

Common uses:

• Testing effects

• Roleplay events

• Support corrections

---

🔐 Permission Handling

The allow value is evaluated by the command registration layer (ox_lib in your implementation).

Examples:

Value	Meaning
'group.admin'	Admin group only
'group.mod'	Moderators
''	Public command

You may replace these with your server’s group identifiers.

---

⚠️ Important Notes

• Disabling a command prevents registration entirely

• Changing permissions does not require editing handlers

• Permission naming must match your framework

• Leaving commands public can expose sensitive information

---

✅ Best Practices

• Restrict economy commands to staff

• Keep setstress admin-only

• Document custom permission groups

• Avoid editing command logic when permissions can be configured here

---

📦 Full Configuration

Config = {}

Config.Commands = {
    -- Shows the amount of cash the user has in the chat, if a source (ID) parameter is given then it shows the targets current cash amount.
    cash = {
        enabled = true,
        allow = 'group.admin'
    },

    -- Shows the amount of money the user has in their bank in the chat, if a source (ID) parameter is given then it shows the targets current bank money.
    bank = {
        enabled = true,
        allow = 'group.admin'
    },

    -- Sets stress for the user to a specified amount. If a source (ID) then it sets the stress for that user.
    setstress = {
        enabled = true,
        allow = 'group.admin'
    }
}

---

🔎 Summary

server/config.lua is the access control layer for HUD server commands.

By centralizing command permissions, the file ensures administrative tools remain secure while allowing flexibility for different server environments.

---