config.lua: settings you can safely change

What a config file is

A config file is a plain Lua file, almost always named config.lua, that does one job: it defines a table of settings. The script then reads that table to decide how to behave. The settings live in one file, the actual logic lives in others, and you only ever touch the settings file.

Why configs exist

Imagine a script that runs a shop. The price of water is 500. If that number lived deep inside the script's logic, every server owner who wanted a different price would have to dig through code they do not understand, find the right line, and hope they did not break anything else on the way.

That is a terrible experience, so script authors do not do it. Instead they pull every value a normal user might want to change, the prices, the shop locations, the language, the menu key, into one file. You change behaviour by editing that file. You never touch the logic.

This split is the whole point. The risky, complicated code stays sealed in its own files. The safe, changeable values sit together in config.lua with a comment next to each one. Almost every script you download from a store or a community will have a config.lua (or a config/ folder). Learning to read it is the single most useful skill for running a server.

What a Config table looks like

Here is a small but realistic config. Read it top to bottom; it is just a table being filled in one line at a time.

Config = {}
 
Config.Price = 500            -- how much the item costs
Config.UseTarget = true       -- true to open with the target system, false for a key
 
Config.Locations = {
    { label = 'Legion Square', x = 215.0, y = -810.0, z = 30.0 },
    { label = 'Sandy Shores',  x = 1960.0, y = 3740.0, z = 32.0 },
}

Line by line. Config = {} creates an empty table named Config. The {} means "an empty container". Each line after it drops one setting into that container under a name. Config.Price = 500 stores the number 500 under the key Price. Config.UseTarget = true stores the value true under the key UseTarget. Config.Locations stores a list of two places, each with a label and coordinates.

Elsewhere in the script, the code reads these values back. It never writes 500 directly. It writes Config.Price, which means "go look up the key Price in the Config table and use whatever value is there". So when a player buys the item, the logic does something like this:

-- somewhere in the script's logic (you do NOT edit this):
chargePlayer(Config.Price)

Change Config.Price to 250 in config.lua, restart, and now the shop charges 250, without you ever opening the file that does the charging. That is the entire idea. The logic asks the table; you control the table.

Safe edits versus core logic

There is a clean line between what is safe to change and what is not. Learning where that line sits is what separates a server owner who can confidently customize scripts from one who breaks their server every weekend.

What is safe to edit

Inside config.lua, the values are yours. Changing them is exactly what the author intended:

• Numbers, like a price or a cooldown: Config.Price = 250
• Booleans, the bare words true or false: Config.UseTarget = false
• Text in quotes, like a language or a label: Config.Locale = 'fr'
• Coordinates inside the Config table, like a shop location

These are knobs. Turn them. Worst case you set a number too high and turn it back.

What is risky

Anything outside config.lua is the engine, and casual edits to the engine break things you cannot see:

• The other files, usually server.lua, client.lua, or anything in a server/ or client/ folder. That is the logic.
• The body of any function, the lines between function and end. That is how the script actually works.
• Event names, the strings the script uses to talk between its own files. Change one and two halves of the script stop hearing each other.

If a value is not exposed in config.lua, the author did not mean for you to change it. Touching it is an advanced move, not a setup step.

Edit one

Let us do the real thing: open a script's config, change one value, and watch it take effect. We will use a price as the example, because it is the most common edit you will ever make.

Config.Price = 500     -- before

Config.Price = 250     -- after

restart the_resource

Common beginner mistakes

Almost every config break is one of these three. Each one comes from forgetting that config.lua is real Lua and follows Lua's rules exactly.

Try it yourself

What you can do now

• Explain what config.lua is: a Lua file that defines a Config table of settings, loaded as a shared_script so both sides read the same values.
• Say why configs exist: they let you change prices, locations, and language without touching the logic, which is why almost every downloaded script has one.
• Read a Config table and look a value back up with Config.Name.
• Tell a safe edit (a value inside config.lua) from a risky one (anything outside it: logic, function bodies, event names).
• Run the loop: open config.lua, change one value, save, restart the resource, confirm the change.
• Recover from a broken edit by rechecking and undoing the single value you just changed.

You can now make a resource do things, and just as importantly, you can take any script someone else built and bend it to your server without breaking it. That covers the core skills. Next you will meet the tools and libraries you will see in every server you ever open. The next module is "The ecosystem map", and it starts with "Natives: the game's built-in toolbox", the built-in functions the game gives you for free.

REFERENCES

FiveM docs: resource manifest ↗