F5 StudioF5 Studio
Skip to main content

Commands

F5 Redeem Code registers two chat commands. Both names come from F5Cfg.Command and can be renamed freely.

config/config.lua
F5Cfg.Command = {
    redeem     = 'redeem',
    admin      = 'redeemadmin',
    suggestion = true,
}

/redeem​

Opens the player redeem panel — a single input where the player types a code and clicks Redeem (or presses Enter).

Default name/redeem
Who can run itEveryone
Config keyF5Cfg.Command.redeem
OpensThe redeem panel (client → f5_code:server:openRedeem → panel)

The panel is refused to open if a redeem or admin panel is already open. Redeeming itself is validated fully server-side — see Features → Redeem validation.

/redeemadmin​

Opens the admin management console — create, edit and delete codes, and browse the redemption history.

Default name/redeemadmin
Who can run itEveryone can run it, but the panel only opens for admins
Config keyF5Cfg.Command.admin
OpensThe admin console (client → f5_code:server:openAdmin → permission check → panel)
Permission is checked server-side

The command itself is not permission-restricted, but the server verifies admin access on the openAdmin request. A non-admin who runs /redeemadmin receives the admin_no_permission notification and the panel never opens. Access = passes the ACE permission OR belongs to a listed framework group (F5Cfg.Admin). See Admin Panel → Access Control.

Chat suggestions​

config/config.lua
F5Cfg.Command = {
    suggestion = true,
}

When suggestion = true, both commands are registered with chat:addSuggestion so they appear in the chat autocomplete with a short description:

CommandSuggestion text (locale key)
/redeemcommand_suggestion — "Open the redeem code panel"
/redeemadminadmin_command_suggestion — "Open the redeem code admin panel"

Set suggestion = false to hide both hints from the chat suggestion list (the commands still work).

Closing a panel​

Any open panel closes with the on-screen Close button or the Esc key. If a modal (item list or player picker) is open, Esc closes the modal first, then the panel on a second press.

See Also​