🧠 Installation

Already using TGG Banking or Billing? Start with the replacement guide.

Requirements

• FiveM artifact 6116 or newer, with OneSync enabled.
• ox_lib, oxmysql, and a working MySQL/MariaDB connection.
• Qbox, QBCore, ESX, or a completed standalone adapter.
• A supported inventory with debit-card items installed.

Standalone users must implement their server's money and player functions in client/custom/frameworks/standalone.lua and server/custom/frameworks/standalone.lua.

Install the resource

1. Download your edition from Cfx Portal. Place the folder containing fxmanifest.lua in your resources directory as tgg-finance.
2. Keep the built UI, stream files, and escrow .fxap intact. Do not mix releases.
3. Set the framework, inventory, and interaction adapters in config/config.lua. Each defaults to auto.
4. Install the inventory items below.
5. Start Finance after its dependencies and before resources that call its exports.

Example for Qbox with ox_inventory:

ensure oxmysql
ensure ox_lib
ensure qbx_core
ensure ox_target
ensure ox_inventory
ensure tgg-finance

Adapt this to your installed framework and inventory. Do not run tgg-banking or tgg-billing alongside Finance. Review other banking integrations before switching.

Debit-card inventory items

Merge inventory-items/ox-items.txt or inventory-items/qb-items.txt into your inventory's item registry and copy the supplied images to its image directory.

Default items: debitcard_personal, debitcard_shared, and debitcard_business.

Retain their non-stacking/unique behavior so cards keep individual metadata. The ox_inventory definitions call tgg-finance.UseCardOnAtm. Item names must match Finance settings; existing TGG Banking definitions can be retained.

Database initialization

Leave Config.AutoImportSQL = true. Startup uses server/database/sql/main.sql to create missing tables and adds required columns to existing TGG tables. There are no versioned SQL migrations to run. Fix any schema error before using Finance.

Manual SQL import with automatic initialization disabled is supported for fresh databases. Replacement installations need the automatic compatibility checks. Do not drop or recreate legacy tables.

Grant administrator access

For administrators already assigned to group.admin:

add_ace group.admin tgg-finance.admin allow
add_ace group.admin tgg-finance.atms allow

The second ACE grants ATM placement tools. See command permissions.

First-use check

On a test server, verify bank access, deposits, withdrawals, transfers, card issuance and ATM use. Create and pay an invoice; check company funds, tax, and commission. Confirm normal players cannot use /finance or /fsettings, and that saved settings survive a restart.

Read the known limitations, including Qbox offline-wallet behavior, before going live.