OsmFX Referral Hub
Reward the players who grow your city — beautifully.
Overview
Turn word-of-mouth into a system your players feel.
OsmFX Referral Hub is built for server owners who are tired of manual spreadsheets and vague “invite a friend” posts. When someone new joins, they meet your branding first: a clear entry screen where they can enter a friend’s code (or skip), see what both sides earn, and understand why sticking around matters. Returning players aren’t nagged on every alt — the experience is tied to their account in a fair, one-time way so multi‑character servers stay sane.
Your promoters get a proper player dashboard: copy‑paste codes, watch pending rewards turn into cash or items, climb Bronze → Legend tiers for bigger multipliers, unlock milestone goals, chase time‑limited bounties, and keep daily streak bonuses when they deliver day after day. Streamers and partners can create extra labelled tracking codes (“YouTube”, “TikTok”, “Event night”) so you finally see which channels actually bring players — not just which ones shout the loudest. Optional surveys capture “how did you hear about us?” with answers your staff can read in the admin panel. A server‑wide leaderboard and full reward history keep the competition friendly and transparent.
Behind the scenes, staff get their own control room: tune rewards, wait times, feature toggles, Discord webhooks, and five cinematic theme presets (Obsidian, Midnight, Carbon, Ember, Arctic) so the UI feels like your city — not a generic template. One package runs on QBCore, QBox, or ESX. It’s open source: the full script ships with your download so your team can audit, customise, and ship the tweaks your community asks for — no black box.
Key Features
Full script, your rules
Open source delivery — you own the files. Rebrand, rebalance, or extend without waiting on us; ideal if you vet everything that touches your economy.
Fair for alts & mains
One referral identity per player license — the welcome screen runs once, rewards stick with them across characters, and veterans aren’t spammed every time they roll a new toon
Creator & partner codes
Extra labelled links (“YouTube”, “TikTok”, “Partner”) with their own stats so you know which shout-outs actually fill the server
Tiers & milestones
Bronze through Legend — bigger multipliers as referrers level up, plus one-shot milestone payouts when they hit the numbers you celebrate
Bounties & events
Limited-time pushes with clear goals, dates, and optional caps — perfect for launch week, anniversaries, or collab drops
Streak bonuses
Reward consistency — consecutive referral days add extra juice on top of normal payouts so your grinders feel seen
Surveys that inform RP
Ask multiple-choice, rating, or short-answer questions on entry or inside the dashboard — read responses where you already manage the server
Leaderboard & receipts
Friendly competition with a live top referrers board plus a searchable history every time money or items move
Themes & branding
Five ready-made looks plus your server name, logo, and accent — so the hub matches your city’s vibe without hiring a designer
Detailed Script Features
A first impression that feels like your server
New players see your name, logo, and rewards before they finish creating a character — they can enter a friend’s code or skip, always knowing what’s in it for them. Returning players aren’t pestered on every alt; the flow respects how real communities actually play.
Surveys — hear how players actually found you
Stop guessing whether TikTok, Discord, or a friend brought someone in. Ask short, friendly questions when they arrive or from the dashboard — then read answers in admin alongside the rest of your referral data.
Player dashboard — everything promoters care about
Your community opens one place to copy their code, claim what they’ve earned, watch bounties tick down, climb tiers, and brag on the leaderboard — with a full reward history when they want receipts.
Admin panel — run the program, not the spreadsheet
Staff tune branding, themes, rewards, surveys, bounties, milestones, and safety tools from inside the game — change the economy’s behaviour when your season changes, without waiting on a developer for every number.
Rewards & reliability — built for real economies
Pay people the way your server already thinks about money and items — with optional Discord heads-up when you want the team to see joins and redemptions in real time.
Technical Specs
Requirements
Quick Setup
- 1Unpack the Tebex download into `resources/[osmfx]/osm-referrals` — the directory name must stay `osm-referrals` for FiveM.
- 2Add the character-creation hook for your framework (qb-interior, qbx_core `character.lua` ×2, or esx_multicharacter) per the README inside the archive.
- 3Import `referral.sql` into your database (safe to re-run; uses IF NOT EXISTS / INSERT IGNORE).
- 4Edit `config.lua`: set `Config.Framework`, `Config.CharCreationEvent`, admin groups, and optional Discord webhook.
- 5Start your framework and dependencies first, then `ensure osm-referrals`. Console should report the framework adapter loaded.
Frequently Asked Questions
Version History
2026
- Initial OsmFX Referral Hub release — open source Lua + React 18 + TypeScript NUI (player dashboard + admin panel)
- Tiers, milestones, bounties, streak bonuses, tracking codes, surveys, leaderboard, reward history
- Five theme presets (Obsidian, Midnight, Carbon, Ember, Arctic) with admin-selectable branding
- Full adapter pattern for QBCore, QBox (qbx_core), and ESX with documented character-creation hooks
- 13-table MySQL schema with seeded defaults; optional Discord webhooks; 2K/4K UI scaling
![[OPEN] OsmFX Vehicle Stickers | QB/QBX/ESX](/images/vehicle-stickers/vs-1.webp)
![[OPEN] AI Law Enforcement | QB/QBOX/ESX](/images/ai-law-enforcement/AIP-1.webp)