> 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/installation.md).

# Installation

## Basic Installation

1. **Download** the resource
2. **Extract** to your resources folder (e.g., `resources/[addons]/tyrix_dice`)
3. **Add** to your server.cfg:

```cfg
ensure tyrix_dice
```

4. **Restart** your server

That's it! The resource works out of the box with default settings.

## Resource Structure

```
tyrix_dice/
├── client/
│   └── main.lua          # Client-side logic
├── server/
│   └── main.lua          # Server-side logic
├── shared/
│   ├── config.lua        # User configuration
│   └── internal.lua      # Internal settings (don't edit)
├── stream/
│   └── [dice models]     # 3D dice models (.ydr files)
├── install/
│   ├── items.lua         # ox_inventory item definitions
│   └── images/           # Item icons for inventory
├── docs/
│   └── [documentation]   # GitBook documentation
├── fxmanifest.lua        # Resource manifest
└── README.md             # Quick reference
```

## Ensure Order

If using **ox\_lib** for text UI prompts, ensure it loads before tyrix\_dice:

```cfg
ensure ox_lib
ensure tyrix_dice
```

## Item Images

{% file src="/files/uaer1GaMGRU58iizR9Zf" %}

## Verifying Installation

1. Join the server
2. Type `/dice` in chat
3. You should see dice roll in front of your character
4. After settling, 3D text displays the result

## Troubleshooting

### Dice don't appear

* Check server console for errors
* Verify the `stream/` folder contains `.ydr` model files
* Ensure resource is properly started (`ensure tyrix_dice`)

### Command not found

* Resource may not be started
* Check for typos in server.cfg

### No 3D text showing

* Move closer to dice (within render distance)
* Check `Config.RenderDistance` setting