> For the complete documentation index, see [llms.txt](https://tyrix.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tyrix.gitbook.io/docs/script-resources/tyrix-dice.md).

# Tyrix Dice 🎲

A realistic dice rolling script for FiveM with physics-based animations and multiple color options.

## Features

* **Realistic Physics** - Dice bounce and tumble naturally before settling
* **Multiple Colors** - White, black, and red dice available
* **Roll 1-3 Dice** - Flexible dice count per roll
* **3D Text Display** - Results shown above dice after settling
* **Proximity-Based** - Only nearby players see dice and notifications
* **Server-Authoritative** - Roll results determined server-side (anti-cheat)
* **Command or Item Mode** - Use `/dice` command or inventory items
* **Multi-Framework** - Auto-detects ox\_inventory, QBCore, ESX, or standalone
* **ox\_lib Integration** - Optional text UI prompts

## Quick Start

1. Download and extract to your resources folder
2. Add the following to your server.cfg:

{% code title="server.cfg" %}

```
ensure tyrix_dice
```

{% endcode %}

3\. Restart your server 4. Use \`/dice\` to roll!

No additional configuration required - works out of the box!

## Dependencies

| Dependency | Required | Purpose                            |
| ---------- | -------- | ---------------------------------- |
| ox\_lib    | Optional | Text UI prompts for pickup keybind |

## Framework Support

The script automatically detects your framework:

| Framework  | Player Name Source        |
| ---------- | ------------------------- |
| ESX        | Character first/last name |
| QBCore     | Character first/last name |
| Standalone | Steam/FiveM display name  |

No configuration needed - just install and go!

## Support

For issues or feature requests, contact Tyrix.