> For the complete documentation index, see [llms.txt](https://vortexbey.gitbook.io/untitled/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vortexbey.gitbook.io/untitled/assets-and-guides/blackout-system/configuration.md).

# Configuration

All configuration options are located in:

```
config.lua
```

Below is a breakdown of each setting.

***

### ❖ Global Blackout Mode

```lua
Config.GlobalBlackout = true
```

* **true** → Server starts with full blackout (recommended)
* **false** → Blackout disabled on startup

***

### ❖ Zone System (Light Zones)

Light zones stay illuminated even during blackout.

```lua
Config.LightZones = {
    {coords = vector3(1163.08, -1507.63, 34.69), radius = 120.0},
}
```

Add as many zones as needed.

***

### ❖ Visual Effect Settings

```lua
Config.EffectName = "BLACK_OUT"
Config.EffectStrength = 1.0
```

Common effect options:

| Effect Name      | Description                 |
| ---------------- | --------------------------- |
| BLACK\_OUT       | Full environmental darkness |
| NG\_filmic02     | Cinematic dark contrast     |
| underwater\_deep | Heavy blur & desaturation   |
| torpedo          | High-contrast darkness      |

***

### ❖ Permissions System

Two permission systems are available.

***

#### **1. ACE Permissions (Recommended)**

Enable ACE:

```lua
Config.Permissions.UseAce = true
Config.Permissions.AceName = "blackout.toggle"
```

Add the permission in **server.cfg**:

```
add_ace group.admin blackout.toggle allow
```

***

#### **2. Identifier Whitelist**

You may authorize users by adding identifiers directly.

```lua
Config.Permissions.AllowedIdentifiers = {
    "license:11000010abcdef01",
    "steam:11000010abcdef01",
    "discord:123456789012345678",
    "fivem:123456",
}
```

Supported:

* license:
* steam:
* fivem:
* discord:

If ANY identifier matches → user is authorized.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://vortexbey.gitbook.io/untitled/assets-and-guides/blackout-system/configuration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
