🔧Config

Explanations for all config values.

Having trouble?

If you feel like we have explained any value poorly, please let us know on Discord so that we can update the documentation so that everyone understands it easily.

To understand the structure

Because we have extensive configuration files, nested tables is an inevitability. To keep track of which values are for which table we use the tablename.value. This can also stack, for example location.blip.enabled etc.

shared/config.lua

CraftingLocations

pos

The position you will be able to access the crafting station at, has to be a vector3.

requirements

This is used to lock crafting stations to certain individuals based on the criteria. By leaving names, view below, empty, anyone will be able to access this crafting station.

job

Set to true to enable jobs, false to enable gangs.

names

Names of the jobs or gangs that will be able to access this crafting station. Note that you can also completely remove this variable and it will make it a global crafting station.

target

Add this table to initialize targeting.

heading

Heading of the entity spawned / PolyZone created.

model

Model for the entity that spawns and can be interacted with.

Settings

debug

If set to true, it will print out information in the console, false to disable it. Some information will still be printed out, such as missing arguments, despite this being disabled.

Levels

A collection of values controlling how levels are calculated.

Levels.baseXp

The base XP that will be needed for each level up.

Levels.xpMultiplier

How much the xp needed to level up is multiplied by each level. Example: Level 1: 100xp, Level 2: 150xp, Level 3: 225xp, Level 4: 337.5xp, Level 5: 506.25xp. NOTE that it is 100xp for first level, then another 150 for level 2, meaning it is 250 xp to get to level 3

logCrafts

Will log all crafts to the webhook you added in server\unlocked.lua, reason it is not in here is to prevent people from dumping your server and spamming it. Yes, some people have that much free time.

Images

You can add images by URL or by specifying the name of the image in your images folder. This table was created so that you can easily refer to the same image if you use it over and over again, instead of copying around the URL/image name. Fallback if these are invalids is a cat, if you're wondering why it appeared in your UI.

Crafts

item

The name of the item you want to be given when you finished crafting.

label

The label of the item and the name you will see throughout the script.

isItem

Set to true if you want to have it given as an item, false to give it as a weapon. Should probably be true for most people but if you're running old frameworks where you have the scrollwheels as weapons, you probably need to set this to false. This does default to true since it's the most common use case, so you don't have to actually add it if it's an item.

level

The level required in order to craft the item.

timeToCraft

The time it will take to craft the item, in seconds.

amount

Amount of the item to give, default is 1.

experienceToGive

How much experience you get from crafting this item, default is 0.

blueprint

Default false, set to true if you want this item to require a blueprint to craft.

img

Image for the item. Explained in Images how it works if you're struggling.

specificLocations

If this is empty or completely removed, the craft will be available everywhere, if you want it to be available at specific locations, add the locations here. 1 would equal to the first location in Config.CraftingLocations, 2 would equal to the second location and so on.

items

This is the list of items that you need to craft the item, they will all be removed

tools

This is tools needed to craft the item, they will not be removed.