Koja Scripts

Installation

Read the entire installation process to ensure the resource is fully usable.

Installation

Requirements

Install and start these dependencies before KOJA HUD:

  • koja-lib — required. It detects your framework (ESX, QBCore or Ox) and provides money, job, key bind and callback helpers.
  • oxmysql — required. The server script loads it even when the nitro system is off.
  • pma-voice — used for the voice bar by default. See KOJA.Microphone in Configuration to change this.
  • Node.js — only when you rebuild the web UI from source.

The resource needs lua54 and the gta5 game, both already declared in its fxmanifest.lua.

Install

  1. Place the koja_hud folder in your resources directory.
  2. Add it to server.cfg after its dependencies:
ensure koja-lib
ensure oxmysql
ensure koja_hud
  1. Open editable/shared/config.lua and adjust the options you need.
  2. Restart the server.

The web UI is shipped prebuilt in web/build. You do not need Node.js unless you change the interface.

First start

  • Nitro adds one nitro column to your vehicles table automatically. See Database.
  • The resource streams the files in its stream folder (squaremap.ytd, minimap.gfx and graphics.ytd) to give the minimap its square shape. Do not run a second script that replaces the minimap.
  • Each player's personal settings are saved in their own game client. The first time they join they receive the defaults from editable/shared/js.json.
  • Players open the settings menu with /settings.

Rebuilding the web UI

Only needed if you edit files in web/src.

cd web
npm install
npm run build

npm run build writes to web/build. Restart the resource after building.

  • Configuration — Changing Language, Debug Prints, Settings Command, Hide Minimap, Notifications, Nitro, Engine, Seatbelt and Cruisemode.
  • Guides — Creating/Editing Locales, Progress Bar, Text UI and Stress.
  • Features
  • Exports & Commands
  • Database
  • HUD — back to the section overview