Skip to main content
Animal FarmDeprecated

Installation

Install the farming resource and configure its database, framework, translations and TypeScript build.

Required dependencies​

MySQL

Database support installed and bundled through npm.

Node.js

Required for dependency installation and compilation.

FiveM artifact 4752+

Required for Lua 5.4 and escrow support.

OneSync

Required for server-side teleporting and distance handling.

Installation steps​

  1. 01

    Extract the resource

    Copy the package into your resources directory and keep its required name.

    aquiver_animalfarm
  2. 02

    Install dependencies

    Run the included npm dependency installer.

    dev/install_dep.bat
  3. 03

    Review the configuration

    Configure the documented shared resource settings.

    source-files/shared/shared-config.ts
  4. 04

    Import the database

    Import the included SQL file into your server database.

  5. 05

    Configure the server

    Select your framework and database resource.

    server.ts
  6. 06

    Configure the client

    Select your framework in the client configuration.

    client.ts
  7. 07

    Configure translations

    Edit the shared translation strings.

    source-files/shared/shared-translations.ts
  8. 08

    Compile the resource

    Compile the TypeScript files after completing the configuration.

    dev/compile.bat

Aquiver module config​

Configuration

Module configuration

Configure the framework, database and Animal Farm resource settings.

import * as Aquiver from '@freamee/server';
Aquiver.Config.Framework = 'ESX_LEGACY';
Aquiver.Config.SqlDebug = false;
Aquiver.Config.sqlResource = 'oxmysql';
/** If you set this true then the loot pickups (boxes) will give you items instead of instant money. */
Aquiver.Config.ResourceExtra.GiveLootAsItems = false;
/** Set item names, only needed if you set to give loot as items. */
Aquiver.Config.ResourceExtra.ItemNames = {
    egg: 'bandage',
    meal: 'gold',
    milk: 'iron',
};
Aquiver.Config.ResourceExtra.selectedAccount = 'bank';