Product Documentation

Riven HUD

Documented build: 1.7.6May differ from the current store release
Resource: riven_hud
Configuration: riven_hud/config.lua
Declared resource dependency: chat

Overview

Riven HUD provides an on-screen area-of-play and priority display, location information, a configurable player interface, and a roleplay chat theme. The packaged resource is standalone and designed to operate without ESX or QBCore. Its chat implementation works with FiveM's stock chat resource rather than replacing the stock message input interface.

The HUD is separate from the Riven Vehicle HUD. Riven HUD does not provide a duplicate speedometer, fuel gauge, RPM display, or vehicle instrument panel.

Installation

Copy the folder named riven_hud into resources/.
Start FiveM's chat resource before the HUD.
Use the following entries in server.cfg:

cfg

set onesync on
ensure chat
ensure riven_hud

Ensure there is not another active chat theme fighting to style the stock chat interface.
Adjust config.lua, then start the resource.

Player controls and commands

Command or key	Function
`/rivenhud`	Open HUD appearance and placement settings
`/rhconfig`	Alternate HUD configuration command
`/rivenhudtoggle`	Toggle HUD visibility
F9 or `/rivenchatmode`	Switch chat history display mode
`/rivenhelp`	Show the command list
`/aop`	View the area of play
`/aop <name>`	Change the area of play, subject to configured permissions
`/aop auto`	Enable configured automatic AOP selection
`/aopvote A \| B \| C`	Start an AOP vote, subject to permissions
`/vote <number>`	Respond to an AOP vote
`/pt on` or `/pt off`	Control peacetime, subject to permissions
`/priority`	Read current priority state
`/priority start`	Set priority state, subject to permissions
`/priority cooldown <minutes>`	Start a priority cooldown, subject to permissions
`/priority hold` or `/priority available`	Change priority state, subject to permissions

Chat commands documented in the package include /me, /do, /looc, /ooc, /tweet, /ad, /911, /311, /pm, /reply, /staff, /chatmute, /chatunmute, /slowmode, /clearall, and /clear. Some commands are staff-only. The precise command configuration and permissions are maintained in config.lua.

Customizing the HUD

Open /rivenhud and use the in-game controls for position, scale, opacity, and available elements. Free positioning is available in this build, including a drag-to-position workflow and X/Y adjustments.

The resource's configuration includes location display, street-name handling, postal resource integration, vehicle visibility, chat behavior, voice/status presentation, and area-of-play rules. A separate nearest-postal resource may be used for the postal field; the reviewed configuration refers to nearest-postal by default. Without a working provider, the README describes the visible fallback Postal ---.

Permissions and staff administration

The package supports ACE-based permissions and an optional Discord-role check for AOP changes. Permissions mentioned in the packaged README include:

cfg

add_ace group.admin riven.aop allow
add_ace group.admin riven.staff allow
add_ace group.admin riven.priority allow
add_ace group.police riven.responder allow

These are examples, not a recommendation to grant access to groups that do not exist on your server. Match them to the server's actual principal/group setup.

For the optional Discord role lock, configure the guild and role IDs under Config.AreaOfPlay.DiscordRole. The associated bot token belongs in a server-only setting:

cfg

set riven_discord_bot_token "YOUR_BOT_TOKEN"

Never put the token in shared config.lua, documentation screenshots, or a support ticket. The Discord role check requires a suitable bot and a usable player Discord identifier; read the included README before enabling this route.

Troubleshooting

Chat history does not display: Confirm chat is installed and started before riven_hud, and check whether another chat theme is active.

Chat or mouse remains focused: Ensure you are using the intended stock chat resource and have not installed another competing input replacement. Review console errors before restarting resources.

Postal value is missing: Check Config.Postal.Resource against the installed postal resource name. A missing postal integration should not be mistaken for a HUD startup failure.

Location duplicates another UI: Review Config.VehicleMode.HideLocation and the layout of the vehicle dashboard.

An AOP command is denied: Check the effective ACE permissions and, if enabled, the Discord role-lock configuration. Do not share the bot token during troubleshooting.

Troubleshooting Request support Product page