Skip to content

Start

Your data choices

During setup you decide how the agent reads your database and what it may send. Every choice can be changed later.

Database access

The agent needs to read player data from your database. You choose how.

Separate read-only accountRecommended

The agent creates a new database login that can only read the data you allow. Its password stays on your server. You can inspect or delete the account at any time.

Use existing connection

The agent uses the login your FiveM server already has. It only runs read operations, but that login itself may have broader rights. Its password stays on your server.

The two options in the Database access step. The first is recommended whenever your database allows it.

If your database login is not allowed to create other logins, the recommended option is not available. You can give your FiveM database user that right (or ask your host) and press Check again. The setup page has a short How? guide for that. Or you choose the existing connection. We never switch to it without asking.

For the setup

In the Data use step you tick what may leave your server. It has three groups.

For the setup

Database structureA few example rows, redacted

For your reports

MoneyItems and weaponsCharacter namesJobs and gangsVehiclesBank transactionsOther script dataPlay sessions

For crash reports

Server health

Never sent: database passwords, license keys, Discord ids, IP addresses and hardware ids.

The data use step has three groups. Nothing is ticked for you except Server health on a new server.

The first two options help us recognise your framework. They are only used during setup.

  • Database structure

    Table and column names and their types. No rows, no values, no passwords.
  • A few example rows, redacted

    At most 5 rows per kind, with characters shown as A, B, C. You see them in the Meanings step. Deleted after 7 days.

For your reports

These are collected continuously. Tick only what you want to ask about. Select everything ticks all of them.

  • Money

    Cash, bank and dirty money per character, and how they change.
  • Items and weapons

    What each character carries, and when counts change.
  • Character names

    In-game names only, so reports can say who. No real names.
  • Jobs and gangs

    Job, rank and gang of each character.
  • Vehicles

    Owned vehicles with plate, model and whether they are in a garage.
  • Bank transactions

    Deposits, withdrawals and transfers from your banking script, with amount and type.
  • Other script data

    What your scripts keep about properties, businesses, jail time, plants and more. Amounts and states only.
  • Play sessions

    When players join and leave, from txAdmin. For activity and peak times.

Amounts are game money

Everything here is in-game data. A character is one of a player's characters, and one player can have several.

Server health

Server health is for crash reports and the health monitor. It covers CPU, memory and disk of the machine, the FXServer log with passwords and keys removed, and crash dumps. It works without database access.

On a new server it is ticked by default. You can untick it like any other option.

More in Crashes and health.

Custom scripts

Many scripts are read out of the box. If one of yours is not, open Custom tables in the server settings. Pick a table, and we work out what it holds from a small redacted sample. You confirm the result in plain language before anything is read. This needs the database structure and example rows allowed.

If a script update changes the table, reading stops and you are asked to confirm again. You can also ask us to support a script, which helps us decide what to add next.

Changing your choices

Open the server settings and then Data access. Tick or untick what you want and press Save changes. Unticking stops new data of that kind. What was already collected runs out after its normal time, see How long data is kept.

Only the owner can change data access.