Docs/ORB Donations/Installation

Installation

Requirements

ResourceRequiredPurpose
ox_libYesCallbacks and notifications
oxmysqlYesPersistence — credit ledger, products, settings, codes
FrameworkOptionalQBox / QBCore / ESX — auto-detected
InventoryOptionalox / qs / qb / ps — for item & weapon products and their icons
PhoneOptionallb-phone, qs, gks, qb-phone… — for the private-number product

Without a framework the store still opens and credits still work, but money, vehicle and phone products are refused up front rather than sold and never delivered.

Install

  1. 01Drop orb-donations into your resources/ folder.
  2. 02Add to server.cfg:
cfg
ensure orb-donations

add_ace group.admin orb.donations allow
add_principal identifier.fivem:1 group.admin

No .sql to import — every table is created on first start. Coming from the old version, the credit balances in fivem_donatesystem are migrated automatically the first time this starts; the old table is left untouched.

Database

Tables are created and upgraded automatically on boot (idempotent — no DROP, no data loss):

  • orb_donations_credits — the credit ledger (one balance per identifier)
  • orb_donations_products, orb_donations_settings — the store and its live settings
  • orb_donations_codes, orb_donations_code_redemptions — redeem codes and who claimed them
  • orb_donations_transactions — Tebex transaction ids, so a replayed command never pays twice
  • orb_donations_purchases, orb_donations_admin_log — purchase history and an admin audit trail
  • orb_donations_vips, orb_donations_vip_tx — VIP subscribers and their per-cycle grants
  • orb_donations_admins — configured in-game admins and their per-admin permissions
  • orb_donations_drops, orb_donations_drop_state — the Drops pool and per-player roll state

Verify

The startup banner prints the framework, inventory, phone and vehicle-key resources it detected, and reminds you whenever the catalogue already has products — so an accidental re-seed can't wipe an admin's work unnoticed.