Skip to main content
1

Install (or update) dependencies

Verify the dependencies below are started before our script in your server.cfg
2

Login to your CFX Portal & Download MS-Reports

You can login and download your assets here
3

Install & Modify Database

Head to ms-reports\sql\ and insert the SQL file into your database
4

Ensuring Asset(s)

To make sure the asset(s) starts & works properly we need to make sure all asset(s) start in the correct order in your server.cfg. Below you can find an example of how it can look like.
# 1. Start oxmysql
ensure oxmysql

# 2. Start your framework
ensure es_extended or qb-core or qbx_core

# 3. OPTIONAL: Start screenshot-basic
ensure screenshot-basic

# 4. Finally, start our asset singularly
ensure ms-reports
# Or, start all of our assets at once
ensure [ms]
5

Screenshots

To make screenshots work, you have to configure it. Currently we are only supporting discord in order to save & retrieve screenshots. Follow the guide below in order to activate screenshots in your script.
Create a Discord Webhook & Copy the Webhook URL
Image
Set your webhook in the server_config.lua
ServerConfig.ScreenshotWebhook = "your_webhook_url_here"
6

Set your Discord Bot Token & Guild ID

In the server_config.lua you must set your Bot Token and Guild ID (Required)
ServerConfig.Discord = {
    BotToken = "",
    GuildId = "",
Upon completion, do not delete the SQL folder or any .sql files or you will experience errors