Docs/ORB Daily Rewards/Configuration

Configuration

All configuration is in config.lua (not escrowed).

Core Settings

lua
Config.Debug           = false
Config.Locale          = 'en'            -- 'en' | 'es' | '' for auto-detect
Config.Keybind         = 'Y'             -- key to open the UI (false to disable)
Config.Command         = 'dailyrewards'  -- chat command (false to disable)
Config.AutoShowOnLogin = true            -- show the UI on login if a reward is ready
Config.AutoShowDelay   = 5000            -- ms to wait after login before showing
Config.RequestCooldown = 2               -- anti-spam cooldown (seconds)

Config.MoneyAccount    = 'cash'          -- 'cash' | 'bank'
Config.InventorySystem = 'auto'          -- 'auto' or an explicit inventory name
Config.ItemImagePath   = ''              -- empty = auto-detect from inventory

Config.AutoHideHud     = true
Config.AutoHideChat    = false

Rewards

Config.Rewards is an array of 49 entries. Each day defines a label, image, rarity, and one or more rewards:

lua
Config.Rewards = {
    [1] = {
        label  = 'Cash $500',
        image  = 'money',
        rarity = 'common',          -- common | uncommon | rare | epic | legendary
        rewards = {
            { type = 'money', amount = 500 },
            { type = 'item',  name = 'water', amount = 5 },
        },
    },
    -- ... up to [49]
}

Reward types:

TypeFields
moneyamount (paid to Config.MoneyAccount)
itemname, amount

Commands

CommandPermissionDescription
/dailyrewardsNoneToggle the rewards UI
/dailyresetAdminReset the player's streak (only when Config.Debug = true)

Exports (Client)

lua
exports['orb_daily_rewards']:OpenUI()
exports['orb_daily_rewards']:CloseUI()
local open = exports['orb_daily_rewards']:IsOpen()