> ## Documentation Index
> Fetch the complete documentation index at: https://docs.darkrp.onlythreekidneys.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Dark-RP Framework makes turning any map in Beyond Sandbox into a fully-featured roleplay environment quick and easy. Follow these steps to get your first Dark-RP map running:

## 1. Add the Framework to Your Map

To use our framework in your mod, simple set **Dark-RP Framework** as the game-mode. The framework handles all core systems, so no additional setup is required.

### 2. Prepare Your Map for Roleplay

Place spawn points, props, and interactable areas in your map. The framework automatically recognizes and manages prop zones, material placements, doors, etc.

### 3. Configure Jobs

Jobs are the heart of Dark-RP. Use the included examples as templates to define your own roles. Each job can have:

* Name and description  <Icon icon="user-tag" />
* Salary or resource gain  <Icon icon="money-bill-simple-wave" />
* Appearance models  <Icon icon="person-half-dress" />
* Custom abilities or restrictions  <Icon icon="wand-magic-sparkles" />

### 4. Add Props and Materials

Register props and materials within the framework to make them usable in-game. Configure costs, permissions, and interaction behavior directly in your map’s configuration.

## 5. Test Your Map

Launch your map in **Beyond Sandbox**. The framework automatically handles player data, job assignment, and saving/loading game state. Players’ progress persists across sessions.