DOCSEARCHbyAlgolia
Submit Docs

Qbox Documentation

website·Indexed 32 days ago

https://docs.qbox.re

Documentation for Qbox, a framework for FiveM servers. Includes guides on installation, conversion from QBCore, developer guidelines, and detailed API references for core resources such as qbx_core, qbx_management, qbx_vehicles, and qbx_garages.

Tokens
43.5K
Snippets
217
Records
390
Agent score
62%

What's inside Qbox

  1. Overview of FiveM Custom Weapon Audio features

    The Custom Weapon Audio script for FiveM provides immersive, high-quality weapon sounds streamed server-sided. Key technical features include:

    • Native Audio Engine: Uses the native GTA 5 audio engine rather than external resources like xsound or interact-sound, avoiding 'fake' 3D audio.
    • Server-Sided Streaming: Audio is streamed from the server, eliminating the need for individual client-side downloads and ensuring audio consistency across all players.
    • Customization: Includes original XML files, allowing developers to adjust, swap, or add weapon sounds.
    • Sound Library: Comes with 13 unique audio items: 7 pistols, 2 LMGs, 2 SMGs, and 1 rifle.

  2. Overview of Qbox Resource Cache

    The Resource Cache is a global CDN (powered by Cloudflare) that sits in front of your FiveM server's resource downloads (scripts, maps, vehicles, clothing). Instead of every player downloading files directly from FXServer, the cache fetches each file once from your server and serves it to all subsequent players from a location near them. This prevents network thread hitches, reduces rubber-banding during restart waves, and speeds up join times for players in different geographic regions.

  3. Overview of Qbox Casino Slots features

    The Casino Slots script for FiveM provides fully functional slot machines with networked sounds, seamless animations, and local object handling to avoid entity ownership issues. It is compatible with sv_enableNetworkedSounds and SetRoutingBucketEntityLockdownMode. Key capabilities include:

    • Support for multiple locales.
    • Configurable slot models: Define specific models as 'penny slots' or 'VIP' with unique rewards and betting amounts per model.
    • Integrated logging with support for custom logging services.
    • Access control: Ability to restrict machine usage by integrating custom casino membership logic.

  4. Overview of Zumble managed Mumble server

    Zumble is a managed Mumble voice server optimized for FiveM. It serves as a drop-in replacement for the default Mumble server bundled with FXServer. It is specifically tuned for FiveM's voice usage patterns, such as small audio packets, high frequency of channel creation/removal, and constant player proximity changes. Using Zumble resolves the 'robotic voice' effect common at high player counts and reduces pressure on the FXServer network thread.

  5. Overview of Qbox Logging for FiveM

    Qbox Logging provides a dedicated virtualized machine running a full observability stack (Grafana, Loki, and Prometheus) for FiveM servers. This allows server owners and developers to centralize logs, track resource health, investigate player reports/abuse, and build custom dashboards for gameplay, economy, and staff activity without the limitations of shared hosted platforms.

  6. Overview of Qbox CDN for FiveM

    The Qbox CDN is a Cloudflare-powered content delivery network specifically built for FiveM servers to provide fast, reliable, and permanent hosting for static assets. It is primarily used for in-game phone scripts (player photos), generated screenshots, profile images, and evidence photos, replacing fragile temporary file hosts.

  7. Set server information and social links on the portal

    You can provide context and external links to players on your portal page:

    • Tagline: A short description (up to 120 characters) appearing under the server name.
    • About: A detailed description (up to 2000 characters) of the server and expectations. Plain text with line breaks preserved.
    • Discord invite: Must be a discord.gg or discord.com/invite link. This is shown to players even when no applications are open.
    • Website, Store, and Rules: Any valid https:// links. If left empty, these buttons are hidden from the page.

  8. Understand the Qbox Applications workflow

    Qbox Applications automates the process of managing whitelists, staff recruitment, or program applications. The workflow consists of four main stages:

    1. Form Creation: Build and publish a form in the dashboard.
    2. Player Application: Players apply via a portal page (apply.qbox.re/<your-slug>) using Discord authentication.
    3. Staff Review: Applications appear in the dashboard and are posted to a designated Discord staff channel with voting/decision buttons.
    4. Outcome: Accepting, denying, or moving an applicant to an interview sends a Discord notification to the player and automatically manages their Discord roles based on the form settings.

  9. Qbox Dashboard service overview

    The Qbox Dashboard provides a centralized location to manage the following services for FiveM servers:

    • CDN (Media, Retention & cleanup, API keys): Hosting images, video, and audio for phone scripts and resources.
    • Database Backups: Automatic off-site backups of the game database.
    • Logging: Dedicated Grafana and Loki instances for server logs.
    • Nucleus: A replacement for the retired Cfx.re Nucleus web address.
    • Zumble: Managed Mumble voice servers.
    • Resource Cache: Global CDN for player-downloaded resources.
    • Applications: Whitelist and staff application forms.
    • Discord: Management of connected Discord servers.
    • Team & Access (Members, Roles, Audit log): User and permission management.

  10. Configure page access levels

    Most pages use three access levels: No access, View, and Manage. Some pages have granular levels accessible via the Advanced switch in the role editor.

    Standard Page Permissions:

    • Overview: View (Storage totals/upload activity).
    • Media: View (Browse/download) $\rightarrow$ Manage (Upload/move/rename/delete).
    • Retention & cleanup: View (See rules) $\rightarrow$ Manage (Create/change/run rules).
    • API keys: View (See keys/usage) $\rightarrow$ Manage (Create/reveal/restrict/revoke) [Sensitive].
    • Database backups: View (History/status) $\rightarrow$ Manage (Download/rotate token/change schedule) [Sensitive].
    • Logging: View (Grafana Viewer) $\rightarrow$ Manage (Setup/restart/Loki password/Grafana Editor).
    • Nucleus: View (Proxy address/status) $\rightarrow$ Manage (Change server address/hostname/domain).
    • Zumble: View (Voice server status) $\rightarrow$ Manage (Setup/restart/schedule/remove).
    • Resource cache: View (Status/traffic) $\rightarrow$ Manage (Setup/change/purge/rotate key).
    • Discord: View (Connected servers/health) $\rightarrow$ Manage (Connect/disconnect) [Sensitive].
    • Roles: View (See roles) $\rightarrow$ Manage (Create/change/delete) [Sensitive].
    • Audit log: View (Read log).

    Granular Permissions (Applications):

    • View: Read submitted applications.
    • Review: Vote and leave internal notes.
    • Decide: Accept/deny/move to interview and message applicants.
    • Manage: Build forms and change settings.

    Granular Permissions (Members):

    • View: See members and pending invitations.
    • Invite: Invite people and cancel invitations.
    • Manage: Change roles, remove members, configure Discord role access [Sensitive].

  11. Understand Qbox and QBCore compatibility

    Qbox is a fork of QBCore that has been refactored for better code quality, security, and performance, with deep integration for overextended (ox) resources. It includes a bridge layer for backwards compatibility, meaning most QBCore scripts will work without modification. However, scripts that use undocumented or improper methods—such as direct database table access or accessing internal qb-core files not intended for external use—will not be compatible.

  12. Manage Grafana user roles via Qbox Dashboard

    Grafana accounts for staff are managed automatically through the Qbox dashboard. You do not need to create accounts or send invites within Grafana. Access is determined by the 'Logging' permission assigned to a user's role in the dashboard. If a user has multiple roles, the highest Logging level is applied. Note that the built-in Admin, Member, and Viewer roles all include 'Logging: View' by default.