> For the complete documentation index, see [llms.txt](https://risk-scripts.gitbook.io/risk-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://risk-scripts.gitbook.io/risk-scripts/scripts/spin-the-bottle/configuration.md).

# Configuration

Below is a **table** summarizing each major setting. Further down, you can see an excerpt from the config file for reference.

| Parameter                                                | Description                                                                                                                                               | Example Value                                        |
| -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| <mark style="color:red;">`RS.Framework`</mark>           | Determines the framework: <mark style="color:red;">`auto`</mark>, <mark style="color:red;">`esx`</mark>, or <mark style="color:red;">`qb`</mark>.         | <mark style="color:red;">`"auto"`</mark>             |
| <mark style="color:red;">`RS.Item`</mark>                | The item required to start the game.                                                                                                                      | <mark style="color:red;">`"spinbottle"`</mark>       |
| <mark style="color:red;">`RS.Language`</mark>            | The default language for cooldown, winner, and error messages.                                                                                            | <mark style="color:red;">`"en"`</mark>               |
| <mark style="color:red;">`RS.BottleModel`</mark>         | The in-game prop used for the bottle.                                                                                                                     | <mark style="color:red;">`"prop_wine_bot_01"`</mark> |
| <mark style="color:red;">`RS.MarkerColor`</mark>         | RGBA color table for any used marker.                                                                                                                     | <mark style="color:red;">`{r=0,g=169,b=255}`</mark>  |
| <mark style="color:red;">`RS.MarkerType`</mark>          | Marker type ID. See [<mark style="color:red;">markers docs</mark>](https://docs.fivem.net/docs/game-references/markers/)<mark style="color:red;">.</mark> | <mark style="color:red;">`0`</mark>                  |
| <mark style="color:red;">`RS.canMoveWhileSpinn`</mark>   | Whether players can move around while the bottle is spinning.                                                                                             | <mark style="color:red;">`true`</mark>               |
| <mark style="color:red;">`RS.ShowWinnerMarker`</mark>    | If <mark style="color:red;">`true`</mark>, displays a marker above the winner’s head.                                                                     | <mark style="color:red;">`true`</mark>               |
| <mark style="color:red;">`RS.ShowWinnerName`</mark>      | If <mark style="color:red;">`true`</mark>, prints or displays the name of the winner.                                                                     | <mark style="color:red;">`true`</mark>               |
| <mark style="color:red;">`RS.OtherPlayersCanSpin`</mark> | Allows multiple players to spin if set to <mark style="color:red;">`true`</mark>.                                                                         | <mark style="color:red;">`true`</mark>               |
| <mark style="color:red;">`RS.UseCustomNotify`</mark>     | If <mark style="color:red;">`true`</mark>, the script calls <mark style="color:red;">`RS.CustomNotify(type, message)`</mark> for notifications.           | <mark style="color:red;">`false`</mark>              |

```lua
RS = {}

-- Framework Settings
RS.Framework = 'auto'
RS.Item = "spinbottle"
RS.Language = 'en'

-- Bottle & Marker
RS.BottleModel = 'prop_wine_bot_01'
RS.MarkerColor = { r = 0, g = 169, b = 255 }
RS.MarkerType = 0

-- Gameplay
RS.canMoveWhileSpinning = true
RS.ShowWinnerMarker = true
RS.ShowWinnerName = true
RS.OtherPlayersCanSpin = true

-- Notification
RS.UseCustomNotify = false
RS.CustomNotify = function(type, message)
    -- Custom logic or fallback to GTA notifications
end

-- Language Messages
RS.CooldownMessages = {
  en = "The bottle is already spinning, please wait until it stops!",
  -- ...
}
RS.WinnerMessages = {
  en = "%s is the chosen one!",
  -- ...
}
RS.ErrorMessages = {
  en = "Not your bottle",
  -- ...
}

-- Framework Detection
function getFramework() ... end
-- ...

```