# FiveM Scoreboard

## Setup

1. Extract the zip folder into your resource folder and name the script `framework-scoreboard` 
2. Edit the config to your liking a breakdown of the config will be below. 
3. Start the resource after the framework 
4. Load in and test :smile:

```
ensure framework
ensure framework-scoreboard
```

## Configuration Documentation

```lua
config = {}
config.delay = 1500 -- Delay in milliseconds between each check
config.key = 27 -- Key to open the menu

config.uiSettings = {
    serverName = "NAT RP - {playercount}", -- Possible varibles {playercount}
    banner = {
        enabled = true,
        url = "https://i.ibb.co/hFRM77G/faxsstore.png"
    },
    ping = {
        enabled = false
    }
}
```

### Global Configuration

* **`config.delay`**:\
  Sets the delay in milliseconds between each check.
  * **Type**: Integer
  * **Default**: `1500`
* **`config.key`**:\
  Specifies the key used to open the menu.
  * **Type**: Integer
  * **Default**: `27` (This usually corresponds to the 'ESC' key)

### UI Settings (`config.uiSettings`)

The `config.uiSettings` table contains settings related to the user interface.

#### Server Name (`serverName`)

* **`serverName`**:\
  The name of the server displayed in the UI.
  * **Type**: String
  * **Default**: `"NAT RP - {playercount}"`
  * **Description**: You can use the `{playercount}` variable to dynamically display the current number of players.

#### Banner (`banner`)

* **`banner.enabled`**:\
  Enables or disables the display of a banner in the UI.
  * **Type**: Boolean
  * **Default**: `true`
* **`banner.url`**:\
  The URL of the image used as the banner.
  * **Type**: String
  * **Default**: `"https://i.ibb.co/hFRM77G/faxsstore.png"`

#### Ping (`ping`)

* **`ping.enabled`**:\
  Enables or disables the display of the ping information in the UI.
  * **Type**: Boolean
  * **Default**: `false`

### Known Issues

if you have changed the default name of the framework to lets say rp-framework. You will need to modify the server.lua. <br>

1. Go into `Framework-scoreboard/server/server.lua`&#x20;
2. Edit the framework to match your resource name. Only edit what's in the "framework"

<figure><img src="/files/fsdIxaaoLuooSVqoGJiR" alt=""><figcaption><p>Framework-scoreboard/server/server.lua</p></figcaption></figure>


---

# Agent Instructions: 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:

```
GET https://docs.nat2k15.xyz/paid-scripts/fivem-framework/framework-addons/fivem-scoreboard.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.