Skip to content
Retro Docs

Retro Radial

Introduction

Section titled “Introduction”

rs_radial is a premium orbit-style radial menu for FiveM.

It is built around a center hub + ring of items, a runtime API for adding/removing entries from other resources, server-authoritative validation, a customizable theme/scale/position system, and an optional ox_lib compatibility bridge.

Core Capabilities

Section titled “Core Capabilities”
  • Orbit-style radial menu with a center hub and dynamically arranged items.
  • Hold-to-open keybind with configurable open mode and close-on-select behavior.
  • Multi-page navigation (main → subpages → back).
  • Runtime API for other resources to add, remove, update, and submenu items at runtime.
  • Per-player customization: theme colors, menu scale, menu position, item order, sound effects.
  • Vehicle Control bar with driver-only permissions, position/color customization, and multiplayer sync of seat / door / window / engine / neon state.
  • Predicate registry for reusable canSee callbacks shared across items.
  • Per-item cooldowns enforced both client- and server-side.
  • Async actions (NUI spinner + server-confirmed completion).
  • Per-item confirmation, input, and select modals.
  • Server-side validation that re-checks item visibility before dispatching.
  • Discord webhook logging for security events and item usage.
  • Drop-in ox_lib radial bridge: third-party scripts that call lib.addRadialItem are forwarded into rs_radial without code changes.

Product Model

Section titled “Product Model”

rs_radial is the radial menu system.

It handles:

  • menu state and navigation
  • item rendering and dispatch
  • icon system (built-in / SVG / PNG / Font Awesome class / external URL)
  • theme and per-player preferences (KVP-persisted)
  • vehicle control surface and clothing page (auto-built from config)
  • favorites and blips pages (dynamic, per-player)
  • server-side validation and Discord logging

It is not a phone/inventory/job framework. It integrates with QBCore, Qbox, and ESX for job/gang/duty resolution, and with ox_inventory or qb-inventory for reqItems checks. Everything else is delegated to the events the items dispatch.

Typical Use Cases

Section titled “Typical Use Cases”
  • Replacing a server’s existing radial / quick-action menu with a more polished UI.
  • Centralizing job actions (cuff, jail, repair vehicle, revive) behind job-gated pages.
  • Letting other resources add their own entries at runtime via the export API.
  • Drop-in replacement for scripts that target ox_lib’s radial API.