Riven Systems
New updatesLatest release notes

Product Documentation

RivenRealismHud

View product page
Documented build
1.11.0May differ from the current store release
Resource
riven_hud
Configuration
riven_hud/config.lua
Required dependencies
None; stock chat is needed for chat cards and theming.

Overview

RivenRealismHud 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. RivenRealismHud does not provide a duplicate speedometer, fuel gauge, RPM display, or vehicle instrument panel.

Installation

  1. Download the free version 1.11.0 ZIP through Dashboard → Downloads after saving your Discord ID and name, and copy the folder named riven_hud into resources/.
  2. For chat cards and theming, start FiveM's stock chat resource before the HUD. The HUD, minimap, AOP, peacetime and priority work without it.
  3. Add the following entry to server.cfg; no license key is required:
cfg
ensure riven_hud
  1. Ensure there is not another active chat theme fighting to style the stock chat interface.
  2. Adjust config.lua, then start the resource.

OneSync is optional. Without it, nearby chat uses client-side distance checks.

Location presets in 1.9.0

Choose a state or city through Config.Location.Preset in config.lua. The included presets cover Florida, California, Alabama, Pennsylvania/Philadelphia and more; philly is a shortcut. Read presets/LOCATION_PRESETS.md inside the ZIP for the full catalog and setup guide.

Presets supply street and intersection mappings, city/neighborhood and state labels, and AOP defaults and automatic tiers. Emergency /911 and /311 street labels use the same mappings. Custom street and zone overrides retain the selected preset as a base.

The default legacy preset preserves existing behavior; gta uses unmodified GTA labels. Changing presets resets a previously persisted AOP name while retaining other AOP, peacetime and priority state.

Player controls and commands

Command or keyFunction
/rivenhudOpen HUD appearance and placement settings
/rhconfigAlternate HUD configuration command
/rivenhudtoggleToggle HUD visibility
F9 or /rivenchatmodeSwitch chat history display mode
/rivenhelpShow the command list
/aopView the area of play
/aop <name>Change the area of play, subject to configured permissions
/aop autoEnable configured automatic AOP selection
/aopvote A | B | CStart an AOP vote, subject to permissions
/vote <number>Respond to an AOP vote
/pt on or /pt offControl peacetime, subject to permissions
/priorityRead current priority state
/priority startSet priority state, subject to permissions
/priority cooldown <minutes>Start a priority cooldown, subject to permissions
/priority hold or /priority availableChange 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.

Ultrawide alignment and colors in 1.10.0

Config.Minimap.UltraWideViewportFix = true enables automatic minimap viewport correction for 21:9 and 32:9 displays. Disable it only if another custom radar already compensates for the viewport; UltraWideFixAdjustment provides an optional adjustment and defaults to 0. Avoid running competing minimap-positioning resources. Final alignment with custom radar assets still requires in-game testing.

To restore automatic HUD anchoring, open /rivenhud → Position → Beside the minimap. Existing saved free-position settings are retained; Reset to defaults resets all settings.

Open /rivenhud → HUD Colors to change individual elements using 24 swatches, the color picker, or a valid #RRGGBB HEX value. Changes preview immediately; Save stores per-player settings, Cancel reverts changes, and Reset colors resets only colors. Server defaults are configured in Config.UI.Colors; older player settings inherit them. Location presets, chat, and AOP behavior remain unchanged. Read ULTRAWIDE_AND_COLORS.md inside the ZIP for details.

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.