Configuration

Welcome to the complete configuration for Koja-Crafting. This guide will help you configure, customize, and optimize your crafting system.

📖 Overview

This repository contains the main configuration and resource structure for Koja-Crafting. For full installation instructions, see the Installation Guide.

  • Installation Guide: LINK

📋 Configuration File Structure

koja-crafting/
├── shared/
│   └── config.lua ..................... Main configuration file
│       ├── GENERAL SETTINGS .......... Debug, locale, movement
│       ├── SERVER SETTINGS ........... Database, recovery
│       ├── IMAGES SETTINGS ........... Image paths, formats
│       ├── PLAYER PROGRESSION ........ Levels, starting values
│       ├── ADMIN PERMISSIONS ......... Admin groups
│       ├── INTERACTION SETTINGS ...... Target, key press
│       ├── CRAFTING QUEUE SETTINGS ... Distance, warnings
│       └── CRAFTING STATIONS ......... Stations, items, blueprints
├── locales/
│   └── *.json ......................... Language files
└── web/build/images/ .................. Item images

🎯 Common Configuration Tasks

Basic Setup (First Time)

1

Install dependencies

See: ../INSTALLATION.md#download-and-install-dependencies

2

Setup database

See: ../INSTALLATION.md#database-setup

3

Configure server.cfg

See: ../INSTALLATION.md#configure-servercfg

4

Set language

See: GENERAL-SETTINGS.md#language--locale

5

Test installation

See: ../INSTALLATION.md#testing-your-installation

Adding Content

1

Add crafting station

See: CRAFTING-STATIONS.md#adding-new-stations

2

Create categories

See: CRAFTING-STATIONS.md#categories

3

Configure items

See: CRAFTING-STATIONS.md#items-configuration

4

Add custom images

See: IMAGES-SETTINGS.md#adding-custom-images

5

Test items

See: CRAFTING-STATIONS.md#troubleshooting

Customization

1

Change interaction method

See: INTERACTION-SETTINGS.md#configuration-examples

2

Adjust progression speed

See: PLAYER-PROGRESSION.md#progression-curves

3

Configure image sources

See: IMAGES-SETTINGS.md#configuration-examples

4

Setup distance restrictions

See: CRAFTING-QUEUE-SETTINGS.md#configuration-examples

5

Configure blips

See: CRAFTING-STATIONS.md#blip-configuration

Admin Tasks

1

Setup admin permissions

See: ADMIN-PERMISSIONS.md#configuration-examples

2

Give blueprints to players

See: COMMANDS.md#add-blueprint-command

3

Grant experience points

See: COMMANDS.md#add-experience-command

4

Manage player progression

See: PLAYER-PROGRESSION.md#admin-commands

📚 Additional Resources

Official Links

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

  • Store: https://kojascripts.eu

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

  • GitHub: https://github.com/Koja-Scripts

📝 Configuration Checklist

Before going live, verify:

🔄 Update Process

1

Backup

Save current shared/config.lua

2

Read Changelog

Check for breaking changes

3

Update Files

Replace resource files

4

Restore Config

Copy back your config (check for new options)

5

Check Database

Run any new SQL migrations if provided

6

Test

Verify everything works on test server

7

Deploy

Update live server

📞 Getting Support

Before Asking for Help

1

Read relevant documentation page

2

Check troubleshooting sections

3

Enable debug mode and check console

4

Search Discord for similar issues

5

Try on clean test server

When Asking for Help, Provide

  • Server framework (ESX/QBCore)

  • koja-crafting & koja-lib version

  • Error messages from console

  • Config sections related to issue

  • Steps to reproduce problem

  • What you've already tried

Support Channels

  • Discord Tickets: Best for complex issues

  • Discord Quick Support: Quick questions

  • Documentation: Self-service answers

Happy Crafting! 🎨

PreviousINSTALLATIONNextGeneral Settings

Last updated