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

# Overview

> Character background selection system with configurable starting conditions, perks, and items for RedM servers

A character background selection system that allows players to choose their character's past, providing unique starting conditions, skills, and equipment. Features include customizable backgrounds, perk integration, and an immersive UI.

<Info>
  This script provides a character creation experience with diverse background options, each offering unique starting conditions, skills, and equipment to shape the character's journey.
</Info>

## Features

<Columns cols={2}>
  <Card title="Diverse backgrounds" icon="users">
    Choose from multiple character backgrounds including Hunter, Herbalist, Veteran, and many more, each with unique starting conditions.
  </Card>

  <Card title="Customizable starting items" icon="box">
    Each background provides specific starting items, weapons, and equipment relevant to the character's profession and experience.
  </Card>

  <Card title="Perk integration" icon="star">
    Integration with weapon progression systems, providing starting skill levels based on character background.
  </Card>

  <Card title="Immersive UI" icon="desktop">
    User interface with background images and detailed descriptions for each character option.
  </Card>

  <Card title="Custom events" icon="code">
    Support for custom server-side events and functions to handle background-specific logic and interactions.
  </Card>

  <Card title="Framework integration" icon="gears">
    Compatible with VORP Core and RSG Core frameworks with modular framework bridge support.
  </Card>
</Columns>

## Background types

The script includes a variety of pre-configured backgrounds:

### Professional backgrounds

<AccordionGroup>
  <Accordion title="Hunter">
    A skilled character experienced in hunting and wilderness survival. Starts with hunting perks, bow, and arrows.
  </Accordion>

  <Accordion title="Herbalist">
    A wise healer familiar with nature's remedies. Starts with herbalism perks and medical supplies.
  </Accordion>

  <Accordion title="Miner">
    A hardened miner experienced in extracting ores. Starts with mining perks and mining tools.
  </Accordion>

  <Accordion title="Lumberjack">
    A strong lumberjack skilled with axes. Starts with lumber perks and logging equipment.
  </Accordion>

  <Accordion title="Farmer">
    A hardworking farmer dedicated to crops and livestock. Starts with farming perks and agricultural tools.
  </Accordion>
</AccordionGroup>

### Specialized backgrounds

<AccordionGroup>
  <Accordion title="Medic">
    A trained healer with extensive medical knowledge. Starts with medical perks and healing supplies.
  </Accordion>

  <Accordion title="Veteran">
    An experienced veteran with military training. Starts with gunslinger perks and military equipment.
  </Accordion>

  <Accordion title="Horse trainer">
    An experienced horse expert. Starts with horse care items and a horse token.
  </Accordion>

  <Accordion title="Fisherman">
    A patient fisherman who knows the waters. Starts with fishing perks and fishing equipment.
  </Accordion>

  <Accordion title="Cook">
    A talented cook who can prepare delicious meals. Starts with cooking perks and culinary supplies.
  </Accordion>
</AccordionGroup>

### Social backgrounds

<AccordionGroup>
  <Accordion title="Wealthy heir">
    A wealthy heir accustomed to luxury. Starts with significant money and luxury items.
  </Accordion>

  <Accordion title="Swindler">
    A cunning con artist who gets by with trickery. Starts with lockpicks and minimal money.
  </Accordion>

  <Accordion title="Homeless">
    A penniless loner with bare essentials. Starts with minimal items and negative money.
  </Accordion>

  <Accordion title="Civilian">
    An ordinary settler making their way in the West. Basic starting conditions.
  </Accordion>
</AccordionGroup>

## Limitations

* **Image requirements**: Background images must exist in the specified path
* **Item compatibility**: Items must be compatible with your inventory system
* **Perk integration**: Perk names must match your weapon progression system
* **Framework events**: Custom events must be properly configured for your framework

## Next steps

<Columns cols={2}>
  <Card title="Setup" icon="screwdriver-wrench" href="/scripts/background-select/setup">
    Installation, background configuration, items, perks, and custom functions.
  </Card>

  <Card title="Docs home" icon="book-open" href="/">
    Installation basics and links to every script.
  </Card>
</Columns>