gfx-lumberjack

A lumberjack job script for FiveM with a full NUI interface, leveling system, axe tier upgrades, contract system, leaderboard, and tutorial mode.

Info

Dependencies

Installation

1. Import SQL Tables

Import both SQL files into your database:

-- lumberjack.sql
CREATE TABLE IF NOT EXISTS `gfx_lumberjack`(
    `id` int(11) NOT NULL AUTO_INCREMENT,
    `citizenid` varchar(50) DEFAULT NULL,
    `lumberjackName` varchar(50) DEFAULT NULL,
    `cuttingTrees` int(11) DEFAULT 0,
    `level` int(11) DEFAULT 0,
    `total_money` int(11) DEFAULT 0,
    `profile_photo` varchar(250) DEFAULT "",
    PRIMARY KEY (`id`),
    KEY `citizenid` (`citizenid`)
) ENGINE=InnoDB AUTO_INCREMENT=1;

-- lumberjackcontract.sql
CREATE TABLE IF NOT EXISTS `gfx_lumberjack_contract`(
    `id` int(11) NOT NULL AUTO_INCREMENT,
    `citizenid` varchar(50) DEFAULT NULL,
    `contractOwner` varchar(50) DEFAULT NULL,
    `treeCount` varchar(50) DEFAULT NULL,
    `percent` int(11) DEFAULT 0,
    `numberOfUses` int(11) DEFAULT 0,
    `profile_photo` varchar(250) DEFAULT "",
    PRIMARY KEY (`id`),
    KEY `citizenid` (`citizenid`)
) ENGINE=InnoDB AUTO_INCREMENT=1;

2. Copy Resource

Copy the gfx-lumberjack folder into your server's resources directory.

3. server.cfg

ensure oxmysql
ensure qb-core   # or es_extended
ensure gfx-lumberjack

4. Steam Web API Key (optional)

If Config.ProfilePhotoType is set to "steam", you must have a Steam Web API key configured in your server.cfg.

Configuration

All configuration is in config.lua.

General Settings

Job NPC and Blip

Money and Cutting

Tutorial Section

Axe Tiers

Players unlock better axes as they cut more trees. Higher tier axes provide a bonus percentage on earnings.

Contract Settings

Tree Locations

Config.lumberjack.TreeLocations is an array of vector3 positions where trees can be cut. The script randomly selects the next tree location from this list (ensuring the player is not sent to their current position). 14 locations are provided by default in the Paleto Forest area.

Notification Texts

All player-facing notification strings can be customized in Config.NotifyTexts:

Exports

No exports found. This script does not create any exports via exports().

Events

No public API events found. All registered events are internal to the script (client-server communication and NUI callbacks) and are not intended for use by external scripts.

Commands

No commands found. Interaction with the job is done through the NPC using a target system or drawtext.

Features

Lumberjack Job

• Interact with the lumberjack NPC to open the job UI
• Start/stop the job at any time through the NUI panel
• Random tree selection with checkpoint and blip navigation
• Cutting animation with player freeze during the action
• Configurable cutting duration

Tutorial Mode

• Introductory mode where players carry logs between two points instead of cutting trees
• Uses a carry animation with a log prop attached to the player
• Separate start and end checkpoints with blips

Leveling System

• Players level up by cutting trees (configurable trees-per-level threshold)
• Level tracked in the database and displayed in the UI
• Level gates access to contract creation

Axe Tier Upgrades

• Three axe tiers unlocked by total trees cut
• Each tier uses a different prop model and provides an earning bonus
• Tier 1: Stone hatchet (0% bonus, default)
• Tier 2: Hatchet (20% bonus, unlocked at 50 trees)
• Tier 3: Fire axe (40% bonus, unlocked at 100 trees)

Contract System

• Players at the required level can create contracts for others to complete
• Contracts specify a tree count and a bonus percentage
• Contract creators earn money when other players complete their contracts
• Contracts have a limited number of uses before being removed
• Players can only have one active contract at a time
• Offline contract owners receive their earnings directly via database update

Leaderboard

• NUI leaderboard showing top 30 players
• Displays player name, trees cut, total earnings, and profile photo
• Supports Steam and Discord profile photos

NUI Interface

• Full HTML/CSS/JS interface for job management
• Real-time work time tracker, trees cut counter, and money earned display
• Pages for: job start/stop, leaderboard, contracts (view/create/take/delete)

Interaction Methods

• qb-target: Target model interaction on the NPC
• ox_target: Target model interaction on the NPC
• drawtext: 3D text prompt with key press interaction

Framework Support

• Auto-detects QBCore or ESX at startup
• Framework-specific money handling (AddMoney / addAccountMoney)
• Framework-specific server callbacks

Database

• Persistent player data (level, trees cut, total money, profile photo)
• Persistent contract data (owner, tree count, percent, uses remaining)
• Supports oxmysql, mysql-async, and ghmattimysql

Troubleshooting

Source

• GitHub: https://github.com/gfx-fivem/gfx-lumberjack
• Organization: GFX-Fivem