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

# Getting Started

> A step-by-step guide to install and set up a resource on your FiveM server. Follow this step-by-step guide to install and set up a resource on your FiveM server.

## Installation Guide

<Steps>
  <Step title="Download the Resource">
    After purchasing a resource: 1. Visit the [Cfx.re
    Keymaster](https://keymaster.fivem.net/assets) 2. Navigate to the
    **Purchased Assets** tab 3. Locate your purchased resource 4. Click the
    **Download** button to save the ZIP file

    <Tip>
      Regularly check Keymaster for updates to your purchased resources to ensure
      you have the latest versions and features.
    </Tip>
  </Step>

  <Step title="Open Your Server's Resource Directory">
    Locate your FiveM server's `resources` folder. This is where all your server's
    resources are stored. The path is typically: - `[server-data]/resources/`
  </Step>

  <Step title="Add the Resource">
    <CardGroup cols={1}>
      <Card title="Extract and Transfer">
        1. Unzip the downloaded file to get a folder with the script's name (e.g.,
           `rs_scriptname`) 2. Transfer this extracted folder into your server's
           `resources` directory

        <Info>
          For best results, upload the ZIP file directly to your server and
          extract it there to avoid file corruption issues during transfer.
        </Info>
      </Card>
    </CardGroup>
  </Step>

  <Step title="Enable the Resource in Server Configuration">
    Open your `server.cfg` file (usually located in your `[server-data]`
    directory) and add: `cfg ensure [resource_name] ` Replace
    `[resource_name]` with the actual name of the resource folder (e.g., `ensure
          rs_scriptname`).

    <Info>
      The `ensure` command is preferred over `start` as it manages resource
      dependencies more effectively.
    </Info>
  </Step>

  <Step title="Customize the Resource Settings">
    <Tip>
      Always refer to the specific documentation page for your resource for
      detailed configuration guidance, as options can vary significantly.
    </Tip>

    <AccordionGroup>
      <Accordion title="Finding Configuration Files">
        Configuration files are typically located at: - `config.lua` in the main
        script folder - `shared/config.lua` for some resources
      </Accordion>

      <Accordion title="Editing Configuration">
        1. Navigate to the resource's folder (e.g., `resources/rs_scriptname/`)
        2. Open the configuration file with a text editor 3. Adjust settings
           according to your server's needs 4. Save the file Detailed explanations
           for each option can be found as comments within the config file or in
           the script's specific documentation page.
      </Accordion>
    </AccordionGroup>
  </Step>

  <Step title="Start/Restart Your Server">
    Launch your FiveM server or restart it if it's already running.

    <Warning>
      A full server restart is recommended when adding new resources to ensure
      all changes are applied correctly.
    </Warning>

    Verify that the resource is running correctly by checking the server console
    for any error messages related to the script.
  </Step>
</Steps>

## Troubleshooting

If you encounter any issues during installation or configuration:

<CardGroup cols={2}>
  <Card title="Common Errors" icon="bug" href="/common-errors">
    Solutions for frequently encountered issues
  </Card>

  <Card title="Discord Support" icon="discord" href="https://discord.com/invite/crwCA7jc2C">
    Join our community for real-time support
  </Card>

  <Card title="FAQ" icon="circle-question" href="/faq">
    Answers to frequently asked questions
  </Card>

  <Card title="Script Documentation" icon="book-open">
    Check the specific documentation page for your resource
  </Card>
</CardGroup>