Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Installation

Welcome to Koja-Crafting, a fluent crafting system designed to enhance gameplay on your FiveM server. This guide will walk you through the installation process step by step.

📋 Requirements

Before installing Koja-Crafting, ensure you have the following dependencies:

  • koja-lib - Required library that must be started before koja-crafting

  • ox-mysql - Database resource

🚀 Installation

1

Download and install koja-lib

  1. Download koja-lib from the official repository

  2. Place it in your resources folder

Add to your server.cfg:

server.cfg
ensure koja-lib

koja-lib must be started before koja-crafting!

2

Install Koja-Crafting

  1. Download the koja-crafting resource

  2. Extract it to your resources folder

The folder structure should look like this:

resources/
├── koja-lib/
└── koja-crafting/
3

Database setup

You have two options for setting up the database:

Option A: Automatic Database Creation (Recommended)

  1. Open shared/config.lua

  2. Ensure this setting is enabled:

shared/config.lua
Config.CreateAutoTable = true

The script will automatically create all required tables on first start.

Option B: Manual SQL Import

  1. Open your database management tool (TablePlus, HeidiSQL, etc.)

  2. Import the koja-crafting.sql file

This will create three tables:

  • koja-crafting - Stores player progression (level, exp, blueprints)

  • koja-crafting-objects - Stores placed crafting station objects

  • koja-crafting-queue - Stores active and completed crafting queues

4

Configure server.cfg (order matters)

Add the following to your server.cfg in the correct order:

server.cfg
# Database
ensure oxmysql

# Dependencies
ensure koja-lib

# Crafting System
ensure koja-crafting

The load order matters! koja-lib must start before koja-crafting.

📚 Additional Resources

  • Documentation: https://docs.kojascripts.eu

  • Discord Support: https://discord.gg/kojascripts

  • GitHub: Check for updates and report issues

✅ Installation Complete! Your crafting system is now ready to use. Enjoy enhancing your server's gameplay experience!

PreviousCraftingNextConfiguration

Last updated