> For the complete documentation index, see [llms.txt](https://5scripts-1.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://5scripts-1.gitbook.io/docs/assets/5s_racing.md).

# 5s\_racing

### 📖 Documentation Sections

* **🖥️** [**Install**](/docs/assets/5s_racing/install.md) - File installation, dependencies and server.cfg setup
* **🔧** [**Configuration**](/docs/assets/5s_racing/config.md) - Every config option, explained
* **📝** [**Editable Files**](/docs/assets/5s_racing/editable.md) - Files you can safely modify (framework, payments, ELO, classes)
* **💻** [**Exports**](/docs/assets/5s_racing/exports.md) - Exports to use in your code
* **❓** [**FAQ**](/docs/assets/5s_racing/faq.md) - Answers to questions asked frequently

### 🚀 Quick Start

1. Place the script in your `resources/[5s]/` folder
2. Add `ensure 5s_racing` to your `server.cfg` (after the dependencies below)
3. Connect to your server and open the tablet with `/racingtablet`
4. The database tables are created automatically on first start

### 📦 Dependencies

* **ox\_lib** (required)
* **5s\_lib** (required, included in the package)
* **oxmysql** (required)

### ✨ Features

* **In-game track creator** - place checkpoints, props, peds and particle effects, then save and share tracks without leaving the game
* **Multiple race types** - Sprint, Drift and Elimination, plus track-locked Drag races with their own countdown timer
* **Laps / circuits** - any non-drag track can be raced for multiple laps
* **ELO ranked system** - a skill rating that rises when you beat stronger drivers and falls when you lose, scaled by track length
* **Vehicle performance classes** - cars auto-rated `D → X` from their stats, plus native classes for bikes, off-road, vans and bicycles
* **Leaderboards & personal bests** - per-track best times (per class or global) and drift-score boards
* **Prize pool** - entry fees pooled into a pot and paid out by finishing position, with an optional house cut
* **Proximity join** - walk up to a race and press a key to join
* **Automated races** - the server can host public races on a timer, no player host required
* **Checkpoint decoration presets** - dress checkpoints with tyre walls, flags, cones or flares that follow the gate in the editor
* **Quality-of-life HUD** - sliding checkpoint blip window, route line, wrong-way warning, ghost mode and unit-system (metric/imperial) preference
* **Tablet UI** - browse races, manage tracks, view your driver profile and stats from a single in-game tablet
* **Discord webhooks** - log finished races, created races and track changes
* **Anti-cheat & limits** - cooldowns, distance checks and per-track caps out of the box
* **Multi-language** - English and Polish included, easily extendable