> For the complete documentation index, see [llms.txt](https://sl-scritps.gitbook.io/sl-scripts-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sl-scritps.gitbook.io/sl-scripts-documentation/products/sl-rolmaker-toolkit.md). # SL Rolmaker Toolkit ## SL Rolmaker Toolkit **Code:** RMT-02\ **Resource:** `sl_rolmaker_toolkit`\ **Version:** v1.1.0-alpha4\ **Category:** RP Tool / Admin Tool / Narrative Builder\ **Status:** Expansion / Testing **Structured tools for serious roleplay servers.** *** ### Overview SL Rolmaker Toolkit is a roleplay creation toolkit for FiveM servers. It helps admins, staff and rolmakers create structured roleplay content inside the world, including scenes, text elements, props, NPCs, clues, requirements, rewards and interaction points. The resource is designed for servers that want to create richer roleplay situations without relying only on chat messages or manual explanations. *** ### What is this script for? SL Rolmaker Toolkit gives staff and rolmakers a visual tool to build roleplay content. It is useful for: * Staff-created scenes * Investigation setups * NPC dialogue moments * Story events * Clue-based roleplay * Prop-based storytelling * Temporary or persistent RP content * Admin-controlled worldbuilding * Event preparation * Narrative chains * Roleplay missions or guided interactions The main goal is: ```txt Create structured RP content → place it in the world → let players discover, interact and react ``` *** ### Roleplay Experience SL Rolmaker Toolkit is designed around a simple IC idea: ```txt The world contains story elements. Players discover those elements. NPCs, props, text and clues help guide the roleplay. ``` Instead of staff explaining everything manually, the toolkit allows servers to build interactive roleplay content directly in the world. Examples: ```txt A witness NPC gives a short clue. A suspicious box can be inspected. A scene text describes damage. A prop marks an important object. A reward is given after meeting a requirement. ``` *** ### Player IC Usage For normal players, SL Rolmaker Toolkit should feel like discovering content in the world. Players may interact with: * Scene text * NPCs * Props * Clues * Dialogue points * Investigation elements * Event objects * Reward or requirement interactions Normal player flow: ```txt Find RP element → read/interact → understand clue/context → continue roleplay ``` Example IC lines: ```txt “I found something near the alley.” “This NPC says they saw a black vehicle.” “There is a box here with markings on it.” “This note might be connected to the case.” ``` Players do not need to know how the scene was built. They only experience the final roleplay result. *** ### Player / IC Flow #### 1. The player enters a prepared area The player arrives at a location where staff or rolmakers placed content. This could be: * A crime scene * A business event * A hidden clue area * A faction location * A public event * A mystery scene * A social RP setup *** #### 2. The player sees or finds an element The player may notice: ```txt scene text a prop an NPC an interaction prompt a clue a dialogue response ``` The system helps communicate what the character can reasonably see or interact with. *** #### 3. The player interacts Depending on the setup, the player may: * Read a clue * Talk to an NPC * Inspect a prop * Unlock a response * Receive information * Trigger a follow-up * Receive a configured reward *** #### 4. The player continues the roleplay The information should help the player decide what to do next. Example: ```txt “The witness points you toward the old warehouse.” ``` The toolkit supports roleplay by giving context, not by forcing players into one single outcome. *** ### Rolmaker / Staff IC Usage For rolmakers, staff and event creators, SL Rolmaker Toolkit is a worldbuilding tool. The IC goal is to prepare believable roleplay content that players can discover naturally. Common rolmaker/staff uses: * Create an investigation scene * Place clues around an area * Add an NPC witness * Add props to support the story * Create event hints * Add interaction requirements * Prepare a staged scenario * Build a small narrative chain * Support police, EMS, civilian or faction RP Example staff flow: ```txt Choose story idea → create scene → add props/NPCs/clues → test interaction → open event ``` Example event use: ```txt Staff prepares a missing-person investigation. They place a witness NPC, a note, a damaged vehicle prop and several clues. Players arrive and follow the information through roleplay. ``` *** ### Admin / Owner IC Usage For admins and owners, SL Rolmaker Toolkit can be used to improve the world and support server events. Common admin/owner IC uses: * Build recurring RP scenes * Prepare special server events * Add interactive world details * Give staff better tools for storytelling * Create content for jobs or factions * Support investigations and public events * Test player-facing interactions * Remove old or incorrect content * Keep the world organized and readable Example admin flow: ```txt Prepare content → assign access → test scene → let players interact → clean up after event ``` The admin does not only manage files. They use the toolkit to create a more alive and structured RP world. *** ### Admin / Owner Technical Flow Admins and owners should configure access and test the toolkit before allowing staff to use it. Common admin actions may include: * Open the rolmaker panel * Create scenes * Add text elements * Add props * Add NPCs * Configure interactions * Configure requirements * Configure rewards * Manage access * Review logs * Delete or disable scenes * Test persistence after restart * Configure permissions * Configure database behavior Recommended admin checks: ```txt 1. Open the toolkit panel. 2. Create a test scene. 3. Add one text element. 4. Add one prop. 5. Add one NPC if enabled. 6. Add one interaction. 7. Test the interaction as a player. 8. Restart the resource. 9. Confirm saved content reloads if persistence is enabled. 10. Delete the test content. ``` *** ### Example IC Scenarios #### Investigation case Staff creates a crime scene with clues and a witness NPC. ```txt “The witness says they heard a loud engine before the crash.” ``` #### Business event A business owner prepares a themed opening with props and descriptions. ```txt “A welcome sign has been placed near the entrance.” ``` #### Faction story Staff prepares a faction-related scene with props and restricted information. ```txt “A marked crate sits behind the warehouse.” ``` #### EMS scene Staff adds context to an emergency scene. ```txt “There are medical supplies scattered near the stretcher.” ``` #### Public event Admins create an interactive event area. ```txt “Several booths are set up for the city fair.” ``` *** ### What this resource is not SL Rolmaker Toolkit is not intended to replace every mission system, dispatch system or full quest framework. It is focused on: ```txt roleplay scene creation NPC / prop / text placement narrative interactions clues requirements rewards staff tools event preparation ``` For larger systems, it can work together with dedicated investigation, faction, business or event resources. *** ### Main Features * Rolmaker/admin creation panel * Scene creation * Text elements * Prop elements * NPC elements * Interaction points * Clue-style content * Requirements * Rewards * Access management * Logs when enabled * Persistent content when database mode is enabled * Visual placement tools * Live preview / editing flow * ES/EN locale support * Configurable permissions * Admin/owner management tools * Clean SL Scripts style *** ### Dependencies #### Required ```txt FiveM server ``` #### Recommended / Optional ```txt oxmysql ox_lib ox_target qb-target QBCore Qbox ESX Standalone mode ``` If persistence is enabled, database support may be required. If target interaction is enabled, make sure the target resource starts before `sl_rolmaker_toolkit`. *** ### Installation Notes 1. Place the resource folder inside your server resources folder. Example: ```txt resources/[sl_scripts]/sl_rolmaker_toolkit ``` 2. Make sure the folder name is: ```txt sl_rolmaker_toolkit ``` 3. Configure: ```txt config/config.lua config/custom.lua locales/ ``` 4. If SQL is included and database mode is enabled, import: ```txt sql/install.sql ``` or use automatic migrations if supported by your build. 5. Add the resource to your `server.cfg`. Example: ```cfg ensure oxmysql ensure ox_lib ensure ox_target ensure sl_rolmaker_toolkit ``` If you are not using target interaction, configure fallback interaction mode in the config files. *** ### How to Use #### Basic Player Flow 1. The player enters a prepared RP area. 2. The player sees text, props, NPCs or interaction prompts. 3. The player reads or interacts with the element. 4. The player receives context, dialogue, clue or result. 5. The player continues the RP based on that information. #### Basic Rolmaker Flow 1. Rolmaker opens the toolkit panel. 2. Rolmaker creates a scene. 3. Rolmaker adds elements such as text, props or NPCs. 4. Rolmaker configures interactions, requirements or rewards. 5. Rolmaker tests the scene. 6. Rolmaker activates the scene for players. #### IC Summary ```txt Staff builds the scene → players discover it → roleplay continues ``` #### OOC / Technical Summary ```txt Panel opens → data is created → server validates/saves → clients sync elements → players interact ``` *** ### Commands Command names may depend on configuration. Common command examples: ```txt /rolmaker /scena ``` Possible admin/helper command examples: ```txt /rtk_myid /rtk_reload /rtk_daracceso /rtk_quitaracceso ``` Check the configuration files for the exact command names used by your installed version. Commands are mainly used to open the panel, manage access or support admin workflows. *** ### Permissions Permission setup depends on server configuration. Common permission levels may include: ```txt view use manage admin owner ``` Recommended access logic: ```txt Players = interact with active public content Rolmakers = create and edit assigned content Staff = manage scenes and review content Admins = full toolkit management Owners = full access ``` Permissions may use: * Ace permissions * Framework groups * Jobs * Job grades * Config admin list * Custom permission bridge Check the config files and `custom.lua` for your server setup. *** ### Scene Creation Guidelines Good rolmaker content should be: ```txt clear short useful IC-readable not forced easy to discover connected to the event or story ``` Good examples: ```txt A witness NPC gives a small clue. A note points toward another location. A prop shows that something happened here. A locked interaction requires a specific item. ``` Avoid: ```txt overloading players with long text forcing character emotions revealing OOC information creating too many props in one area placing clues with no purpose creating rewards without server validation ``` *** ### Configuration Open: ```txt config/config.lua ``` Common settings may include: ```txt Product information Locale Debug mode Startup logs Commands Permissions Scene settings Text settings Prop settings Ped/NPC settings Interaction settings Requirement settings Reward settings Database settings Target settings NUI settings Access management Logs/webhooks ``` Recommended for production: ```lua Config.Debug = false ``` Use debug mode only while testing or troubleshooting. *** ### Custom Integrations Open: ```txt config/custom.lua ``` Use this file for server-specific functions such as: * Custom notifications * Custom permission checks * Custom framework integration * Custom inventory checks * Custom reward delivery * Custom logging * Custom job restrictions * Custom admin checks If your server uses standard systems, you may not need many changes here. *** ### Startup Logs When the resource starts correctly, you may see logs similar to: ```txt [sl_rolmaker_toolkit][INFO] Server ready: SL Rolmaker Toolkit v1.1.0-alpha4 [sl_rolmaker_toolkit][INFO] Client ready: SL Rolmaker Toolkit v1.1.0-alpha4 | Use /rolmaker ``` If startup logs are disabled, check the configuration files. *** ### Troubleshooting #### Toolkit panel does not open Check: ```txt - The resource is started. - You are using the correct command. - You have permission to open the toolkit. - NUI files are included. - F8 console has no JavaScript errors. - Server console has no permission/config errors. ``` *** #### I cannot create a scene Check: ```txt - Your permission level allows scene creation. - Database is working if persistence is required. - Required fields are completed. - The scene limit has not been reached. - Server console has no validation errors. ``` *** #### Props do not appear Check: ```txt - The prop model exists. - The model name is correct. - You are within streaming distance. - Placement was confirmed. - Client F8 console has no model loading errors. ``` *** #### NPC does not appear Check: ```txt - The ped model exists. - NPC/ped features are enabled. - The model name is correct. - Spawn position is valid. - Client F8 console has no ped/model errors. ``` *** #### Interaction does not work Check: ```txt - Interaction is enabled. - Target or fallback interaction is configured. - The player is close enough. - Requirements are met. - Server-side validation is passing. - F8 and server console are clean. ``` *** #### Rewards do not work Check: ```txt - Reward is configured. - Inventory bridge is working. - Item exists in inventory system. - Server validates the reward. - Player meets all requirements. - Server console has no AddItem/payment errors. ``` *** #### Content disappears after restart Check: ```txt - Persistence is enabled. - Database is configured correctly. - oxmysql starts before sl_rolmaker_toolkit. - SQL tables exist. - Automatic migrations completed successfully if enabled. ``` *** #### Normal players can edit content Check: ```txt - Manage/admin permissions are configured correctly. - Framework group detection is working. - Ace permissions are not too broad. - custom.lua permission bridge is not returning true for everyone. ``` *** #### UI gets stuck or does not close Check: ```txt - F8 console has no JavaScript errors. - NUI callbacks are registered. - Another NUI is not blocking focus. - Resource folder name is correct. - Restart the resource and reconnect if needed. ``` *** ### Version Notes #### v1.1.0-alpha4 * Expansion/testing line focused on more advanced rolmaker tools. * Supports narrative scene building with NPC/prop/text interaction concepts. * Includes improvements around visual editing and roleplay presentation. * Intended for testing before treating as a final stable expansion line. #### v1.1.0-alpha series * Added NPC presence and subtle reaction concepts. * Improved roleplay feel around NPCs and scene interactions. * Continued development of expansion/DLC-style features separate from stable base behavior. *** ### Support When asking for support, include: ```txt Product: SL Rolmaker Toolkit Resource name: sl_rolmaker_toolkit Version: Framework: Target system: Database: Issue: Steps to reproduce: Server console error: Client F8 error: Screenshot/video: ``` Example: ```txt Product: SL Rolmaker Toolkit Resource name: sl_rolmaker_toolkit Version: v1.1.0-alpha4 Framework: Qbox Target system: ox_target Database: oxmysql Issue: Prop is created in the panel but does not appear in world Steps to reproduce: Open /rolmaker, create scene, add prop, confirm placement Server console error: none Client F8 error: attached Screenshot/video: attached ``` *** ### Final Notes SL Rolmaker Toolkit works best when used by staff or trusted rolmakers who understand the server’s roleplay style. For best results, create small clear scenes first, test every interaction and avoid overloading one area with too many elements. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://sl-scritps.gitbook.io/sl-scripts-documentation/products/sl-rolmaker-toolkit.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.