Installation

This guide will walk you through installing prp-lumberjack on your FiveM server.

Installation steps

1

Download the resources

Download both prp-lumberjack and prp-lumber-assets from the CFX portal and place them in your resources folder.

2

Add to server.cfg

Add both resources to your server.cfg after all dependencies, with the assets resource before the main script.

ensure oxmysql
ensure ox_lib
ensure prp-bridge
ensure prp-lumber-assets
ensure prp-lumberjack

3

Add items

Add the required items to your inventory resource — see Items below.

4

Database

The required database table is created automatically on first run.

5

Configure

Open config/sh_config.lua to configure the job, tree types, weapons and sawmill settings.

6

Optional: inventory icons

Custom inventory icons are included in the installation/inventory icons folder. Copy them to your inventory resource's image directory if you'd like to use them.

Items

Add all required items to your inventory resource using the format appropriate for your setup.

Add items listed below to your ox_inventory into data/items.lua.

-- Logs
["oak_log"] = {
    label = "Low Softwood Log",
    weight = 10000,
    stack = false,
},
["cedar_log"] = {
    label = "Medium Softwood Log",
    weight = 10000,
    stack = false,
},
["pine_log"] = {
    label = "High Softwood Log",
    weight = 10000,
    stack = false,
},
["olive_log"] = {
    label = "Hardwood Log",
    weight = 10000,
    stack = false,
},
["forest_tree_log"] = {
    label = "Hard Hardwood Log",
    weight = 10000,
    stack = false,
},

-- Planks
["oak_plank"] = {
    label = "Oak Plank",
    weight = 100,
    stack = 50,
},
["cedar_plank"] = {
    label = "Medium Softwood Plank",
    weight = 100,
    stack = 50,
},
["pine_plank"] = {
    label = "High Softwood Plank",
    weight = 100,
    stack = 50,
},
["olive_plank"] = {
    label = "Hardwood Plank",
    weight = 100,
    stack = 50,
},
["forest_tree_plank"] = {
    label = "Hard Hardwood Plank",
    weight = 100,
    stack = 50,
},

Weapons

Add all required weapons to your inventory resource using the format appropriate for your setup.

Add items listed below to your ox_inventory into data/weapons.lua.

-- Chainsaw (weapon)
['WEAPON_CHAINSAW'] = {
    label = 'Chainsaw',
    weight = 1134,
    durability = 0.0,
},

Database

The resource creates the following table automatically:

CREATE TABLE IF NOT EXISTS `prp_lumberjack_reputation` (
    `stateId` VARCHAR(50) NOT NULL,
    `reputation` INT NOT NULL DEFAULT 0,
    PRIMARY KEY (`stateId`)
);