RiseV Docs
How to use the RiseV documentation
This docs area is made for buyers of RiseV scripts. Start with the general Installation page, then pick your script on the left for step-by-step setup, configuration and in-game usage. If something does not work as expected, use the Troubleshooting page as a checklist before opening a ticket.
- Select Home in the sidebar to come back to this overview at any time.
-
Below that, choose your script to open its pages
(for example
index.mdfor overview,config.mdfor settings,exports.mdandevents.mdfor advanced integration). - All content is written in Markdown and rendered here, so every update to the docs is available for you directly on this page.
- For a generic overview on how to install RiseV resources on your FiveM server, use the Installation page. If you run into problems afterwards, the Troubleshooting page guides you through the most common fixes.
For each script you will usually find: what the script does, requirements, a clean installation guide, recommended config values and examples you can copy-paste into your server setup.
Recommended reading order
When you install a script for the first time, go through the pages in this order:
overview (index.md) → script-specific installation/setup →
config.md for options →
exports.md / events.md if you want custom integrations.
If something does not work as expected, first re-check the docs and then the
Troubleshooting page before opening a support ticket.
Getting started
Installing a RiseV script from FiveM Keymaster
This page explains the generic installation flow for all RiseV resources you buy on the FiveM Keymaster. Always read the script-specific docs as well.
1. Download the resource from Keymaster
- Open keymaster.fivem.net in your browser.
- Log in with the CFX account that owns the RiseV script.
- Go to your purchased assets and select the script you want to install.
- Click the download button to get the latest version of the resource as a
.ziparchive.
2. Extract the .zip on your PC
- Move the downloaded
.zipto a safe folder on your PC (for exampleRiseV_Scripts/). - Right-click the file and extract it (Windows: "Extract all…", other OS: similar option).
- Inside the extracted folder you will see the actual resource folder (for example
risev_notify,risev_inventory, etc.). - Make sure there is no double nesting like
resources/risev_notify/risev_notify/. The resource folder should only be one level deep.
3. Place the resource in your FiveM server
- Connect to your server machine (FTP, SFTP or local file system).
- Open your FiveM server data directory, then the
resourcesfolder. - Optionally create a subfolder like
[risev]to keep all RiseV scripts grouped. - Upload the resource folder (for example
risev_notify) intoresources/[risev]/.
4. Add the resource to your server.cfg
- Open your
server.cfgin a text editor. - Add an
ensureline for the script, for example:ensure risev_notify - Place this line near other resources of the same type (for example together with UI or framework-related scripts), but after all hard requirements (ESX, MySQL, etc.).
- Save the file and restart the server.
5. First start & basic checks
- Start or restart your server and watch the console for errors related to the new resource.
- Join the server and open your F8 console. Check for red error messages that mention the RiseV script.
- If the script loads without errors, follow the script-specific docs (usually
config.mdandindex.md) to configure it for your server.
Good practice for updates
When updating to a new version from Keymaster, we will always give informations about
changes in configs so that youu don't have to configure all over agein
but we still recommended removing the old resource folder first
and upload the new one cleanly in some cases. Then merge your old configuration into the new
config files instead of overwriting everything. This prevents
issues from outdated files.
Support & troubleshooting
Troubleshooting checklist for RiseV scripts
If something does not work as expected, follow this step-by-step checklist before opening a support ticket. This helps to rule out common issues and makes support faster and easier.
1. Backup your current setup
- On your server, go to the
resourcesfolder and locate the RiseV script that is causing issues. - Download the whole resource folder to your PC as a backup
(including
config.luaand any custom files you changed). - Optionally rename the backup folder locally to something like
risev_notify_backup_YYYY-MM-DDso you can find it later.
2. Remove the script from the running server
- In your server console, run
stop <resourceName>for the script (for examplestop risev_notify). - Delete the resource folder from
resourceson the server (or move it out of the resources directory). - Remove or comment out the line in
server.cfgthatensures the resource.
3. Download the latest version from Keymaster
- Open keymaster.fivem.net and log in with the account that owns the script.
- Go to your purchased assets and download the latest version of the script.
- Extract the
.zipon your PC and upload the fresh resource to yourresourcesfolder (ideally into a folder like[risev]). - Add
ensure <resourceName>back toserver.cfgand restart the server.
4. Test with default configuration
- Before copying your old config, start the script once with the default configuration shipped by RiseV.
- Restart the server and join with a test account.
- Check if the basic functionality works (UI opens, commands run, no errors in server/F8 console).
- If everything works with default settings, the problem is usually related to your custom config or another resource on your server.
5. Reapply your custom config step by step
- Open your backup config and the new
config.luaside by side. - Copy your custom values in small blocks (for example framework settings first, then UI settings, then logging, etc.).
- After each block, restart the server and test again.
- If the script suddenly breaks after a certain change, you have found the problematic setting. Fix it or reset that part to the default value.
6. Check for conflicts with other resources
- Look for errors in your server console that mention other resources, duplicate events or exports, or missing dependencies.
- Make sure you are running a supported framework and versions (for example ESX Legacy, oxmysql, etc.).
- Temporarily disable other scripts that touch the same systems (for example other HUDs, other inventory systems) and test again.
7. Contact RiseV support
If the problem still exists after a clean re-install with the latest version and default config, it is time to reach out to support.
- Join the RiseV Discord (link on the main website or footer).
- Prepare the following information:
- Which RiseV script and which version you are using.
- Your FiveM build and operating system.
- Your framework (for example ESX Legacy) and main dependencies (for example oxmysql) including versions.
- Error messages from server console and F8 console (copy as text or screenshots).
- Short, clear steps to reproduce the issue in game.
- Open a ticket or follow the described support flow and paste this information so we can help efficiently.
Why this checklist matters
Following this flow (backup → clean install → default config → step-by-step changes) makes sure you don't lose your setup while still testing a clean environment. It also removes many common issues before support even needs to look at it, which means faster solutions for you.