Start with verified facts.

BYPHICS HUD is a standalone FiveM presentation resource covering the Vehicle HUD, Player HUD, Settings, Notifications, Action Prompts, Radio, Route, Environment and semantic SFX systems.

Run one owner for overlapping HUD, Settings, Player HUD and SFX surfaces. If another resource currently owns those surfaces, complete its supported migration before enabling BYPHICS HUD.

• A current FiveM / FXServer resource runtime with Lua 5.4 support.
• One resource directory named exactly byphics-hud.
• Optionally, one supported Player HUD framework provider.

The Vehicle HUD, Settings, Notifications, prompts, SFX, Radio, Route, Environment and Server Policy are framework-independent.

1. Copy the verified customer payload to resources/[local]/byphics-hud.
2. Set Config.Locale and Config.Compatibility.Framework in config/base.lua.
3. Review config/hud.lua and the server-only config/policy.lua.
4. Start exactly one applicable framework first, then start BYPHICS HUD.

# Start one selected framework first, when used.
ensure qb-core
# ensure qbx_core
# ensure es_extended
# ensure esx_status  # optional ESX needs provider

ensure byphics-hud

Join with a loaded player and open Settings with byphudsettings or the default F6 mapping. When multiple frameworks are intentionally active, select one explicit provider instead of auto.

config/base.lua controls Debug, locale and provider selection. Valid providers are auto, qb, qbx, esx and standalone. Invalid values normalize to auto; invalid locale values normalize to English.

config/hud.lua contains product defaults for SFX, seat visibility, units, adaptive profiles, fuel and engine warnings, fuel adapters, route presentation, Settings bounds and the module registry.

• Supported vehicle units: KM/H and MPH.
• Optional fuel adapter order: qb-fuel, LegacyFuel, ox_fuel, then native truth.
• Debug defaults off and should remain off in production.

Authored geometry, semantic thresholds, renderer constants and the 33 ms RPM presentation lane are product behavior, not buyer configuration.

Settings provides a canonical preview before Apply. Validated preferences are stored locally under the product KVP key and are resolved beneath server-owned policy.

Buyer-safe controls cover adaptive or fixed profile, surface, accent or permitted custom HEX, glow, units, anchor, bounded position and scale, reduced motion, radio visualization, modules, Player HUD, audio families and notification preferences.

Apply validates and persists the current draft, then closes Settings and restores gameplay control. Cancel or close discards the draft. Reset returns customizable fields to the server-policy or product-default baseline in the current draft; Apply is still required to persist it.

Existing validated preferences can be imported from a configured legacy owner without editing the legacy value.

Verified vehicle profiles are Modern Precision, Modern Ultra, Modern Linear and Heritage. Surface expressions are Open, Frameless and Glass; the selected profile remains the same product system across those material treatments.

Vehicle modules include speed, RPM, fuel, environment, session, orientation, radio, navigation, vehicle condition and the context strip. Speed is product-required. Player HUD covers wallet/bank, needs/status and voice when authentic provider data is available.

Unavailable fields stay hidden rather than displaying fabricated values.

The server-only policy resolves over player preferences. It can provide defaults, force or lock scalar settings, allow or deny custom HEX and positioning, and enable, require or disable modules.

Policy does not replace stored preferences; a dormant player choice can return when a lock is removed. Increment revision after a meaningful policy change and restart byphics-hud.

Policy transport and internal lifecycle events are not public integration APIs.

The public client contract supports localized notifications, updates, dismissal and per-player notification settings. Reviewed variants are neutral, info, success, warning and danger, with low through critical priority and bounded lifetime options.

Action prompts support press and hold interactions, control or command bindings, and available, disabled or busy states. Consumers should clear their owned HUD state when an interaction ends or a resource stops.

Use the documented product exports and events from the customer package. Internal Settings, policy, suppression and provider lifecycle events are not frozen public contracts.

The candidate contains 23 semantic local SFX across interface, vehicle, notification and inventory behavior. Settings can control the master state and family-level audio categories; the public API accepts registered semantic identifiers rather than arbitrary file paths.

Concurrency, gain, cooldown and voice ducking are product-managed defaults. Do not treat individual audio files as a separately licensed asset library.

The reviewed candidate includes English and Spanish locale tables with matching key coverage. Select en or es using Config.Locale; unsupported values fall back to English.

Localized notification contracts accept parameters. Literal server data is accepted only through the documented provenance paths in the customer API contract.

Automatic provider priority is Qbox, then QBCore, then ESX. An unavailable explicit provider falls back to standalone and does not borrow data from another framework.

• Confirm the folder is named byphics-hud and starts after the selected framework.
• Confirm only one resource owns overlapping HUD, Settings and SFX surfaces.
• Confirm Settings Apply closes the interface and restores gameplay controls.
• Confirm the Vehicle HUD follows configured seat ownership.
• Confirm unavailable Player HUD fields remain hidden.
• Confirm a resource restart restores validated preferences.
• If automatic provider selection is ambiguous, configure one explicit provider.

Debug commands require Config.Debug = true and are bounded troubleshooting tools. Disable Debug after diagnosis.

The version field in the customer payload's fxmanifest.lua is the sole product-version authority. The reviewed candidate identifies itself as 1.0.0-rc.

• Qbox and ESX still require isolated live certification before either can be advertised as live certified.
• The remaining QBCore PlayerData mutation observation is open.
• Commercial license/EULA, distribution terms and delivery workflow are not final.
• The website identity fonts and vectors are authorized for this website launch; customer-package SFX, licensing and delivery remain separate release decisions.
• No published customer update policy or final changelog exists yet.

This documentation is the current public support entry point. No public support email, ticket destination or Discord invitation is listed.

When reporting an issue through an authorized support destination, record the resource version, selected framework, relevant resource start order, whether Debug was temporarily enabled and the smallest reproducible symptom. Never include credentials or private server data.