Installation

Step by step documentation how to properly install script.

Database

The database will be imported automatically for you when you start the resource for the first time.

General information

🗺️ Note about the RCore Prison Map:

The included RCORE Prison map does not have a visitation room, and the canteen is located in a different section of the prison (marked as a C on the map).

If you are migrating from QBOX or QBCore, those frameworks may come with a different prison map that includes a visitation area.

Our MLO is located at vector3(1691.44, 2568.25, 45.56).

🗺️ A Quick Note About Doors

Just a heads-up: the prison doesn't come with specific door locations on the map. If you need doors for your prison setup, feel free to add them wherever you like—they’re completely up to you!

Script

  1. Download the script from Keymaster.

  2. Place the files in the resources folder.

  3. Edit the server.cfg.

  4. Define server maps.

  5. Define items using Deployer or manually.

  6. Start the server.

Step 1: Download the Script

Step 2: Place the Files

  • Open the downloaded .zip, copy the [police] folder, and put it in your resources folder.

Resource folder image
Resource Folder
Resources folder

Step 3: Edit server.cfg

Go to your server.cfg and add ensure [prison].

Step 4: Define Your Prison Map

To configure your prison map, ensure the correct map resources are included in your server.cfg. Below are configuration examples for Standalone, Custom Prison Map, and RCORE setups.

Note: If an unsupported map is loaded, a Standalone configuration will be applied by default, using the standard prison yard.

Standalone

  • Description: Uses the default prison yard

ensure [prison]
Your map

  • Description: Configures the prison map you have defined

ensure your_prison_map
ensure [prison]
RCORE

  • Description: Configures the RCORE Prison map that comes included with the [prison] resource.

  • Path to Map Files:

    You can find the RCORE prison map and models in the following locations:

    • Map folder: resources/[prison]/rcore_prison/includedMaps/rcore_prison_map

    • Models folder: resources/[prison]/rcore_prison/includedMaps/rcore_prison_models

🛠️ How to Extract:

To use the map and models directly in your server's resource system, follow these steps:

  1. Navigate to: resources/[prison]/rcore_prison/includedMaps/

  2. Copy the folders:

  • rcore_prison_map

  • rcore_prison_models

  1. Paste both folders directly into your main resources/ directory.

ensure rcore_prison_models
ensure rcore_prison_map
ensure [prison]

🗺️ Note about the RCore Prison Map:

The included RCORE Prison map does not have a visitation room, and the canteen is located in a different section of the prison (marked as a C on the map).

If you are migrating from QBOX or QBCore, those frameworks may come with a different prison map that includes a visitation area.

Step 5: Define Items (Deployer or Manual)

  • To define items in the RCore Prison script, you can either use the Deployer command or edit the configuration manually.

Using the Deployer command

  • Full guide at this page Guide

  1. Start the server.

  2. Open the server console (txAdmin - Live console)

  3. Type the following command to automatically define items:

    prisonsetup inventory_name

Note: inventory_name should correspond to the name of your inventory system. Ensure it matches your configuration to avoid errors.

Manually Adding Items

Step 5: Define ace permissions

  • Add to bottom of server.cfg permission part (script need this permission to use properly ACE permission)

add_ace resource.rcore_prison command.add_ace allow
add_ace resource.rcore_prison command.remove_ace allow
add_ace resource.rcore_prison command.add_principal allow
add_ace resource.rcore_prison command.remove_principal allow

Step 6: Enjoy

  • Start your server and enjoy RCore Prison.

🔄 Server items If you’ve made any changes to your items (or just defined them for the first time), don’t forget to restart your server. This ensures all your custom items get properly registered into the system and everything works smoothly.

Commands

You can adjust all command names in config.lua

Command
Description

/jailcp

Use this to manage prisoners in your city

/jail playerId time reason

For jailing citizens

/startcs playerId amount

For setting citizens into COMS

/unjail playerId

For unjailing target citizen

/removescs playerId

For removing citizen COMS

/stopalarm

Stop current active alarm

/solitary playerId time

For setting prisoners to solitary

/rsolitary playerId

For removing player from solitary

Discord logs

  1. Go to rcore_prison/sconfig.lua

  2. Change SConfig.LogWebhook value

PreviousHow to UpdateNextInventory items

Last updated

Was this helpful?