# overwriteConfig.lua

The `overwriteConfig.lua` file is a mechanism that allows you to customize your script configuration without directly modifying the original `config.lua` file.

## Why use overwriteConfig.lua?

### Main Advantages

#### 1. Simplifies Updates
When you directly modify the `config.lua` file and a script update is available, you must:
- Backup your custom configuration
- Compare the old and new `config.lua` file line by line
- Manually transfer your modifications
- Risk forgetting certain parameters or introducing errors

With `overwriteConfig.lua`, simply backup this file before updating, replace the entire resource with the new version, and restore your backup file.  
If new parameters are added to the `config.lua` file during an update, they will automatically be available since `overwriteConfig.lua` is loaded after and only overwrites the specific values you've customized.

#### 2. Separation of Concerns
- **config.lua**: Default configuration maintained by developers
- **overwriteConfig.lua**: Your specific customizations

This separation makes your configuration clearer and more maintainable.

#### 3. Preserves Your Settings
The `overwriteConfig.lua` file is included in all scripts and is specifically designed to store your custom settings. This file is meant to be edited, unlike `config.lua` which should remain untouched to preserve update compatibility.

## How to use it?

### File Location

The `overwriteConfig.lua` file is already included in the script's root directory. Simply open it and add your custom configuration values.

### Basic Structure

The file already contains a header explaining its purpose:

```lua
-------------
-- USE THIS FILE TO EDIT THE CONFIGURATION OF THE SCRIPT
-- CONFIG LOCATION : shared/config.lua
-- Copy ONLY values you want edit, NOT ALL the config file
-------------

-- Customize only the values you want to modify
Config.myParameter = "my_value"
Config.maxPlayers = 32
```

### Concrete Example

Imagine that the `config.lua` file contains the following configuration and you want edit the language and maximum distance:

```lua
-------------------------------------------
-- DON'T EDIT THIS FILE
-- TO OVERWRITE CONFIG VALUE, USE overwriteConfig.lua file instead
-------------------------------------------
Config = {}

Config.framework = "redemrp"
Config.language = "en"
Config.maxDistance = 10.0
Config.enableNotifications = true
Config.notificationDuration = 5000
```

1. Copy the two lines from the `config.lua` file and paste them in the `overwriteConfig.lua` file:
You don't need to copy the entire file, only the values you want to change are enough.

```lua
-------------
-- USE THIS FILE TO EDIT THE CONFIGURATION OF THE SCRIPT
-- CONFIG LOCATION : shared/config.lua
-- Copy ONLY values you want edit, NOT ALL the config file
-------------
Config.language = "en"
Config.maxDistance = 10.0
```

2. Edit these values to your liking:
```lua
-------------
-- USE THIS FILE TO EDIT THE CONFIGURATION OF THE SCRIPT
-- CONFIG LOCATION : shared/config.lua
-- Copy ONLY values you want edit, NOT ALL the config file
-------------
Config.language = "fr"
Config.maxDistance = 15.0
```

:clap: **You're done!** You can now use the script with your custom configuration.

## Loading Order

Files are loaded in this order (generally defined in `fxmanifest.lua`):

1. **config.lua**: Loads all default values
2. **overwriteConfig.lua**: Overwrites only the values you redefine

```lua
-- Example fxmanifest.lua
shared_scripts {
    'config.lua',
    'overwriteConfig.lua'  -- Loaded last to overwrite values
}
```

## Best Practices

### Do

- Use the `overwriteConfig.lua` file for all your customizations
- Only redefine parameters you actually modify
- Comment your modifications to remember why you made them
- Backup your `overwriteConfig.lua` during updates

```lua
-- Switch to French for our FR server
Config.language = "fr"

-- Distance increased for better visibility in our game mode
Config.maxDistance = 20.0
```

### Don't

- Don't modify `config.lua` directly
- Don't add new configuration keys in `overwriteConfig.lua` (unless the script supports it)
- Don't copy the entire `config.lua` into `overwriteConfig.lua`

## Complete Example

### config.lua (original file, do not modify)
```lua
-------------------------------------------
-- DON'T EDIT THIS FILE
-- TO OVERWRITE CONFIG VALUE, USE overwriteConfig.lua file instead
-------------------------------------------
Config = {}

Config.framework = "redemrp"
Config.language = "en"
Config.currency = "dollar"

Config.shops = {
    {
        name = "General Store",
        coords = vector3(100.0, 200.0, 300.0),
        blip = true
    },
    {
        name = "North Store",
        coords = vector3(400.0, 500.0, 600.0),
        blip = true
    }
}

Config.prices = {
    apple = 1.0,
    bread = 2.0,
    water = 0.5
}
```

### overwriteConfig.lua (your customizations)
```lua
-------------
-- USE THIS FILE TO EDIT THE CONFIGURATION OF THE SCRIPT
-- CONFIG LOCATION : shared/config.lua
-- Copy ONLY values you want edit, NOT ALL the config file
-------------

-- Language configuration
Config.language = "fr"

-- Update the bread price
Config.prices.bread = 3.0

-- Rename shops
Config.shops[1].name = "Magasin Général"
Config.shops[2].name = "Magasin Nord"
```

## Summary

The `overwriteConfig.lua` system is a development best practice that:
- Simplifies script updates
- Protects your customizations
- Improves server maintainability
- Keeps your settings separate from default configuration

:::tip Recommendation
**Always** use `overwriteConfig.lua` for your customizations rather than directly modifying `config.lua`.
:::