# How to Begin

Welcome to the RCore Prison guide! This resource provides a comprehensive overview of features and step-by-step instructions for solving common issues (FAQs).

***

### FAQ

<details>

<summary>Prison break other resource sounds (native)</summary>

* This might happen, since together with our resource you might be hitting limit of the audio banks loaded at the time.
* Solution: Go to `rcore_prison/config.lua` and set `Sounds.UseCustomAlarmSound = true`.

```
Sounds = {
    UseCustomAlarmSound = true, -- This allow you to enable/disable prison break alarm with own
}
```

</details>

<details>

<summary>Where is the included Prison Map?</summary>

* The included MLO is stored in `rcore_prison/assets/includedMaps/`
* Extract all assets into your `resources`
* Go to your `server.cfg` and run it like this.

**RCore map (server.cfg) example**

```lua
ensure rcore_prison_models
ensure rcore_prison_map
ensure [prison]
```

</details>

<details>

<summary>What is deployer shown in server console?</summary>

* The Deployer is our tool designed to simplify the installation and management of third-party scripts.
* It automates actions that require specific resource items in the player's inventory or framework, including importing inventory images.
* This tool streamlines the process for our customers, making it easier and more efficient.
* How it works: [guide](https://documentation.rcore.cz/paid-resources/rcore_prison/guides/deployer).

</details>

<details>

<summary>Inventory items not being removed when jailed</summary>

* Make sure you are running one of the [supported inventories](https://documentation.rcore.cz/paid-resources/rcore_prison#supported-inventories).
* If using a supported inventory, check the `Config.Stash.KeepItems` section in `rcore_prison/config.lua`.
* By default, items like `water`, `bread`, and `sludgie` are defined to remain in the inventory.

</details>

<details>

<summary>Where can I change the canteen items?</summary>

* Refer to the [canteen configuration guide](https://documentation.rcore.cz/paid-resources/rcore_prison/features/canteen).

</details>

<details>

<summary>How can we make booths work with our phone resource?</summary>

* Obtain the phone resource's documentation to determine compatibility.
* Evaluate the documentation to identify possible integration methods.

</details>

<details>

<summary>My items are not restored when I get released</summary>

* Stashed items can be found at the **Lobby Warden**, typically near the prison lobby where the player is released.
* If items are missing, check the database `rcore_prison_stash` to confirm if saved items exist.

</details>

<details>

<summary>Why don’t I have a prison outfit when jailed?</summary>

* Configure outfits in `rcore_prison/outfits.lua`.
* Refer to the [prison outfit configuration guide](https://documentation.rcore.cz/paid-resources/rcore_prison/guides/where-change-prison-outfits).
* Ensure a supported clothing resource is being used.

</details>

<details>

<summary>Are prisoner accounts persistent?</summary>

* By default, prisoner accounts remain persistent after release.
* This behavior can be changed in `rcore_prison/config.lua` by setting the appropriate configuration to remove accounts upon release.

</details>

<details>

<summary>I cannot see any dispatch when running ps-dispatch</summary>

* Execute the command `prisonsetup ps-dispatch` in the server console.
* Restart the server and verify conditions where dispatch should be invoked. Refer to the [dispatch troubleshooting guide](https://documentation.rcore.cz/paid-resources/rcore_prison#why-dispatch-is-not-being-called).
* To enforce dispatch, modify `DispatchSettings` in `config.lua` and set both options to `true` (note: this is not recommended as it may break immersion).

</details>

<details>

<summary>Where to change sentence time</summary>

* Adjust sentence time in `rcore_prison/config.lua` under the `Time` section. Supported units include:
  * `SEC`
  * `MIN`
  * `HOURS`
  * `DAYS`
  * `WEEKS`
  * `MONTHS`

</details>

<details>

<summary>Where to specify certain items to keep after jail</summary>

* Modify `Config.Stash.KeepItems` in `rcore_prison/config.lua` to define specific items that remain after being jailed.

</details>

<details>

<summary>Where to change NPC configurations</summary>

* Edit NPC-related configurations in `rcore_prison/data/presets/yourMap.lua`.

</details>

<details>

<summary>How to disable prison break</summary>

* Disable the prison break feature by setting `Escape.Enable = false` in `rcore_prison/config.lua`.

</details>

<details>

<summary>Player are getting banned for freecam when being jailed</summary>

* Go to `rcore_prison/config.lua` and search for and set it to false: `Prolog.Enable = false`.

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.rcore.cz/paid-resources/rcore_prison/how_to_begin.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.