> For the complete documentation index, see [llms.txt](https://pirithous.rlib.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pirithous.rlib.io/faq/configuring-addon.md).

# Configuring Addon

## <mark style="color:red;">▸ Overview</mark>

Your purchased addon includes a series of configuration files which allow you to modify how the addon looks and functions. Configuring addons require a tiny bit of lua knowledge, however, all configs have been heavily documented and explain each setting in detail.

Ensure you are careful when you configure scripts. You cannot do things such as delete brackets or commas from places that they should stay.

As an example:

{% code lineNumbers="true" %}

```lua
cfg.ugroups.titles =
{
    [ 'superadmin' ]        = 'Owner',
    [ 'super_admin' ]       = 'Owner',
    [ 'admin' ]             = 'Admin',
    [ 'operator' ]          = 'Moderator',
    [ 'moderator' ]         = 'Moderator',
    [ 'trialmod' ]          = 'Trial Moderator',
    [ 'donator' ]           = 'Donator',
    [ 'user' ]              = 'User',
    [ 'noaccess' ]          = 'User'
}
```

{% endcode %}

The above list of usergroups are stored inside a table which starts and ends with <mark style="color:blue;">**{ }**</mark>.

You must ensure that a comma is placed at the end of each line. The final entry of the table on **line 11** does **not** need a comma. However, you can add one if you want.

As another example:

{% code lineNumbers="true" %}

```lua
cfg.nav.btn.workshop_url	  = 'https://steamcommunity.com/workshop/filedetails/?id=2319113217'
cfg.nav.btn.workshop_openIngame   = false
```

{% endcode %}

The above lines of code are variables. The variable name is located to the left of the equal sign, and the value is on the right.

<mark style="color:blue;">**Line 1**</mark> is a string variable with quotation marks.

<mark style="color:blue;">**Line 2**</mark> is a boolean variable which simply defines either true or false.

No comma is needed at the end of these two lines because they are not in a table, and each line is its own unique variable.

## <mark style="color:red;">▸ Config Location</mark>

To start configuring your addon, please view the [**settings**](/configuration/settings.md) page.
