# About MadonneStudio ## ๐ŸŽฎ What is MadonneStudio? MadonneStudio is an independent French development studio, founded in **2020**, with a mission to create immersive and personalized experiences for all its players. From the creation and sale of scripts, to the full development of video games, through the maintenance and management of game servers โ€” MadonneStudio covers a wide range of activities, all driven by the same core philosophy. Since its early days, MadonneStudio has consistently aimed to offer its users the most customizable experience possible. No matter which project you use, the goal is always the same: **configurability, flexibility and freedom**. > ๐Ÿ’ก These three words define every MadonneStudio project. Each resource is built so that server owners and players can shape their experience to fit their exact needs. *** ## ๐Ÿš€ Our Projects MadonneStudio develops and maintains several active projects: * ๐Ÿ›ก๏ธ [**Madonn'Admin**](https://madonnestudio.com/madmin/) โ€” A complete in-game moderation and administration solution, designed to equip your server and your staff team with the most comprehensive toolset available * ๐Ÿš” [**FivePD Server**](https://madonnestudio.com/fivepd/) โ€” A dedicated FiveM roleplay server focused on police and emergency services gameplay * ๐Ÿ“ฆ [**Addons & Scripts**](https://scripts.madonnestudio.com/) โ€” A growing catalog of free and paid FiveM resources, built for quality, performance and ease of use *** ## ๐Ÿ“ฌ Contact & Links * ๐ŸŒ **Website:** [madonnestudio.com](https://madonnestudio.com/) * ๐Ÿ’ฌ **Discord:** [discord.gg/madonne](https://discord.gg/madonne) * ๐Ÿ“ง **Email:** * ๐Ÿ“ **Address:** 60 Rue Franรงois Ier, 75008 Paris, France * ๐Ÿ“ž **Phone:** 01.85.09.31.93 **Follow us:** [YouTube](https://www.youtube.com/@MadonneStudio) ยท [Twitter / X](https://x.com/MadonneStudio) ยท [Instagram](https://www.instagram.com/madonnestudio/) ยท [Facebook](https://www.facebook.com/MadonneStudio) ยท [Twitch](https://www.twitch.tv/madonnestudio) ยท [LinkedIn](http://www.linkedin.com/company/madonnestudio) # How to buy our scripts ? ## ๐Ÿ›’ Our Scripts Store You may have visited one of our servers at some point. If so, you must have noticed the number of exclusive scripts specific to our experience. In order to share our work and allow you to build your own server with quality resources, we have decided to make part of our catalog available to everyone. All our scripts are sold exclusively on our dedicated store, which you can find at the following address: [**scripts.madonnestudio.com**](https://scripts.madonnestudio.com/) *** ## ๐Ÿค” Why Buy Our Scripts? As game server creators ourselves, we know better than anyone what a server receiving a large number of players actually needs. We are constantly looking for features that can be genuinely useful to each of you. Every script and resource we publish is **tested before release on servers with over a hundred connected players**. This process helps us identify any potential issues during large-scale use or when **OneSync** is enabled. As a result, all of our scripts are fully **OneSync compatible**. *** ## ๐Ÿ”’ A Note on Resource Protection > โš ๏ธ **DISCLAIMER:** All our resources are protected by the **FiveM Escrow system** in order to protect our work and ensure its longevity. This means that resources must be downloaded through the **CFX Portal**, and only servers using a **FiveM key that belongs to you** can run the resource. > > We strongly advise against using a FiveM key provided by your hosting provider. A key that does not belong to you will block the use of **any Escrow-protected resource**, without exception. Always use your own personal key. *** ## ๐Ÿ“ฆ How to Acquire a Script Follow these steps to purchase and download a resource: **1.** Visit [**scripts.madonnestudio.com**](https://scripts.madonnestudio.com/) and browse the catalog to find the resources that interest you. **2.** **Log in using your CFX.re account** to ensure the proper delivery of the resource to your account. **3.** *(Optional)* Connect your **Discord account** as well, to simplify future support requests on our Discord server. **4.** If you wish to acquire paid resources, proceed to checkout to validate your order. **5.** Once your order is confirmed, the resources will be available for download directly on the [**CFX Portal**](https://portal.cfx.re/). Navigate to the **Assets** section to find the resources you have just acquired and download them. **6.** Add the resource to your server and follow the installation guide for the relevant script. *** ## ๐Ÿ’ฌ Need Help? If you encounter any issue during the purchase or download process, our team is available on Discord: * ๐Ÿ’ฌ **Discord:** [discord.gg/madonne](https://discord.gg/madonne) * ๐ŸŒ **Website:** [madonnestudio.com](https://madonnestudio.com/) * ๐Ÿ“ง **Email:** # Need an extra support ? Need help setting up or using one of our game server scripts or resources? We're here to help! At MadonneStudio, we primarily create scripts for **FiveM**, **Minecraft**, and **Garry's Mod**, as well as resources for other game servers. We know that configuring and using these tools can sometimes be challenging, which is why we have put together all the help you need to get started and troubleshoot issues on your own. *** ## ๐Ÿ“– Check the Documentation First If you encounter any issue when using one of our scripts or resources, your first stop should always be our documentation. For each resource, you will find: * ๐Ÿ“ฅ **Installation guides** โ€” Step-by-step setup instructions * โš™๏ธ **Configuration references** โ€” Detailed explanations of every option * ๐Ÿงฉ **Usage guides & API references** โ€” How to use exports, events, and integrations * โ“ **Common Errors** โ€” Solutions to the most frequently encountered problems > ๐Ÿ’ก Most issues can be resolved by carefully reading the **Common Errors** page of the relevant script. We recommend checking it before reaching out. *** ## ๐Ÿ’ฌ Contact Us on Discord If you can't find the answer to your question in the documentation, feel free to reach out to us directly on our Discord server. Our team and community are active and will do their best to assist you as quickly as possible. ๐Ÿ‘‰ [**discord.gg/madonne**](https://discord.gg/madonne) When opening a support request, please provide as much context as possible: * The **name and version** of the resource you are using * A **description of the issue** and the steps to reproduce it * Any **error messages** from your server console * Your **server configuration** (framework, inventory, permission systemโ€ฆ) This helps us resolve your issue much faster. *** ## ๐Ÿ“ง Contact Us by Email If you do not have access to Discord, you can also reach us by email: ๐Ÿ“ฉ [**contact@madonnestudio.com**](mailto:contact@madonnestudio.com) Please include the same information listed above in your message so we can assist you efficiently. *** ## ๐ŸŒ Other Resources * ๐ŸŒ **Website:** [madonnestudio.com](https://madonnestudio.com/) * ๐Ÿ›’ **Scripts Store:** [scripts.madonnestudio.com](https://scripts.madonnestudio.com/) * ๐Ÿ“Š **Service Status:** [status.madonnestudio.com](http://status.madonnestudio.com/) *** We are passionate about creating quality tools for game servers, and we want you to get the most out of them. We are here to help you at every step of the way โ€” don't hesitate to reach out whenever you need it. # Audits **MadonneStudio Audits** is a professional audit service for FiveM and Discord servers. It is not a script โ€” it is a structured analysis carried out by our team, delivered as a complete PDF report with scores, strengths, weaknesses, and a prioritized action plan. The service is accessible at [audits.madonnestudio.com](https://audits.madonnestudio.com/). *** ## ๐Ÿ“– What is an audit? An audit is a full review of your server conducted by a MadonneStudio auditor across **137 criteria** organized in **13 categories**, covering three essential areas: * ๐ŸŒ **External presence** โ€” social media, website, public image, branding * ๐Ÿ’ฌ **Discord server** โ€” structure, moderation, community, bots, channels * ๐ŸŽฎ **FiveM server** โ€” performance, security, content, economy, scripts, staff Each criterion is graded **A**, **B**, or **C**: | Grade | Meaning | | ----- | ----------------------------------- | | **A** | Good โ€” meets the standard | | **B** | Average โ€” functional but improvable | | **C** | Insufficient โ€” requires attention | At the end of the audit, you receive a **PDF report** (available in French and English) including your category-by-category scores, your key strengths, your identified weaknesses, and a priority action plan built from your C-grade criteria. *** ## ๐Ÿ‘จโ€๐Ÿ’ผ Who is it for? MadonneStudio Audits is designed for any FiveM community that wants an objective, external view of their server โ€” whether they are just launching, going through a reboot, or trying to identify what is holding them back. *** ## ๐Ÿ”— Quick Links * [๐Ÿ“ฆ Offers & Pricing](/services/audits/offers-and-pricing) * [๐Ÿ–ฅ๏ธ Client Space](/services/audits/client-space) * [โ“ FAQ](/services/audits/f.a.q.) # Offers & Pricing MadonneStudio Audits is available in two formats: **subscriptions** for recurring audits at a set frequency, and **packs** for servers that prefer to buy audits on demand. *** ## Subscriptions Subscriptions automatically schedule a new audit at each renewal period. The higher the frequency, the higher the monthly price. | Plan | Frequency | Price | | ------------- | ---------------------- | -------------------------- | | **Monthly** | 1 audit / month | 20 โ‚ฌ / month | | **Bimonthly** | 1 audit every 2 months | 15 โ‚ฌ / month (billed 30 โ‚ฌ) | | **Quarterly** | 1 audit every 3 months | 10 โ‚ฌ / month (billed 30 โ‚ฌ) | > ๐Ÿ’ก Bimonthly and quarterly plans are billed at the period price, not a per-month equivalent. A quarterly subscription costs 30 โ‚ฌ every 3 months, not 10 โ‚ฌ per month. *** ## Packs Packs give you a fixed number of audits to use at your own pace, with no subscription or expiry. | Pack | Audits included | Price | | ---------- | --------------- | ------------------- | | **Pack 1** | 1 audit | 25 โ‚ฌ | | **Pack 3** | 3 audits | 65 โ‚ฌ *(save \~13%)* | | **Pack 5** | 5 audits | 95 โ‚ฌ *(save \~24%)* | Ideal for servers that want flexibility without a recurring commitment. Use them when it suits you. *** ## What's included in every audit Regardless of the plan, every audit includes: * Full review across **137 criteria** in **13 categories** * Coverage of **external presence**, **Discord server**, and **FiveM server** * A complete **PDF report** available in **French and English** * **Category-by-category scores** with letter grades (A / B / C) * A summary of **strengths** and **weaknesses** * A **priority action plan** based on your C-grade criteria *** ## How to subscribe Subscriptions and packs are available directly on our Tebex store: ๐Ÿ‘‰ [scripts.madonnestudio.com](https://scripts.madonnestudio.com/) Once your purchase is confirmed, your account is automatically created on the platform and you will receive your login credentials by email. > ๐Ÿ’ฌ Any questions? Contact us on Discord: [discord.gg/madonne](https://discord.gg/madonne) # Client Space Once your subscription or pack is active, you can access your client space at [audits.madonnestudio.com](https://audits.madonnestudio.com/). Your account is created automatically after purchase and your login credentials are sent by email. *** ## Dashboard The dashboard is your main overview. It shows: ### Active Contract A summary of your current subscription or pack: * Plan type (monthly, bimonthly, quarterly, or pack) * Contract status (active, expired, cancelled) * Number of audits completed * For subscriptions: date of the next scheduled audit * For packs: number of audits remaining ### Strengths & Weaknesses A summary automatically generated from your most recent audit, highlighting your best-performing categories and the areas that most need improvement. ### Priority Action Plan A top-5 list of the most critical points to address, built from criteria graded **C** in your last audit. Each item is actionable and directly extracted from your report. ### Score Evolution A chart tracking your overall score across all completed audits, with a projected trend line to help you visualize your progress over time. ### My Reports A list of all completed audit reports, with a direct download link for each one. Reports are available in **French** and **English**. *** ## Reports The Reports page gives you access to all your PDF reports in one place. Each report includes: * Your **scores per category** with letter grades * The **detail of every criterion** graded in the audit * A **summary page** with strengths, weaknesses, and the priority action plan Reports are generated in both **French and English** and are available immediately after the auditor validates the audit. *** ## Notifications The notifications page keeps you informed of any updates on your audits โ€” when a new audit is started, when it is completed, and when your report is ready to download. *** ## Account From your account settings you can update your server name, your email address, and your preferred language (French or English). Your preferred language determines which version of the PDF report is downloaded by default. # F.A.Q. ## What exactly is audited? Your server is reviewed across **137 criteria** organized in **13 categories**, covering three areas: external presence (social media, website, branding), Discord server (structure, channels, moderation, bots), and FiveM server (performance, security, content, economy, scripts, staff). *** ## How long does an audit take? Audit duration depends on the complexity of your server. Once the auditor begins the review, you will be notified when it is complete and your report is ready to download. *** ## In what language is the report delivered? Reports are generated in both **French and English**. The version downloaded by default matches your account language preference, but both versions are always available. *** ## What do the grades A, B, C mean? Each of the 137 criteria is graded as follows: * **A** โ€” Good. The criterion is met. * **B** โ€” Average. The criterion is functional but could be improved. * **C** โ€” Insufficient. The criterion requires attention and is included in your action plan. *** ## What is the priority action plan? The action plan is a list of the most critical improvements to make, automatically generated from the criteria you received a **C** grade on. It is included in your PDF report and also displayed directly in your dashboard. *** ## Can I request a new audit before the end of my subscription period? No โ€” subscriptions schedule one audit per period. If you need additional audits outside of your subscription rhythm, you can purchase a pack separately. *** ## What happens when a pack runs out? When all audits in a pack have been used, the pack is marked as complete. You can purchase a new pack or subscribe at any time from the Tebex store. *** ## My account was not created after purchase โ€” what should I do? Account creation is automatic after payment confirmation. If you did not receive your credentials within a few minutes, contact us on Discord and we will sort it out manually. ๐Ÿ‘‰ [discord.gg/madonne](https://discord.gg/madonne) *** ## Can I cancel my subscription? Yes โ€” you can cancel your subscription at any time from the Tebex store. The subscription remains active until the end of the current billing period. *** ### I have a question not covered here. Join us on Discord and open a ticket โ€” we will get back to you as soon as possible. ๐Ÿ‘‰ [discord.gg/madonne](https://discord.gg/madonne) ๐ŸŒ [audits.madonnestudio.com](https://audits.madonnestudio.com/) ๐Ÿ“ง # Madonn'Admin Madonn'Admin is the ultimate moderation and administration solution created by MadonneStudio. Designed from the ground up for FiveM server owners who take their community seriously, it brings together everything you need to protect your players, manage your staff, and run your server with full control โ€” in-game, on the web, and on mobile.
*** ## ๐Ÿ“– About Madonn'Admin Trollers, cheaters, and bad actors will no longer have any excuse for going unpunished. With Madonn'Admin, your moderation team has access to a complete toolset at all times. The resource connects to the **Madonn'Admin cloud platform** (`madonnadmin.com`) to handle player profiles, sanctions, staff permissions, and real-time data synchronization across all your servers. ## โœจ Main Features * ๐ŸŽฎ **In-Game Dashboard** โ€” A complete admin panel accessible via `F10` (configurable), featuring a player list, live logs, report management, and all moderation actions, without ever leaving the game * ๐Ÿ’ป **Web Dashboard** โ€” A full administration interface accessible from any browser, on desktop or mobile, synchronized in real time with the in-game panel * ๐Ÿ‘ฅ **Staff & Role Management** โ€” Create up to 5, 10, or 15 custom roles per server with granular per-permission control, and assign up to 10, 15, or 50 staff members depending on your plan * โš–๏ธ **Sanction System** โ€” Apply notes, commends, warns, kicks, temporary bans, permanent bans, and community bans, all stored permanently on each player's profile * ๐Ÿšจ **Report System** โ€” Players submit reports in-game via `/report`, with automatic screenshot capture, real-time staff notifications, built-in messaging, and full statistics on the web dashboard * ๐Ÿ—บ๏ธ **Player Blips & Nametags** โ€” Active staff see player blips and nametags on the map, with trust level color coding and driver indicators * ๐Ÿ” **Spectate System** โ€” Discretely spectate any player with a built-in scaleform interface and `F` key to exit * ๐Ÿ“‹ **Activity Logs** โ€” Track connections, chat messages, shots, injuries, deaths, explosions, and name changes, with automatic Discord webhook delivery and automatic screenshots on kills * ๐Ÿ˜๏ธ **High Density Zones** โ€” Automatically detect and display map areas where players are clustering, color-coded by density level * ๐Ÿ“ฃ **Broadcast & Staff Chat** โ€” Send server-wide messages or communicate privately with your staff team via a dedicated admin chat command * ๐Ÿ”” **Notification System** โ€” Compatible with `default`, `chat`, `MS_Madonne_Notify`, `okokNotify`, or a fully custom handler * ๐Ÿ›ก๏ธ **Anti-Cheat** *(Silver & Gold)* โ€” Built-in detection for prop spam, explosion spam, vehicle spam, noclip, freecam, invisibility, sound exploits, event spoofing, and task clearing โ€” all auto-banning with configurable durations * ๐Ÿค– **Birgitte AI Assistant** *(Gold)* โ€” AI-powered assistant integrated into the dashboard with username compliance checking at connection * ๐Ÿงฉ **Developer Exports** โ€” `GetStaffRank`, `IsPlayerTrusted` (client), `GetStaffLevelServerSide`, `GetStaffStatus` (server) * ๐ŸŒ **Multi-Language** โ€” English, French, and Spanish included out of the box * ๐Ÿ“ฆ **Multi-Server** โ€” Manage up to 2, 5, or 10 servers from a single account and dashboard *** ## ๐Ÿ”— Quick Links * [๐Ÿš€ First Launch](/paid-scripts/madonnadmin/first-launch) * [๐Ÿ“ฅ Installation](/paid-scripts/madonnadmin/script-installation) * [โš™๏ธ Configuration](/paid-scripts/madonnadmin/configuration) * [๐Ÿ–ฑ๏ธ Utilisation](/paid-scripts/madonnadmin/how-to-use-it) * [๐Ÿงฉ Exports & API](/paid-scripts/madonnadmin/api-exports) * [โ“ Common Errors](/paid-scripts/madonnadmin/common-errors) # First Launch Before installing the resource on your server, you need to create and configure your **Madonn'Admin community** on the web platform. This step is required โ€” the resource cannot load without a valid server token linked to an active subscription. *** ## ๐Ÿ’ณ Payment When subscribing, it is imperative to **provide a valid email address**. All information relating to your Madonn'Admin account will be sent to this address. After validating your payment, a confirmation email will be automatically sent by our service from ****. This email contains crucial information such as your credentials, your **community token**, and direct links to the documentation. > ๐Ÿ’ก If you do not receive the email within a few minutes, check your spam or junk mail folder. If you still cannot find it, contact our support on Discord immediately. Keep this email somewhere safe โ€” you will need it to set up your community. *** ## ๐Ÿ‘ค Step 1 โ€” Create your account Once you have received your email, create your Madonn'Admin account at [**madonnadmin.com**](https://madonnadmin.com/). This account is the main entry point to manage your server, your staff, and your community settings. Once logged in, your account will be **automatically associated with your community**. *** ## ๐Ÿ”‘ Step 2 โ€” Retrieve your Community Token Your **Community Token** is a unique identifier required for various administrative actions. It was included in the email sent by our services and looks like this: ``` x000xx0xx0xxx0xx00xx0xx0xx000xxx ``` It can also be found at any time in your **community settings** on the Madonn'Admin dashboard. Keep it safe and never share it publicly. *** ## โš™๏ธ Step 3 โ€” Initial setup Once registered, follow the initial setup steps on the dashboard: * Configure your **community name** โ€” this is displayed in-game as the prefix in notifications and staff chat messages * Set your **language** (English, French, or Spanish) * Set your **timezone** โ€” used for accurate log timestamps *** ## ๐Ÿ–ฅ๏ธ Step 4 โ€” Add your server In the dashboard, navigate to **Servers** and add a new server. Fill in: * The **server name** * The **public IP address** of your FiveM server > โš ๏ธ The IP address must match exactly the one your FiveM server is running on. An incorrect IP will prevent the resource from authenticating. Once created, your **Server Token** will be generated. Copy it โ€” you will need it in `config/cfg_main.lua` (see [๐Ÿ“ฅ Installation](/paid-scripts/madonnadmin/script-installation)). *** ## ๐ŸŽญ Step 5 โ€” Create your staff roles In **Roles**, create the ranks for your moderation team. For each role you can configure: * The **role name** and **display color** (shown on nametags and in the staff list) * The **rank order** * **Per-permission toggles** โ€” teleportations, spectate, god mode, submarine mode, delete radius, broadcast, and more > ๐Ÿ’ก Rank `-1` is the **super admin** rank and bypasses all permission checks. Rank `0` means the player has no staff access. *** ## ๐Ÿ‘ฎ Step 6 โ€” Add staff members Adding a player as a staff member requires a few steps to ensure a secure and correct association. **Requirements before adding a staff member:** * The player must have **connected at least once** to your server. This initial connection allows Madonn'Admin to recognize the player and automatically generate their profile on the platform. * You must send the player your **Community Token** (see Step 2). The player must enter this token in the settings of their own Madonn'Admin account to link themselves to your community. **How to finalize the association:** Once the player has connected and entered the token, go to their **Madonn'Admin profile**. A box will appear under their username, showing the name linked to their account. Click on this box to officially add the player to your community as a staff member.
This creates a permanent link between the player and your community. If you later wish to remove this link, click the **trash icon** to delete the association. *** ## ๐Ÿท๏ธ Step 7 โ€” Assign a role to a staff member At this point, the staff member is linked to your community but does not yet have a specific role. To assign one: * Go to **Team Staffs** โ†’ **Manage Staffs** in the dashboard * Select the **server** on which you want to assign the permissions * Enter the **username** of the staff member * Choose the **role** to assign This ensures each staff member has the appropriate permissions to fulfill their functions while maintaining a clear and structured organization within your team.
*** ## ๐Ÿ“ฃ Step 8 โ€” Configure broadcasts & announcements *(optional)* In **Broadcasts**, pre-save server-wide message templates that staff can send with a single click from the in-game dashboard. In **Announcements**, post staff-facing messages that appear on the admin panel homepage โ€” useful for shift instructions, event reminders, or moderation guidelines. *** ## โœ… You're ready Your community, server, roles, and staff are now configured. Proceed to the [๐Ÿ“ฅ Installation](/paid-scripts/madonnadmin/script-installation) page to set up the resource on your FiveM server. # Script Installation ## ๐Ÿ“‹ Requirements * A **FiveM server** running on artifact `2699` or above * An active **Madonn'Admin subscription** with a configured community and server token (see [๐Ÿš€ First Launch](/paid-scripts/madonnadmin/first-launch)) * *(Optional)* `screenshot-basic` โ€” required for the automatic screenshot system (reports and anti-cheat) * *(Optional)* `MS_Madonne_Notify` or `okokNotify` for enhanced notifications *** ## โฌ‡๏ธ Step 1 โ€” Download the resource Download the latest version of **MS\_MadonnAdmin** from the [CFX Portal](https://portal.cfx.re/), the official Cfx.re platform for downloading your purchased resources. > ๐Ÿ’ก You must be logged in with the account used to purchase or claim the resource. *** ## ๐Ÿ“ Step 2 โ€” Add to your server Copy the `MS_MadonnAdmin` folder into your server's **resources directory**. ``` your-server/ โ””โ”€โ”€ resources/ โ””โ”€โ”€ MS_MadonnAdmin/ โ”œโ”€โ”€ client/ โ”œโ”€โ”€ config/ โ”œโ”€โ”€ server/ โ”œโ”€โ”€ shared/ โ”œโ”€โ”€ ui/ โ””โ”€โ”€ fxmanifest.lua ``` *** ## ๐Ÿ”‘ Step 3 โ€” Set your Server Token Open `config/cfg_main.lua` and paste your **Server Token** from the Madonn'Admin dashboard: ```lua CONFIG = { Server_Token = "your-server-token-here", ... } ``` > โš ๏ธ This token is what authenticates your server with the Madonn'Admin platform. Without a valid token, the resource will refuse to start. *** ## ๐Ÿ“ Step 4 โ€” Add to server.cfg Add the following lines to your `server.cfg`. Make sure `oxmysql` and optionally `screenshot-basic` are started **before** `MS_MadonnAdmin`: ```cfg ensure screenshot-basic # optional, required for screenshots ensure MS_Madonne_Notify # optional, for enhanced notifications ensure MS_MadonnAdmin ``` *** ## โš™๏ธ Step 5 โ€” Configure the resource The main configuration file is `config/cfg_main.lua`. The most important options to set up at first launch are: ```lua CONFIG = { Server_Token = "your-server-token-here", -- Key to open the admin menu in-game (default: F10) OpenAdminMenu = 'F10', -- Timezone offset for logs (e.g. 1 = UTC+1) Timezone = "+1", -- Notification system: "default" | "chat" | "okokNotify" | "MadonneNotify" | "custom" NotificationSystem = "default", -- Enable/disable modules ModuleAnticheat = true, -- Silver & Gold only ModuleLogs = true, ModuleScreenshots = true, -- Requires screenshot-basic -- Restart announcement system RestartAnnouncement = { Enabled = true, Hours = { "22:00", "04:00", "10:00", "16:00" }, XMinutesBefore = { 30, 10, 5, 2, 1 } } } ``` Each module has its own config file under `config/module/`: | File | Description | | --------------------- | ------------------------------------------------------------------ | | `cfg_anticheat.lua` | Anti-cheat detection rules, ban lengths, whitelists | | `cfg_blips.lua` | Player blips, nametags, high density zones, active staff display | | `cfg_brigitteai.lua` | Birgitte AI settings (Gold only) | | `cfg_button.lua` | Custom quick action buttons in the player profile and report panel | | `cfg_commands.lua` | Enable/disable and rename all in-game commands | | `cfg_logs.lua` | Discord webhooks per log type, ignored weapons | | `cfg_reports.lua` | Quick report presets, screenshot on report, notification options | | `cfg_sanctions.lua` | Splash message on sanction, show ban author | | `cfg_screenshots.lua` | screenshot-basic resource name, Discord webhook for screenshots | *** ## ๐Ÿ”” Step 6 โ€” Configure the report command In `config/module/cfg_reports.lua`, configure the quick reports available to players: ```lua REPORTS_CONFIG = { ReportsEnabled = true, CreateReportCommand = "report", -- Up to 10 quick report types QuickReports = { "Bug", "Question", "Freekill", "NoFear", "NoPain", "Insults", "Cheater", "Spectate me", "New player" }, TakeScreenshotWhenReportIsCreated = true, } ``` *** ## ๐Ÿช Step 7 โ€” Set up custom actions *(optional)* The `config/module/cfg_button.lua` file lets you add custom quick action buttons that appear on each player's profile in the admin panel and in the report panel. Each button runs a Lua function on the targeted player's client: ```lua BUTTONS = { [1] = { Title = "Heal", HaveAccess = true, -- true = all staff, or {1,2,3} = specific rank IDs EnableCommandForThisButton = true, CommandName = "heal", CommandSuggestionText = "Heal a player", AddInReportMenu = true, Actions = function() SetEntityHealth(PlayerPed, 200) end }, -- Add as many as needed } ``` *** ## ๐Ÿ”„ Step 8 โ€” Restart your server Restart your server or run the following in the console: ``` refresh start MS_MadonnAdmin ``` If the Server Token is valid and your community is correctly configured, you should see the following in the console: ``` [SUCCESS] Madonn'Admin was successfully initialized. Thank you for using MadonneStudio ressources ! [SUCCESS] Retrieving community settings from the Madonn'Admin database : COMPLETED ! ``` Madonn'Admin is now live! โœ… Staff members can open the admin panel in-game by pressing **`F10`** (default) and activating their moderation mode. # Configuration Before your staff members can open the admin panel in-game, Madonn'Admin requires a small amount of setup โ€” both on the web platform and in the resource files. This section covers everything you need to configure to get your community running. Configuration is split into two parts: the **Dashboard Configuration**, done entirely from the Madonn'Admin web platform, and the **Script Configuration**, done directly in the resource files on your FiveM server. *** ## ๐Ÿ–ฅ๏ธ Dashboard Configuration The dashboard is where you define the structure of your community: your servers, your staff hierarchy, and how the platform behaves. This is where you will: * Set up your **community identity** โ€” name, language, timezone, and trust score settings * Add your **FiveM servers** and retrieve their unique tokens * Create **staff roles** and configure their permissions * Install the **Discord bot** to receive notifications directly in your Discord server ๐Ÿ‘‰ [Dashboard Configuration](/paid-scripts/madonnadmin/configuration/dashboard-configuration) *** ## ๐Ÿ“ Script Configuration The script configuration is done through the Lua files located in the `config/` folder of the resource. These files are not escrowed and can be freely edited. This is where you will: * Paste your **Server Token** and configure core behavior * Enable or disable **modules** (anti-cheat, logs, screenshots) * Define **staff commands**, **custom action buttons**, and **notification preferences** * Configure the **anti-cheat** detection rules, sensitivity, and ban lengths * Set up **Discord webhooks** for activity logs * Customize the **report system** and its quick report presets ๐Ÿ‘‰ [Script Configuration](/paid-scripts/madonnadmin/configuration/script-configuration) *** > ๐Ÿ’ก **Where to start?** If this is your first time setting up Madonn'Admin, begin with the [๐Ÿš€ First Launch](/paid-scripts/madonnadmin/first-launch) guide, which walks you through the full setup process from account creation to your first server connection. # Dashboard Configuration The Madonn'Admin web dashboard is the central hub for managing your community. It is accessible from any browser at [**madonnadmin.com**](https://madonnadmin.com/) and is fully synchronized in real time with your in-game resource. This section covers the four configuration areas available on the dashboard before using Madonn'Admin in-game. *** ### ๐Ÿ“„ Pages * [๐Ÿ˜๏ธ Community Settings](/paid-scripts/madonnadmin/configuration/dashboard-configuration/community-settings) โ€” Configure your community name, language, timezone, and token * [๐Ÿ–ฅ๏ธ Manage Servers](/paid-scripts/madonnadmin/configuration/dashboard-configuration/manage-servers) โ€” Add and manage the FiveM servers linked to your community * [๐ŸŽญ Manage Permissions](/paid-scripts/madonnadmin/configuration/dashboard-configuration/manage-permissions) โ€” Create staff roles and assign permissions per role per server * [๐Ÿค– Install the Discord Bot](/paid-scripts/madonnadmin/configuration/dashboard-configuration/install-the-discord-bot) โ€” Connect the Madonn'Admin Discord bot to your community server *** > ๐Ÿ’ก These settings must be configured **before** installing the resource on your server. The resource will not load without a valid server token linked to an active subscription. > > If you haven't completed this step yet, refer to the [๐Ÿš€ First Launch](/paid-scripts/madonnadmin/first-launch) guide. # Community Settings Community Settings is the first section to configure after creating your Madonn'Admin account. It defines the identity of your community and contains the token your server uses to authenticate with the platform. Access it from the Madonn'Admin dashboard sidebar under **Community Settings**.
*** ## ๐Ÿท๏ธ Community Name The community name is displayed in-game as the **prefix** in several places: * Staff chat messages (`[STAFF CHAT] CommunityName :`) * Broadcast messages * Notification messages sent to players * The loading screen during profile verification Choose a short, recognizable name for your community. *** ## ๐ŸŒ Language Madonn'Admin supports three languages out of the box: * ๐Ÿ‡ฌ๐Ÿ‡ง **English** * ๐Ÿ‡ซ๐Ÿ‡ท **French** * ๐Ÿ‡ช๐Ÿ‡ธ **Spanish** The selected language applies to all in-game text โ€” nametag labels, sanction messages, log descriptions, ban screen translations, and the admin panel interface. > ๐Ÿ’ก The language is set at the community level and applies to all servers in your community. It can be changed at any time โ€” staff members will see the new language on their next connection. *** ## ๐Ÿ• Timezone The timezone setting controls the timestamp formatting used in **activity logs**. Set it to your local UTC offset to ensure log times match your team's timezone. Examples: * `+1` โ†’ UTC+1 (Central European Time) * `0` โ†’ UTC * `-5` โ†’ UTC-5 (Eastern Standard Time) This value is also used by the restart announcement system to correctly calculate when to send warnings before scheduled restarts. *** ## ๐Ÿ”‘ Community Token The **Community Token** is the unique identifier for your community. It is used in two situations: * **Server authentication** โ€” pasted into `config/cfg_main.lua` as `Server_Token` to link your FiveM server to your community * **Staff member onboarding** โ€” shared with new staff members so they can link their player profile to your community from their Madonn'Admin account settings Your token is displayed in the Community Settings page and looks like this: ``` x000xx0xx0xxx0xx00xx0xx0xx000xxx ``` > โš ๏ธ Keep your Community Token private. Anyone with this token can attempt to link themselves to your community. Never post it publicly. *** ## โญ Trust Score Settings The Trust Score is a numerical value attached to each player's profile that evolves over time based on their behavior and history on your server. It is used by Madonn'Admin to automatically assign **trust flags** that are visible to your staff team.
You can configure the following parameters: * **Starting score** โ€” The score assigned to a new player on their first connection * **Score increase rate** โ€” How much the score increases per hour of playtime. The longer a player stays without incidents, the more trusted they become. * **Penalty weights** โ€” The score impact (positive or negative) of each type of sanction on a player's profile (warns, kicks, bans, commendsโ€ฆ) ### ๐Ÿ… Flag Thresholds The following three options configure the thresholds at which **visual flags** are applied to a player's profile: * **Perfect Player** โ€” After a configurable ratio of hours played per penalty, a player is awarded the *Perfect Player* flag * **Negative flags** โ€” After a configurable number of penalties, negative flags such as *Untrusted* or *Sanction Lover* are applied > ๐Ÿ’ก These flags are **visual indicators only**. They appear in the admin panel and on player profiles to help staff assess a player at a glance, but they do not automatically restrict or affect gameplay. *** ## ๐Ÿ” Accumulation of Sanctions Madonn'Admin can automatically apply a **temporary ban** when a player accumulates a certain number of warnings on their profile. This allows you to enforce progressive discipline without requiring manual intervention from your staff.
You can configure: * **Number of warnings required** โ€” After this many active warnings, a temporary ban is automatically triggered * **Ban duration** โ€” The length of the automatic ban applied > โš ๏ธ Only **active warnings** are counted. Warnings that have been removed through a successful appeal are not included in the total. If you wish to effectively disable this feature, set the warning threshold to an unreachable number such as `99` or `999`. There is very little risk of a player ever reaching such a count. *** ## โš–๏ธ Appeals Management Players have the ability to submit **appeal requests** to contest sanctions applied to their profile. You can configure the conditions under which a player is eligible to submit an appeal: * **Duration between two appeals** โ€” The minimum amount of time a player must wait before submitting a new appeal after a previous one * **Minimum and remaining ban duration** โ€” A ban appeal can only be submitted if the ban meets a minimum total duration and still has a sufficient amount of time remaining * **Age of a sanction** โ€” For sanctions other than active bans, you can define a maximum age beyond which the sanction can no longer be appealed
> ๐Ÿ’ก Appeals that are accepted by your staff result in the sanction being removed from the player's profile. Accepted appeals are **not counted** in the warning accumulation system # Manage Servers The Manage Servers section lists all the FiveM servers linked to your Madonn'Admin community. Each server has its own **Server Token** used to authenticate the in-game resource. The maximum number of servers depends on your subscription plan: * ๐Ÿฅ‰ **Bronze** โ€” up to 2 servers * ๐Ÿฅˆ **Silver** โ€” up to 5 servers * ๐Ÿฅ‡ **Gold** โ€” up to 10 servers *** ## ๐Ÿ“‹ Server List For each server in the list, the following information is displayed: * **Name** โ€” The name you gave the server when creating it * **IP Address** โ€” The public IP of the FiveM server. This must be exact for all Madonn'Admin features to work correctly. * **Status** โ€” Whether the server is currently online or offline * **Connected players** โ€” The number of players currently on the server * **Connected staff** โ€” The number of staff members currently online
Each server also has three action buttons: * ๐Ÿ“‹ **Copy Token** โ€” Copies the unique Server Token to your clipboard. This token is what you paste into `config/cfg_main.lua` on your FiveM server. * โœ๏ธ **Edit** โ€” Opens the server settings form to modify its configuration * ๐Ÿ—‘๏ธ **Delete** โ€” Removes the server from your community *** ## โž• Adding a Server Click **Add a server** to open the configuration form. The same form is used when editing an existing server. ### ๐Ÿ“ Form Fields **Server Name** A display name for this server, shown in the dashboard and in statistics. **Server IP Address** The public IP address of your FiveM server. > โš ๏ธ The IP address must be **correct and the server must be running** at the time of registration. Madonn'Admin will attempt to connect to this IP to verify it before saving. An unreachable or incorrect IP will prevent the server from being registered. **Discord Webhook โ€” Pending Sanctions** An optional Discord webhook URL. When a staff member applies a sanction that requires **validation from a superior** before being applied, a notification is automatically sent to this webhook. The message indicates which staff member submitted the request and which sanction is awaiting approval. > ๐Ÿ’ก This webhook is useful for servers with a multi-tier moderation system where higher-ranked staff must approve certain sanctions before they go through. **Discord Webhook โ€” Announcements** An optional Discord webhook URL for staff announcements. When an announcement is posted from the Madonn'Admin dashboard, it is automatically forwarded to the specified Discord channel. By default, no Discord role is pinged when an announcement is sent. To ping a specific role, enter its **Discord role ID** in the field provided below the webhook URL. > ๐Ÿ’ก To get a role ID in Discord, enable **Developer Mode** in Discord Settings โ†’ Advanced, then right-click any role in the role list and select **Copy ID**.
*** ## ๐Ÿ”‘ Retrieving your Server Token After creating a server, its unique token can be retrieved at any time using the **Copy Token** button on the server's entry in the list. Paste it into your FiveM resource configuration: ```lua -- config/cfg_main.lua Server_Token = "your-server-token-here", ``` > โš ๏ธ Each server has its own unique token. Never use the same token across multiple servers. *** ## ๐Ÿ—‘๏ธ Removing a Server Click the **Delete** button on a server entry to remove it from your community. This frees up a server slot within your plan's limit. > Removing a server does not delete its historical data (players, sanctions, logs). All data remains accessible on the dashboard. # Manage Permissions The Manage Permissions section is where you create and configure the **staff roles** for your community. Each role defines a precise set of permissions that determines what a staff member can see and do โ€” both in the in-game admin panel and on the web dashboard. The maximum number of roles per server depends on your subscription plan: * ๐Ÿฅ‰ **Bronze** โ€” up to 5 roles per server * ๐Ÿฅˆ **Silver** โ€” up to 10 roles per server * ๐Ÿฅ‡ **Gold** โ€” up to 15 roles per server *** ## ๐Ÿ“‹ Roles List
Each server has its own roles list, displayed as a summary table. For each role you can see its name, color, and the permissions that have been granted to it. From this table you can: * **Reorder roles** โ€” Drag and drop roles to change their hierarchy. The order determines authority levels between staff members: roles higher in the list outrank roles below them. * **Edit a role** โ€” Modify its name, color, or any of its permissions * **Delete a role** โ€” Remove it from the server. Staff members assigned to this role will lose their permissions until a new role is assigned.
*** ## โž• Adding a Role A form at the bottom of the page allows you to create new roles. The same form is used when editing an existing role.
### ๐Ÿ“ Form Fields **Server** Select the server for which this role is created. Roles are per-server โ€” the same role name can exist on multiple servers with different permission sets. **Role Name** The display name for this role, shown in: * The staff list in the in-game admin panel * Player nametags above staff members * The web dashboard staff overview **Color Code** *(hexadecimal)* The color associated with this role. It is used for the role badge in the dashboard and for the nametag color displayed in-game above the staff member's character. *** ## ๐Ÿ” Permissions Below the basic settings, you will find the full list of permissions available in Madonn'Admin. Simply check the ones you want to grant to the role you are creating. ### Standard Permissions * **Spectate** โ€” Allows the staff member to spectate players using the in-game spectate system or the `/spectate` command * **God Mode** โ€” Allows the staff member to enable invincibility while in active moderation mode, from the Settings tab of the admin panel * **Broadcast** โ€” Allows the staff member to send server-wide broadcast messages from the admin panel, using both free-text and pre-saved templates * **Teleportations** โ€” Allows the staff member to use Go To, Go To Car, Bring, and Return actions on players * **Options Tab** โ€” Grants access to the Settings tab in the admin panel. Automatically enabled if God Mode, Submarine, or Mass Delete are granted. ### โš ๏ธ Special Permissions Some permissions have additional configuration options that appear when they are checked: **๐Ÿ”จ Temporary Ban** When this permission is enabled, an additional field appears asking for the **maximum ban duration in days** that this role is allowed to apply. This caps the ban length a staff member of this rank can issue โ€” they will not be able to apply a ban longer than the configured limit. > ๐Ÿ’ก Permanent bans and community bans are separate permissions and are not affected by this cap. **๐Ÿคฟ Submarine Mode** Allows the staff member to activate their moderation mode while remaining **hidden from the view of other players**. When in Submarine mode, the staff member appears as a regular player on the map and in nametags, allowing them to monitor situations discreetly without alerting rule-breakers. > ๐Ÿ’ก Higher-ranked staff can still see Submarine-mode staff with a specific nametag prefix, configurable in `cfg_blips.lua`. **๐Ÿ—‘๏ธ Massive Delete Radius** When this permission is enabled, an additional field appears to set the **maximum radius in units** within which the staff member can use the mass deletion tools (delete vehicles, delete objects) from the Settings tab of the admin panel. Setting a radius of `0` effectively disables this tool for the role, while a large value gives the staff member broad deletion capabilities.
*** ## ๐Ÿ”„ Updating or Revoking a Role * To **change** a staff member's role, go to **Team Staffs โ†’ Manage Staffs**, select the server, and assign a different role * To **revoke** all access, delete the staff member's association with your community using the trash icon on their profile * Permission changes take effect on the player's **next connection** to the server *** > ๐Ÿ’ก Rank `-1` is the **super admin** rank and bypasses all permission checks. Rank `0` means the player has no staff access at all. These special ranks cannot be assigned through the role creation form โ€” they are reserved by the platform. # Install the Discord Bot This page allows you to install the Madonn'Admin Discord bot on the Discord server of your choice. Once connected, the bot extends the platform's capabilities directly into your Discord โ€” giving your team access to player information, server status, and more without leaving Discord. *** ## ๐Ÿ› ๏ธ Installation Installing the bot is straightforward: 1. Click the **Login with Discord** button on the page 2. **Select the Discord server** on which you want to install the Madonn'Admin bot 3. Follow the authorization steps presented by Discord 4. Madonn'Admin takes care of the rest โ€” the bot will be automatically configured for your community **That's it!** The Discord bot is now ready to use on your server. ๐ŸŽ‰ # Script Configuration All configuration files for Madonn'Admin are located in the `config/` folder. None of these files are escrowed โ€” they can be freely edited to match your server's needs. *** ## ๐Ÿ“ File Structure ``` MS_MadonnAdmin/ โ””โ”€โ”€ config/ โ”œโ”€โ”€ cfg_main.lua โ† Main configuration โ””โ”€โ”€ module/ โ”œโ”€โ”€ cfg_anticheat.lua โ”œโ”€โ”€ cfg_blips.lua โ”œโ”€โ”€ cfg_brigitteai.lua โ”œโ”€โ”€ cfg_button.lua โ”œโ”€โ”€ cfg_commands.lua โ”œโ”€โ”€ cfg_logs.lua โ”œโ”€โ”€ cfg_reports.lua โ”œโ”€โ”€ cfg_sanctions.lua โ””โ”€โ”€ cfg_screenshots.lua ``` *** ## ๐Ÿ“„ Configuration Files ### โš™๏ธ [Main Configuration File](/paid-scripts/madonnadmin/configuration/script-configuration/main-configuration-file) The core of the resource. Contains the **Server Token**, notification system, active modules, staff chat settings, ban duration codes, timezone, and the restart announcement system. **Start here** โ€” most of the initial setup is done in this file. *** ### ๐Ÿ›ก๏ธ [Anticheat Configuration](/paid-scripts/madonnadmin/configuration/script-configuration/anticheat-configuration) Configures the built-in anti-cheat module *(Silver & Gold only)*. Each detection system is independent and can be individually enabled, tuned, and assigned its own ban duration. Covers: Anti Props, Anti Explosions, Anti Vehicle Spam, Anti Trigger Event, Anti Noclip, Anti Invisible, Anti Freecam, Anti Sound, Anti Clear Tasks. *** ### ๐Ÿ—บ๏ธ [Blips Configuration](/paid-scripts/madonnadmin/configuration/script-configuration/blips-configuration) Controls everything related to player visibility on the map and nametags above players for active staff members. Includes player blip sprites, trust level color coding, active staff and submarine mode display, dead player blips, and high density zone detection. *** ### ๐Ÿ”ง [Buttons Configuration](/paid-scripts/madonnadmin/configuration/script-configuration/buttons-configuration) Defines the **custom quick action buttons** shown on player profiles and in the report panel. Each button runs a Lua function on the targeted player's client. Buttons can also register their own in-game commands. *** ### ๐Ÿ’ฌ [Commands Configuration](/paid-scripts/madonnadmin/configuration/script-configuration/commands-configuration) Enable, disable, and rename every staff command: admin chat, note, commend, warn, kick, ban, goto, bring, return, and spectate. Also controls whether commands can be used on higher-ranked staff, and whether multi-ID syntax is supported. *** ### ๐Ÿ“‹ [Logs Configuration](/paid-scripts/madonnadmin/configuration/script-configuration/logs-configuration) Controls which activity types are tracked (connections, chat, shots, injuries, deaths, explosions) and where they are sent via **Discord webhooks**. Supports per-type webhook URLs, Discord thread routing, and custom log entries from external resources. *** ### ๐Ÿšจ [Reports Configuration](/paid-scripts/madonnadmin/configuration/script-configuration/reports-configuration) Configures the in-game player report system: the command name, up to 10 quick report presets, automatic screenshot on submission, and notification triggers for players and staff. *** ### โš–๏ธ [Sanctions Configuration](/paid-scripts/madonnadmin/configuration/script-configuration/sanctions-configuration) Configures how sanctions are presented to players โ€” full-screen splash messages for warns and commends, and whether the ban author's name is shown on the ban screen. *** ## ๐Ÿช Custom Files In addition to the standard config files, Madonn'Admin provides dedicated files for custom logic that won't be overwritten on updates: | File | Description | | -------------------------------- | -------------------------------------------- | | `client/custom/cl_functions.lua` | Custom notification handler (`CustomNotify`) | | `client/custom/cl_logs.lua` | Custom client-side log logic | | `client/custom/cl_events.lua` | Custom client-side event handlers | | `server/custom/sv_logs.lua` | Custom server-side log logic | *** ## โš ๏ธ Important Notes * **Never share your `Server_Token`** publicly. It is the unique key that links your server to your Madonn'Admin account. * Changes to config files require a **resource restart** to take effect: `restart MS_MadonnAdmin` * The anti-cheat module (`cfg_anticheat.lua`) will only run on **Silver and Gold** subscriptions regardless of the `ModuleAnticheat` setting on Bronze. * The screenshot system (`cfg_screenshots.lua`) requires `screenshot-basic` to be installed and started before `MS_MadonnAdmin`. # Main Configuration File The main configuration file is located at `config/cfg_main.lua`. It controls the core behavior of Madonn'Admin, including the server token, notification system, active modules, and general settings. *** ## ๐Ÿ”‘ Authentication ```lua Server_Token = "", ``` | Option | Type | Description | | -------------- | -------- | ---------------------------------------------------------------------------------------------- | | `Server_Token` | `string` | Your unique server token, found in your community settings on `madonnadmin.com`. **Required.** | *** ## ๐Ÿ› Debug & Display | Option | Type | Description | | --------------------- | --------- | ------------------------------------------------------------ | | `Debug` | `boolean` | Enable or disable debug messages in the server console | | `Discord_Invite_Link` | `string` | Your Discord invite link, shown to players in the ban screen | *** ## ๐Ÿ• Date & Time | Option | Type | Description | | --------------- | -------- | --------------------------------------------------------------------------- | | `DateFormatSQL` | `string` | Date format used for log timestamps. Default: `"%d/%m/%Y %T"` | | `Timezone` | `string` | Timezone offset for logs (e.g. `"+1"` = UTC+1, `"0"` = UTC, `"-5"` = UTC-5) | *** ## ๐Ÿ”Œ Connection Handling | Option | Type | Description | | -------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------- | | `Failure_Override` | `boolean` | If `true`, players can still connect even when Madonn'Admin is temporarily unreachable. If `false`, they are blocked. | | `AprilFoolBan` | `boolean` | Enables the April Fool's fake ban joke on April 1st | | `CantConnectText` | `string` | Message shown to players when Madonn'Admin is down and `Failure_Override` is `false` | | `CantConnectToMadonnAdmin` | `string` | Message shown briefly when the platform is unreachable but `Failure_Override` is `true` | | `CheckingProfile` | `string` | Message shown in the loading screen while a player's profile is being verified | *** ## ๐ŸŽฎ In-Game Interface | Option | Type | Description | | ------------------------------ | -------- | ------------------------------------------------------------------------------- | | `OpenAdminMenu` | `string` | Key binding to open the admin menu. Default: `"F10"` | | `StaffActiveNoticeSize` | `string` | Font size of the active staff notice displayed on screen. Default: `"20px"` | | `MinPlayersForHighDensityArea` | `number` | Minimum number of players in a zone for it to be flagged as a high density zone | *** ## ๐Ÿ”” Notification System | Option | Values | Description | | ------------------------------ | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `NotificationSystem` | `"default"` \| `"chat"` \| `"okokNotify"` \| `"MadonneNotify"` \| `"custom"` | Controls how notifications are displayed to staff members | | `NotificationChatColorMessage` | `{r, g, b}` | Text color for chat-based notifications. Only used when `NotificationSystem = "chat"` | | `NotifyAllPlayersForSanctions` | `boolean` | If `true`, all players receive a server-wide chat message when a sanction is applied | > ๐Ÿ’ก If using `"custom"`, implement your notification handler in `client/custom/cl_functions.lua` inside the `CustomNotify(text)` function. *** ## ๐Ÿ’ฌ Staff Chat & Broadcasts | Option | Type | Description | | --------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------- | | `StaffMessagePrefix` | `string` | Prefix shown in chat for staff messages. Default: `"STAFF CHAT"` | | `ShowStaffMessageAsSplashMessage` | `boolean` | If `true`, private staff messages sent to a player appear as a full-screen GTA V splash message | | `ShowAuthorName` | `boolean` | If `true`, the author's name is shown in the splash message when a staff sends a message to a player | | `StaffMessageColor` | `{r, g, b}` | Text color of staff chat messages | | `BroadcastMessageColor` | `{r, g, b}` | Text color of broadcast messages | *** ## ๐Ÿงฉ Modules | Option | Type | Description | | ------------------- | --------- | ------------------------------------------------------------------------ | | `ModuleAnticheat` | `boolean` | Enable the anti-cheat module. **Requires Silver or Gold subscription.** | | `ModuleLogs` | `boolean` | Enable the activity log module (shots, deaths, chat, connectionsโ€ฆ) | | `ModuleScreenshots` | `boolean` | Enable the automatic screenshot system. **Requires `screenshot-basic`.** | *** ## โฑ๏ธ Ban Durations The `BanDurations` table defines the letter codes used when applying bans via command or the in-game panel: ```lua BanDurations = { Community = "c", -- Community-wide ban Permanent = "p", -- Permanent ban Year = "y", Month = "mo", Week = "w", Day = "d", Hour = "h", Minute = "m", } ``` **Examples of valid durations:** * `"30m"` โ†’ 30 minutes * `"2h"` โ†’ 2 hours * `"7d"` โ†’ 7 days * `"2w"` โ†’ 2 weeks * `"1mo"` โ†’ 1 month * `"p"` โ†’ permanent * `"c"` โ†’ community ban *** ## ๐Ÿ”„ Restart Announcement Automatically send countdown messages in chat before scheduled server restarts: ```lua RestartAnnouncement = { Enabled = true, Hours = { "22:00", "04:00", "10:00", "16:00", }, XMinutesBefore = { 30, 10, 5, 2, 1 } } ``` | Option | Type | Description | | ---------------- | --------- | -------------------------------------------------------------- | | `Enabled` | `boolean` | Enable or disable the restart announcement system | | `Hours` | `table` | List of scheduled restart times in `"HH:MM"` format | | `XMinutesBefore` | `table` | List of how many minutes before each restart to send a warning | # Anticheat Configuration The anti-cheat configuration is located at `config/module/cfg_anticheat.lua`. > โš ๏ธ **This module requires a Silver or Gold subscription.** It will not run on Bronze plans regardless of configuration. Each detection module can be independently enabled or disabled, and each has its own configurable ban length and sensitivity settings. *** ## ๐Ÿšซ Anti Props Blocks unauthorized prop spawning. If a player spawns any object from the blacklist, they are **immediately and automatically banned**. ```lua AntiProps = { Enabled = true, BanLength = "p", BlacklistedProps = { [GetHashKey("stt_prop_stunt_jump45")] = true, -- ... } } ``` | Option | Type | Description | | ------------------ | --------- | ------------------------------------------------------------------------------------- | | `Enabled` | `boolean` | Enable or disable this detection | | `BanLength` | `string` | Ban duration applied on detection (uses `BanDurations` codes, e.g. `"p"` = permanent) | | `BlacklistedProps` | `table` | List of prop model hashes to block. Use `GetHashKey("model_name")` to add entries | > ๐Ÿ’ก The default blacklist includes all stunt ramps, tubes, jumps, and various LOD map objects commonly used for griefing. *** ## ๐Ÿ’ฅ Anti Explosions Detects players generating an abnormal number of explosions in a short period. ```lua AntiExplosions = { Enabled = true, BanLength = "p", MaxPlaytime = 300, WhitelistedExplosions = { ['BIRD_CRAP'] = true, ['FIREWORK'] = true, ['SNOWBALL'] = true, } } ``` | Option | Type | Description | | ----------------------- | --------- | ---------------------------------------------------------------------------------------------------------------- | | `Enabled` | `boolean` | Enable or disable this detection | | `BanLength` | `string` | Ban duration on detection | | `MaxPlaytime` | `number` | Players with more playtime than this value (in minutes) are **exempt** from this check. Default: `300` (5 hours) | | `WhitelistedExplosions` | `table` | Explosion types that are ignored by the counter | *** ## ๐Ÿš— Anti Vehicle Spam Detects players spawning vehicles at an abnormally high rate. ```lua AntiVehiclesSpam = { Enabled = true, BanLength = "p", MaxPlaytime = 300, } ``` | Option | Type | Description | | ------------- | --------- | --------------------------------------- | | `Enabled` | `boolean` | Enable or disable this detection | | `BanLength` | `string` | Ban duration on detection | | `MaxPlaytime` | `number` | Playtime exemption threshold in minutes | *** ## ๐Ÿ“ก Anti Trigger Event Protects your server events from being triggered by unauthorized client-side resources or exploits. Any event triggered from a resource that is not started on the server will automatically ban the player. ```lua AntiTriggerEvent = { Enabled = true, BanLength = "p", ProtectedClientEvents = {}, ProtectedServerEvents = {}, } ``` | Option | Type | Description | | ----------------------- | --------- | ---------------------------------------- | | `Enabled` | `boolean` | Enable or disable this detection | | `BanLength` | `string` | Ban duration on detection | | `ProtectedClientEvents` | `table` | Additional client-side events to monitor | | `ProtectedServerEvents` | `table` | Additional server-side events to monitor | *** ## โœˆ๏ธ Anti Noclip Detects players moving through the air at suspicious speeds and heights without a valid animation or parachute, indicating the use of a noclip exploit. ```lua AntiNoClip = { Enabled = true, BanLength = "p", MaxPlaytime = 300, DistanceTrigger = 20.0, MinHeight = 5.0, WhitelistedAnimation = { {dict = "nm", anim = "firemans_carry"} } } ``` | Option | Type | Description | | ---------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `Enabled` | `boolean` | Enable or disable this detection | | `BanLength` | `string` | Ban duration on detection | | `MaxPlaytime` | `number` | Playtime exemption threshold in minutes | | `DistanceTrigger` | `number` | Horizontal distance traveled in 2 seconds to trigger detection | | `MinHeight` | `number` | Minimum height above ground required to trigger detection | | `WhitelistedAnimation` | `table` | List of animations that exempt a player from detection (add `{dict, anim}` entries for animations that put the player in the air legitimately) | *** ## ๐Ÿ‘ป Anti Invisible Detects players who become invisible without a whitelisted animation active. ```lua AntiInvisible = { Enabled = true, BanLength = "p", MaxPlaytime = 300, WhitelistedAnimation = { {dict = "nm", anim = "firemans_carry"} } } ``` | Option | Type | Description | | ---------------------- | --------- | ---------------------------------------------------- | | `Enabled` | `boolean` | Enable or disable this detection | | `BanLength` | `string` | Ban duration on detection | | `MaxPlaytime` | `number` | Playtime exemption threshold in minutes | | `WhitelistedAnimation` | `table` | Animations that legitimately make a player invisible | *** ## ๐Ÿ“ท Anti Freecam Detects players whose camera moves far away from their character position, indicating a freecam exploit. ```lua AntiFreecam = { Enabled = true, BanLength = "p", MaxPlaytime = 300, DistanceTrigger = 50, MaxHeight = 45.0 } ``` | Option | Type | Description | | ----------------- | --------- | --------------------------------------------------------------- | | `Enabled` | `boolean` | Enable or disable this detection | | `BanLength` | `string` | Ban duration on detection | | `MaxPlaytime` | `number` | Playtime exemption threshold in minutes | | `DistanceTrigger` | `number` | Distance between the player and the camera to trigger detection | | `MaxHeight` | `number` | Maximum camera height before triggering detection | *** ## ๐Ÿ”Š Anti Sound Detects players broadcasting blacklisted sounds at suspicious distances via InteractSound, which is a common exploit vector. ```lua AntiSound = { Enabled = true, BanLength = "p", MaxPlaytime = 300, BlacklistedSounds = { {name = "handcuff", maxDistance = 10000}, {name = "alarm", maxDistance = 5}, -- ... } } ``` | Option | Type | Description | | ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------- | | `Enabled` | `boolean` | Enable or disable this detection | | `BanLength` | `string` | Ban duration on detection | | `MaxPlaytime` | `number` | Playtime exemption threshold in minutes | | `BlacklistedSounds` | `table` | List of `{name, maxDistance}` entries. If the exact sound name and distance combination is detected, the player is banned | *** ## ๐Ÿงน Anti Clear Tasks Detects players sending an abnormally high number of `clearPedTask` events in a short window, which is a common method used by menus to force ragdoll other players. ```lua AntiClearTasks = { Enabled = true, BanLength = "p", MaxPlaytime = 300, MaxTasks = 20 } ``` | Option | Type | Description | | ------------- | --------- | ------------------------------------------------------------------------------------ | | `Enabled` | `boolean` | Enable or disable this detection | | `BanLength` | `string` | Ban duration on detection | | `MaxPlaytime` | `number` | Playtime exemption threshold in minutes | | `MaxTasks` | `number` | Maximum number of `clearPedTask` events allowed in a 10-second window before banning | *** ## ๐Ÿ’ก Notes on Playtime Exemption Every anti-cheat module has a `MaxPlaytime` option (in minutes). Players whose total playtime on your server exceeds this value are **exempt from that specific detection**. This is the trusted player system โ€” long-time regulars are less likely to be false-positived by movement or camera detections. The default value of `300` minutes (5 hours) is a reasonable starting point. Adjust it based on your server's population and tolerance for false positives. # Blips Configuration The blips configuration is located at `config/module/cfg_blips.lua`. It controls everything related to player visibility on the map and nametags above players โ€” both for active staff members and for regular players. *** ## ๐Ÿ‘๏ธ General | Option | Type | Description | | -------------------------------- | --------- | --------------------------------------------------------------------------------------- | | `ShowPlayerBlipsForActiveStaffs` | `boolean` | If `true`, active staff members see a map blip for every player visible to them | | `DistanceToShowBlipsAndNames` | `number` | Maximum distance (in units) at which blips and nametags are displayed. Default: `100.0` | *** ## ๐Ÿš— Blip Sprites per Vehicle Class When a player is in a vehicle, their blip sprite changes based on the vehicle class. You can customize each sprite ID: ```lua BlipSpritesForVehicleClasses = { ['0'] = 225, -- Compacts ['1'] = 225, -- Sedans ['8'] = 226, -- Motorcycles ['14'] = 427, -- Boats ['15'] = 43, -- Helicopters ['16'] = 307, -- Planes -- ... } BlipSpritePlayerOnFoot = 1 ``` > ๐Ÿ“– A full list of blip sprite IDs is available at [docs.fivem.net](https://docs.fivem.net/docs/game-references/blips/). *** ## ๐Ÿ”ต Submarine Mode (Undercover Staff) The Submarine mode allows staff members to be hidden from other staff while appearing as regular players. When a staff member activates Submarine mode, their nametag displays differently. ```lua SubMarine = { Abbreviation = "SB", -- Prefix shown in the nametag for staff in same or lower rank Color = 150, -- Nametag color for same/lower rank staff ShowActuallyTalking = true, -- Show voice indicator ShowHealth = true, -- Show health bar in nametag AbbreviationHigherRanks = "SB", -- Prefix shown to higher-ranked staff ColorHigherRanks = 150, -- Nametag color shown to higher-ranked staff ShowActuallyTalkingHigherRanks = true, ShowHealthHigherRanks = false, } ``` *** ## ๐ŸŸข Active Staff Display Controls how active (non-submarine) staff members are displayed to other staff and to regular players. ```lua ActiveStaff = { Color = 176, -- Nametag color for active staff (seen by other staff) ShowActuallyTalking = true, ShowHealth = true, ShowNameForPlayers = true, -- Show "ACTIVE STAFF - Name" nametag to regular players ShowActuallyTalkingForPlayers = true, ShowHealthForPlayers = false, ColorForPlayers = 1 -- Nametag color shown to regular players } ``` *** ## ๐Ÿ‘ค Player Nametags Controls how regular players are displayed to active staff members. ```lua PlayerBlips = { ShowActuallyTalking = true, ShowActuallyDriving = true, -- Show a driver prefix in the nametag when the player is driving DriverPrefix = "C", -- Prefix shown when the player is the driver of a vehicle ShowHealth = true, TrustLevelInNames = { Enabled = true, Default = 1, -- Color for neutral players Trusted = 18, -- Color for trusted players (flag_trusted, flag_trusted_plus) Untrusted = 6, -- Color for untrusted players (flag_untrusted, flag_caution, flag_cheater) }, } ``` > ๐Ÿ’ก Players flagged as `flag_caution` or `flag_cheater` will also have `!!` prepended to their nametag to warn active staff at a glance. *** ## ๐Ÿ’€ Dead Player Blips When a player dies, a blip is automatically placed on the map for active staff members. ```lua DeadPlayersBlips = { Enabled = true, BlipSprite = 310, BlipCategory = 10, DisplayOnMinimapOnlyAtShortRange = true, DelayBeforeRemovingBlip = 5, -- Minutes before the blip is automatically removed } ``` *** ## ๐Ÿ˜๏ธ High Density Zones Automatically detects and highlights areas on the map where a high concentration of players is gathered, helping staff prioritize their attention. ```lua HighDensityZones = { Enabled = true, Radius = 150.0, BlipSprite = 9, BlipAlpha = 100, BlipRotation = 50, DisplayOnMinimapOnlyAtShortRange = true, HighDensity = { Density = 30, -- % of total online players in zone to trigger this level Color = 59, }, MediumDensity = { Density = 20, Color = 47, }, LowDensity = { Density = 10, Color = 60, } } ``` | Option | Type | Description | | --------------------- | --------- | ------------------------------------------------------------- | | `Enabled` | `boolean` | Enable or disable high density zone detection | | `Radius` | `number` | Radius (in units) of each density zone blip | | `BlipSprite` | `number` | Blip sprite ID used for density zones | | `BlipAlpha` | `number` | Transparency of the blip (`0`โ€“`255`) | | `HighDensity.Density` | `number` | Minimum % of online players in the zone to trigger this level | | `HighDensity.Color` | `number` | Blip color for this density level | > ๐Ÿ’ก A zone is only shown if it also meets the `MinPlayersForHighDensityArea` threshold set in `cfg_main.lua`. # Buttons Configuration The buttons configuration is located at `config/module/cfg_button.lua`. It defines the **custom quick action buttons** that appear on each player's profile in the admin panel and in the report panel sidebar. Each button runs a Lua function directly on the **targeted player's client**, allowing you to perform any in-game action on them with a single click. *** ## ๐Ÿ“ Button Structure ```lua BUTTONS = { [1] = { Title = "Heal", HaveAccess = true, EnableCommandForThisButton = true, CommandCanBeUsedOnlyInActiveStaff = true, CommandCanBeUsedOnHigherRank = false, MultiIdsCommand = true, CommandName = "heal", CommandSuggestionText = "Heal a player", AddInReportMenu = true, Actions = function() SetEntityHealth(PlayerPed, 200) end }, } ``` | Option | Type | Description | | ----------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------- | | `Title` | `string` | Label displayed on the button in the admin panel | | `HaveAccess` | `boolean` \| `table` | `true` = all staff can use this button. Pass a table of rank IDs (e.g. `{1,2,3}`) to restrict access to specific ranks only | | `EnableCommandForThisButton` | `boolean` | If `true`, a chat command is registered for this button so staff can also use it via `/CommandName [ID]` | | `CommandCanBeUsedOnlyInActiveStaff` | `boolean` | If `true`, the chat command can only be used while in active staff mode | | `CommandCanBeUsedOnHigherRank` | `boolean` | If `true`, the command can target players with a higher rank than the staff member | | `MultiIdsCommand` | `boolean` | If `true`, the command accepts multiple player IDs at once (e.g. `/heal 12 34 56`) | | `CommandName` | `string` | The command name (without `/`) | | `CommandSuggestionText` | `string` | Description shown in the chat suggestion | | `AddInReportMenu` | `boolean` | If `true`, this button also appears in the report panel sidebar when a staff member handles a report | | `Actions` | `function` | Lua function executed **on the targeted player's client**. `PlayerPed` refers to the target's ped. | *** ## ๐Ÿงฉ Default Buttons Four buttons are included by default: | # | Title | Access | Command | Description | | - | --------------- | --------- | ------------- | -------------------------------------------------------------- | | 1 | **Heal** | All staff | `/heal` | Fully restores the player's health | | 2 | **Kill** | Ranks 1โ€“5 | `/killplayer` | Kills the player | | 3 | **(Un)Freeze** | Ranks 1โ€“5 | `/freeze` | Toggles the player's freeze state | | 4 | **Fix Vehicle** | All staff | `/fixvcl` | Repairs the player's current vehicle (engine, body, fuel tank) | *** ## โž• Adding Custom Buttons To add a new button, duplicate an existing entry and increment the key number: ```lua BUTTONS = { -- ...existing buttons... [5] = { Title = "Revive", HaveAccess = true, EnableCommandForThisButton = true, CommandCanBeUsedOnlyInActiveStaff = true, CommandCanBeUsedOnHigherRank = false, MultiIdsCommand = true, CommandName = "revive", CommandSuggestionText = "Revive a player", AddInReportMenu = true, Actions = function() SetEntityHealth(PlayerPed, 200) NetworkResurrectLocalPlayer( GetEntityCoords(PlayerPed), 0, true, false ) end }, } ``` > ๐Ÿ’ก The `Actions` function is executed **on the targeted player's machine**, so `PlayerPed` always refers to their own character. You have access to all FiveM client-side natives. # Commands Configuration The commands configuration is located at `config/module/cfg_commands.lua`. It allows you to enable, disable, and rename every in-game command available to staff members. *** ## ๐Ÿ”ค Command Suggestions ```lua CommandSuggestions = true, ``` If `true`, all enabled commands will display auto-complete suggestions in the FiveM chat box when a staff member starts typing the command. *** ## ๐Ÿ“‹ Available Commands ### Admin Chat ```lua AdminChatCommand = { Enabled = true, Command = "admin", ChatColor = {r = 255, g = 255, b = 255}, } ``` Send a private message visible only to online staff members. | Option | Description | | ----------- | ------------------------------------------------ | | `Enabled` | Enable or disable the command | | `Command` | Command name without `/`. Default: `"admin"` | | `ChatColor` | RGB color of admin chat messages in the chat box | *** ### Note ```lua NoteCommand = { Enabled = true, Command = "note", } ``` Add a private internal note to a player's profile. Notes are visible only to staff on the web dashboard and in the admin panel. Usage: `/note [ID] [reason]` *** ### Commend ```lua CommendCommand = { Enabled = true, Command = "commend", } ``` Add a positive commendation to a player's sanction history. Usage: `/commend [ID] [reason]` *** ### Warn ```lua WarnCommand = { Enabled = true, Command = "warn", } ``` Issue a formal warning to a player. The warning is saved to their permanent profile and displayed as a splash message. Usage: `/warn [ID] [reason]` *** ### Kick ```lua KickCommand = { Enabled = true, Command = "kick", } ``` Remove a player from the server immediately. Usage: `/kick [ID] [reason]` *** ### Ban ```lua BanCommand = { Enabled = true, Command = "ban", } ``` Ban a player for a specified duration or permanently. Usage: `/ban [ID] [duration] [reason]` **Duration examples:** `30m`, `2h`, `7d`, `2w`, `1mo`, `p` (permanent), `c` (community ban) *** ### Go To ```lua GoToCommand = { Enabled = true, CanBeUsedOnHigherRank = false, Command = "goto", } ``` Teleport to a player's position. Usage: `/goto [ID]` | Option | Description | | ----------------------- | ------------------------------------------------------------------------------- | | `CanBeUsedOnHigherRank` | If `false`, staff cannot teleport to players with a higher rank than themselves | *** ### Bring ```lua BringCommand = { Enabled = true, CanBeUsedOnHigherRank = false, Command = "bring", MultiIds = true, } ``` Teleport one or several players to your position. Usage: `/bring [ID]` or `/bring [ID1] [ID2] [ID3]` if `MultiIds` is `true` *** ### Return ```lua ReturnCommand = { Enabled = true, CanBeUsedOnHigherRank = false, Command = "return", MultiIds = true, } ``` Send a player back to their position before the last teleportation. Usage: `/return [ID]` *** ### Spectate ```lua SpectateCommand = { Enabled = true, CanBeUsedOnHigherRank = false, Command = "spectate", MultiIds = false, } ``` Discretely spectate a player from their perspective. Usage: `/spectate [ID]` Press `F` in-game to exit spectate mode. *** > ๐Ÿ’ก Custom action buttons defined in `cfg_button.lua` with `EnableCommandForThisButton = true` also register their own commands automatically and will appear as suggestions if `CommandSuggestions` is `true`. # Logs Configuration The logs configuration is located at `config/module/cfg_logs.lua`. It controls which activity types are logged, where they are sent (Discord webhooks), and various display options. *** ## โœ… Enabled Log Types ```lua LogsEnabled = { Disconnections = true, Chat = true, Explosions = true, Shots = true, Injuries = true, Death = true, Other = true, } ``` Each entry can be independently enabled or disabled. Setting a type to `false` completely disables its logging โ€” no data is stored and no webhook is sent. | Type | Description | | ---------------- | ------------------------------------------------------------------------- | | `Disconnections` | Player connections and disconnections | | `Chat` | All chat messages sent on the server | | `Explosions` | Explosions caused by players | | `Shots` | Weapon shots fired by players, grouped per session | | `Injuries` | Damage dealt to players | | `Death` | Player deaths, including the cause and the killer if applicable | | `Other` | Custom logs triggered via `TriggerEvent('MadonnAdmin:SimpleLog', 8, ...)` | *** ## ๐Ÿ“จ Discord Webhooks Each log type has its own Discord webhook. Set a valid webhook URL to enable Discord delivery for that type, or set it to `false` to disable it: ```lua DiscordWebhook = { Disconnections = "https://discord.com/api/webhooks/...", Chat = "https://discord.com/api/webhooks/...", Shots = "https://discord.com/api/webhooks/...", Injuries = "https://discord.com/api/webhooks/...", Death = "https://discord.com/api/webhooks/...", Explosions = "https://discord.com/api/webhooks/...", Connections = "https://discord.com/api/webhooks/...", ChangeName = "https://discord.com/api/webhooks/...", } ``` > ๐Ÿ’ก You can use **Discord forum threads** by appending `?thread_id=YOUR_THREAD_ID` to the webhook URL. This allows you to send each log type to a dedicated thread inside a single forum channel. *** ## ๐Ÿ”ซ Ignored Weapons Weapons in this list are excluded from the shots log entirely: ```lua IgnoredWeapons = { [GetHashKey("WEAPON_FIREEXTINGUISHER")] = true, [GetHashKey("WEAPON_PETROLCAN")] = true, } ``` Add any weapon model hash you want to exclude from shot tracking. Useful for tools that are technically "weapons" but are not relevant for moderation. *** ## ๐Ÿ–ฅ๏ธ In-Game Log Display ```lua MaxLogsShowedInGame = 100, ``` Maximum number of log entries displayed in the **Logs** tab of the in-game admin panel. Increasing this value may impact performance when opening the logs page with a large history. *** ## ๐Ÿท๏ธ Discord Embed Options ```lua AddDiscordIdToDiscordLogs = true, ``` If `true`, the Discord ID of each player involved in a log entry is included in the webhook embed. This allows Discord moderators to directly ping or identify players from the logs. *** ## ๐Ÿ”ง Custom Logs You can push custom log entries to both the in-game panel and Discord from any resource using the `MadonnAdmin:SimpleLog` event: ```lua -- From server-side: TriggerEvent( 'MadonnAdmin:SimpleLog', 8, -- type 8 = custom / "Other" playerServerId, -- playerA "Used forbidden item",-- detail nil, -- playerB (optional) "Custom Action", -- action label 0x662d91, -- embed color true, -- take screenshot "https://discord.com/api/webhooks/your-webhook" ) ``` To add persistent custom log threads, edit `server/custom/sv_logs.lua`: ```lua if LOGS.LogsEnabled.Other then CreateThread(function() -- Your custom server-side log logic here end) end ``` # Reports Configuration The reports configuration is located at `config/module/cfg_reports.lua`. It controls the player report system โ€” the command players use, the pre-configured quick report types, and how notifications are handled. *** ## โš™๏ธ General Settings ```lua REPORTS_CONFIG = { ReportsEnabled = true, CreateReportCommand = "report", TakeScreenshotWhenReportIsCreated = true, } ``` | Option | Type | Description | | ----------------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `ReportsEnabled` | `boolean` | Enable or disable the entire report system | | `CreateReportCommand` | `string` | The command players use to open the report interface. Default: `"report"` โ†’ `/report` | | `TakeScreenshotWhenReportIsCreated` | `boolean` | If `true`, a screenshot is automatically captured and attached to the report when it is submitted. **Requires `screenshot-basic`.** | *** ## โšก Quick Reports Quick reports are pre-configured one-click report buttons shown to players when they open the report interface. Players can choose one without typing anything. ```lua QuickReports = { "Bug", "Question", "Freekill", "NoFear", "NoPain", "Insults", "Cheater", "Spectate me", "New player" }, ``` * You can define **up to 10** quick report types * Each entry is a string that becomes the report title * Players can also submit a fully custom report with their own title and description > ๐Ÿ’ก Quick reports and custom reports are both available simultaneously. Players choose between them when they open the report menu. *** ## ๐Ÿ”” Notifications Controls which events trigger a notification in-game: ```lua Notifications = { OwnReportCreated = false, NewScreenshot = false, NewMessage = true, NewReport = true, } ``` | Option | Type | Description | | ------------------ | --------- | --------------------------------------------------------------------- | | `OwnReportCreated` | `boolean` | Notify the player when their own report is successfully created | | `NewScreenshot` | `boolean` | Notify the player when a new screenshot is attached to their report | | `NewMessage` | `boolean` | Notify the player when a staff member sends a message in their report | | `NewReport` | `boolean` | Notify all active staff members when a new report is submitted | *** ## ๐Ÿ–ผ๏ธ Screenshot Configuration The screenshots taken on report submission are stored via Discord webhook, configured in `config/module/cfg_screenshots.lua`: ```lua SCREENSHOTS = { ScreenshotBasicName = "screenshot-basic", DiscordWebhookToSaveScreenshots = "https://discord.com/api/webhooks/...", } ``` | Option | Type | Description | | --------------------------------- | -------- | --------------------------------------------------------------------------------------- | | `ScreenshotBasicName` | `string` | Name of the `screenshot-basic` resource. Do not change unless you renamed the resource. | | `DiscordWebhookToSaveScreenshots` | `string` | Discord webhook URL where report screenshots are uploaded and stored | > โš ๏ธ Without a valid webhook, screenshots will fail to save even if `screenshot-basic` is running. *** ## ๐Ÿ“Š Report Statistics All reports are saved to the Madonn'Admin platform and can be reviewed on the **web dashboard** under the **Reports** section. For a full breakdown of available statistics, refer to the ๐Ÿ“Š Report Statistics page. # Sanctions Configuration The sanctions configuration is located at `config/module/cfg_sanctions.lua`. It controls how sanctions are presented to players when they are applied. *** ## ๐Ÿ’ฌ Splash Message ```lua UseSplashMessage = true, ``` If `true`, when a player receives a **warn** or a **commend**, a full-screen GTA V splash message appears on their screen with the sanction type and reason. * A **warn** displays a blue splash message * A **commend** displays a green splash message * A **staff message** (sent via the report or admin chat) displays a purple splash message, optionally with the author's name
> ๐Ÿ’ก The `ShowStaffMessageAsSplashMessage` and `ShowAuthorName` options in `cfg_main.lua` also affect how staff messages are displayed in this system. *** ## ๐Ÿ‘ค Show Ban Author ```lua ShowBanAuthor = false, ``` If `true`, the name of the staff member who applied the ban is displayed in the ban screen shown to the banned player at connection. If `false`, the ban screen only shows the reason, duration, and expiry date โ€” the author remains anonymous. *** ## ๐Ÿ“‹ Available Sanction Types The following sanction types can be applied from the in-game admin panel, via chat commands, or from the web dashboard: | Type | Command | Description | | -------------------- | ------------------------------- | ------------------------------------------------------------------------- | | ๐Ÿ“ **Note** | `/note` | Internal note visible only to staff. Not shown to the player. | | โญ **Commend** | `/commend` | Positive commendation added to the player's profile with a splash message | | โš ๏ธ **Warn** | `/warn` | Formal warning added to the player's profile with a splash message | | ๐Ÿ‘Ÿ **Kick** | `/kick` | Removes the player from the server immediately | | ๐Ÿ”จ **Temporary Ban** | `/ban [ID] [duration] [reason]` | Bans the player for a defined duration | | ๐Ÿ”’ **Permanent Ban** | `/ban [ID] p [reason]` | Bans the player permanently | | ๐ŸŒ **Community Ban** | `/ban [ID] c [reason]` | Bans the player across all servers of the community | *** ## โฑ๏ธ Ban Duration Format Durations are entered as a number followed by a letter code, as defined in `BanDurations` in `cfg_main.lua`: | Code | Duration | | ---- | ------------- | | `m` | Minutes | | `h` | Hours | | `d` | Days | | `w` | Weeks | | `mo` | Months | | `y` | Years | | `p` | Permanent | | `c` | Community ban | **Examples:** `30m`, `2h`, `7d`, `2w`, `1mo`, `1y`, `p`, `c` # How to use it ? Madonn'Admin is divided into three main interfaces, each serving a specific purpose in your day-to-day server management.
*** ## ๐Ÿ–ฅ๏ธ In-Game Dashboard The in-game administration panel, accessible by pressing `F10` (default), is the primary tool for staff members actively moderating the server. When activated, your character automatically enters god mode (invisible) and an indicator appears above your head showing your nickname as `[ACTIVE STAFF] Your nickname`. The in-game dashboard gives you access to: * A **home interface** with connected staff, recent announcements, and player flag graphs * A **player list** with full profiles, sanction history, and direct action buttons * **Server logs** with filterable categories * A **report management panel** to handle player reports in real time * A **settings panel** to delete props, vehicles, and toggle god mode or underwater mode *** ## ๐ŸŒ Web Dashboard The web platform is the central hub for server administrators. It provides a complete overview of server activity, player management, staff performance tracking, and advanced moderation tools โ€” all accessible from any browser without being in-game. *** ## ๐Ÿ’ฌ Discord Bot The Discord integration extends Madonn'Admin's capabilities directly into your community Discord. Staff members can look up player profiles, apply sanctions, and monitor server status without ever opening the game. # Web Dashboard Madonn'Admin Web is a web platform designed to give FiveM server administrators complete visibility and control over server activity. It centralizes logs, player management, staff performance tracking, sanction management, and more โ€” all accessible from any browser. *** ### Interface Overview #### Left panel The left panel contains your **community name** (clicking it returns you to the main dashboard) and the **main navigation menu** with access to all sections: Dashboard, Servers, Players, Staff, Appeals, and Logs. At the bottom left you will find the Madonn'Admin logo, the current platform version, and a link to the MadonneStudio website. #### Top bar The top bar includes: * A **player search bar** โ€” search by nickname, Discord ID, Steam ID, or Xbox ID
* A **light/dark mode toggle** * A **notification bell** โ€” centralizes alerts and announcements (admin rank and above) * Your **profile icon** โ€” opens a dropdown with Settings (Community Token, password change) and Logout
*** ### Pages * [๐Ÿ“Š Main Page](/paid-scripts/madonnadmin/how-to-use-it/web-dashboard/main-page) * [๐Ÿ–ฅ๏ธ Servers](/paid-scripts/madonnadmin/how-to-use-it/web-dashboard/servers) * [๐Ÿ‘ฅ Players](/paid-scripts/madonnadmin/how-to-use-it/web-dashboard/players) * [๐Ÿ‘ฎ Staffs](/paid-scripts/madonnadmin/how-to-use-it/web-dashboard/staffs) * [โš–๏ธ Appeals](/paid-scripts/madonnadmin/how-to-use-it/web-dashboard/appeals) * [๐Ÿ“‹ Logs](/paid-scripts/madonnadmin/how-to-use-it/web-dashboard/logs) # Main Page The Dashboard is the main landing page of Madonn'Admin Web. It is structured around three axes, each providing a different category of information. *** ## Dashboard An overview of the server's activity over the **last 7 days**: * Number of players currently connected * Number of new players who joined in the last 7 days * Number of staff members currently online * Summary of staff actions in the last 7 days (warns, kicks, bans)
*** ## Online Staff A detailed view of currently active team members: * Total number of staff members online * Server they are connected to * Rank (admin, moderator, etc.) * Status โ€” moderation mode or roleplay mode By default up to 10 staff members are displayed, expandable to 100.
*** ## Additional Information Announcements and supplementary data for the staff team: * Latest internal communications and updates from server managers * **Player flag activity** โ€” a visual indicator of potentially problematic behavior among currently connected players, based on sanction history and frequency
# Servers The Servers section allows you to select and manage a specific server linked to your Madonn'Admin account. Once a server is selected, all data and tools on the page are scoped to that server. *** ## Server Overview At the top of the page, a summary block displays real-time statistics for the selected server: * Total number of players currently connected * Number of staff members online * Staff action counts over the current period (warns, kicks, bans) Data refreshes each time you reload the page.
*** ## Online Players A detailed list of players currently connected to the server, with the following columns: | Column | Description | | --------------------- | ----------------------------------------------------------------------- | | **Player Name** | In-game nickname โ€” click to open the player's full Madonn'Admin profile | | **In-Game ID** | Current server ID | | **Game Time** | Total cumulative playtime on the server | | **First Connection** | Date of the player's first connection | | **Status** | Online or offline | | **Warn / Kick / Ban** | Sanction summary | All columns are sortable. A search bar in the top right corner lets you filter by nickname or in-game ID. Default display: 10 players, expandable to 100.
*** ## Additional Information * **Admin chat** โ€” view and send messages to the in-game admin chat directly from the web. Messages sent here appear in-game in real time.
* **Player flags** โ€” a list of flags for currently connected players, generated from their sanction history and playing time. Empty when no players are connected.
*** ## Broadcast Message Send a global message to all connected players, visible in the in-game chat in the format `Your server name: [Your message]`. Default color: blue (customizable). Pre-configured buttons allow quick broadcast of frequently used messages (report command reminder, rules reminder, Discord link, restart times, etc.). All pre-configured messages are fully customizable.
*** ## Admin-Only Section Accessible to administrator rank and above, this section shows: * **Open Appeals** โ€” a summary of pending ban lift or sanction removal requests, with request ID, type, and current status * **Pending Sanctions** โ€” sanctions proposed by lower-ranked staff awaiting admin approval, with a green button to validate and a red button to reject
# Players The Players section offers two subsections for managing and looking up player profiles. *** ## Search for a Player Search for a specific player's Madonn'Admin profile using: * **Username** โ€” as it appears on the server * **GTA 5 License** * **Discord ID** * **Steam ID** * **Xbox ID / Live ID** By default the search uses the GTA 5 license as the identifier, but this can be changed from the dropdown in the search interface.
*** ## Show All Players A complete list of all players registered or active on the server, with the following columns: | Column | Description | | --------------------- | ------------------------------------------------ | | **Player Name** | Nickname โ€” click to open the full player profile | | **Playing Time** | Total cumulative time spent on the server | | **First Connection** | Date of the player's first connection | | **Last Connection** | Date of the player's most recent connection | | **Status** | Online or offline | | **Warn / Kick / Ban** | Sanction summary | All columns are sortable. A search bar in the top right allows filtering by nickname. Default display: 10 players, expandable to 100.
*** ## Player Profile A player's profile is divided into several sections. **Identifiers** โ€” all accounts linked to the player: Discord, Steam, FiveM license, Xbox ID, and any other associated platforms. **Statistics** โ€” displayed on the right side of the profile: * Current status (online / offline) * First and last connection dates * Total playtime * **Trust score** โ€” calculated from playtime and sanction history. A higher score indicates reliable behavior; a lower score reflects a significant sanction history. * **Flags** โ€” reliability indicators based on behavior and history
**Direct Message** โ€” send a private message directly to the player. The message appears in their in-game chat and is visible only to them.
**Sanction History** โ€” complete list of sanctions applied to the player: notes, recommendations, warns, kicks, and bans. **Appeals** โ€” accessible to administrators and above. Includes a clipboard button to copy a direct link to the player's Madonn'Admin page, which can be sent to the player so they can submit an appeal themselves.
**Logs** โ€” all actions performed by the player on the server, with date/time, action type, and additional context. Default display: 10 logs, expandable to 100.
**Apply a Sanction** โ€” directly from the profile: * **Note** โ€” add a personal annotation to the player's profile * **Recommendation** โ€” adds a positive note that influences the player's trust score * **Kick** โ€” apply an expulsion with a reason * **Warn** โ€” apply a warning with a reason * **Ban** โ€” apply a ban with a configurable duration (from minutes to permanent/community ban) and a reason
# Staffs The Staffs section provides a complete overview of moderation activity and staff performance, divided into two subsections. *** ## Staff Actions A detailed table of all sanctions applied by staff members across the server. Columns include: | Column | Description | | --------------- | -------------------------------------------------------- | | **Date** | Exact date the sanction was applied | | **Server Name** | Server on which the sanction was applied | | **Sanction** | Type of sanction (Note, Recommendation, Warn, Kick, Ban) | | **Player** | Nickname of the sanctioned player | | **Staff** | Nickname of the staff member who applied the sanction | | **Reason** | Reason for the sanction | You can filter the displayed sanctions by type: All, Notes, Recommendations, Warns, Kicks, or Bans.
*** ## Staff Statistics Performance and activity analysis for all staff members, divided into two views. **Last 7 days** โ€” a condensed view of moderation actions carried out over the past week, useful for quick weekly reviews. **Global statistics** โ€” all actions since the beginning of the staff member's activity on the server, providing a long-term view of performance and contribution. Both views use the same columns: | Column | Description | | ------------------- | ------------------------------------------- | | **Staff** | Nickname of the staff member | | **All Sanctions** | Total sanctions applied, all types combined | | **Notes** | Number of notes added | | **Recommendations** | Number of recommendations issued | | **Warn** | Number of warnings given | | **Kick** | Number of expulsions carried out | | **Ban** | Number of bans applied |
*** ## Reports Statistics The web dashboard provides server administrators with a **complete overview of all reports** submitted on the server. This statistics panel is designed to help staff teams monitor their activity, identify trends, and optimize their response efficiency. *** ### Accessing the Dashboard The statistics panel is accessible from the **web administration dashboard**. Navigate to the **Staff Management** section, then open the **Report Statistics** tab. The page is divided into **four main sections**: Global Statistics, Complete Statistics, Last Week Statistics, and a Recent Tickets log. *** ### Global Statistics
The **Global Statistics** table gives a high-level overview per server. Each row represents a server and displays the following columns: | Column | Description | | -------------------- | ------------------------------------------------------------------- | | **Servers** | The name of the server | | **T. / Month** | Average number of reports per month | | **T. / Week** | Average number of reports per week | | **T. / Day** | Average number of reports per day | | **T. / Staff** | Average number of reports handled per staff member | | **Average Duration** | Average time a report stays open before being closed | | **Reaction Time** | Average time before a staff member takes charge of a report | | **% Quick Reports** | Percentage of reports submitted as quick reports vs. custom reports | > ๐Ÿ’ก This table is **sortable by column** and includes a search field to filter results. *** ### Complete Statistics
The **Complete Statistics** table breaks down report activity **per staff member** across all time. Each row represents a staff member and includes: | Column | Description | | -------------------- | ----------------------------------------------------------- | | **Staff** | Staff member's username | | **T. Completed** | Total number of reports handled since the beginning | | **T. / Month** | Average reports handled per month | | **T. / Week** | Average reports handled per week | | **T. / Day** | Average reports handled per day | | **T. / Day Present** | Average reports handled per day the staff member was active | | **Average Duration** | Average time spent per report | | **Reaction Time** | Average time before taking charge of a report | > ๐Ÿ’ก This table is **sortable by column** and includes a search field. It supports **pagination** to browse through all staff members. *** ### Last Week Statistics The **Last Week Statistics** table focuses on the **previous week's activity** per staff member. It uses the same columns as the Complete Statistics table but is scoped to last week only, making it ideal for **weekly team reviews**. *** ### Weekly History
Below the last week table, the **Weekly History** table displays a **week-by-week breakdown** of each staff member's report activity. Each column represents a date range (e.g. `23/03/2026 โ†’ 05/04/2026`) and shows the number of reports handled that week. The evolution indicators use **color-coded arrows** to highlight trends: | Indicator | Meaning | | --------- | ---------------------------------------- | | ๐ŸŸข `โ†‘ +X` | Increase compared to the previous period | | ๐Ÿ”ด `โ†“ -X` | Decrease compared to the previous period | | โ€” | No activity or no change | > ๐Ÿ’ก This view is particularly useful for identifying **inactive periods** or **sudden spikes** in a staff member's activity over time. *** ### Recent Tickets
At the bottom of the page, the **Recent Tickets** table lists the latest reports submitted across all servers, ordered from most recent to oldest. For each ticket, the following information is displayed: | Column | Description | | ---------------------- | --------------------------------------------------------------- | | **#** | Unique report ID (auto-incremented) | | **Name** | The message or subject of the report as submitted by the player | | **Date / Time** | Exact timestamp of when the report was submitted | | **Opened By** | The player who submitted the report | | **Taken In Charge By** | The staff member who picked up the report | | **Closed By** | The staff member who closed the report | | **Duration** | Total time the report was open | > ๐Ÿ’ก This table supports **pagination** and a **search field** to quickly find a specific report by name, player, or staff member. *** > ๐Ÿ’ก **Tip:** Use the **Weekly History** table combined with the **Global Statistics** to generate accurate weekly reports for your moderation team and identify which servers or staff members need attention. *** # Appeals The Appeals section is accessible to **administrators and above** only. It centralizes requests from players seeking to challenge or lift a sanction (ban lift, warning removal, etc.). *** ## Open Appeals A table of all pending appeals, with the following columns: | Column | Description | | ------------------ | ------------------------------------------------------- | | **Request ID** | Unique identifier for the appeal | | **Player Name** | Nickname of the player who submitted the request | | **Sanction Type** | Nature of the sanction being contested | | **Request Status** | New (awaiting handling) or In Progress (being reviewed) | | **Request Date** | Date and time the appeal was submitted | Players can submit an appeal by clicking the appeal icon on their sanction in their Madonn'Admin player locker. By default, an appeal can only be submitted **2 months** after the sanction was applied (configurable in Madonn'Admin settings).
*** ## Appeal Detail Page Clicking on an appeal opens a dedicated page organized into five blocks.
**Player Information** โ€” identifying data (nickname, Discord, Steam, FiveM license, Xbox ID) and general statistics (first login, last login, total playtime). **Sanction Information** โ€” type of sanction, expiration date if applicable, time remaining before the ban expires, the staff member who applied it, and the reason. **Appeal Information** โ€” the type of appeal chosen by the player, current status, and their detailed written argument. **Player Records** โ€” full sanction history: notes, recommendations, warns, kicks, and bans. Administrators can also see the player's previous appeals. **Conclusion** โ€” two buttons to finalize the decision: * โœ… **Accept** โ€” validate the appeal and lift or reduce the sanction * โŒ **Refuse** โ€” reject the appeal
*** ## Closed Appeals A historical archive of all processed appeals, with the following columns: | Column | Description | | ------------------- | ------------------------------- | | **Request ID** | Unique identifier | | **Player Name** | Nickname of the player | | **Sanction Type** | Nature of the original sanction | | **Status** | Accepted or Refused | | **Resolution Date** | Date the appeal was finalized | The table is sortable alphabetically, by request type, or by resolution date. Clicking on a row opens the full appeal detail page for reference.
# Logs The logs interface provides a global view of all player activity across the server, presented as a structured table. Unlike player profile logs which are scoped to a single user, this section covers **all players** at once. *** ## Table Structure | Column | Description | | ------------------- | ------------------------------------------------------------------------------------ | | **Date / Time** | Exact timestamp of the action | | **Player Nickname** | The player who performed or was involved in the action | | **Player Action** | Description of the event (connection, death, injury, etc.) | | **Details** | Additional context โ€” for example, the nickname of another player involved in a fight |
*** ## Sorting & Filtering * Sort data by any column in ascending or descending order * Filter by event type to narrow down specific categories of actions * Search by player nickname for targeted investigations This makes it straightforward to spot anomalies, track a specific player's activity timeline, or analyze behavior patterns across the server.
# In Game Dashboard When you want to activate your moderation mode in-game, press `F10` (default key, configurable in settings). Once pressed, you are immediately redirected to the moderation interface. Your character is automatically placed in **god mode** (invisible), and an indicator appears above your head displaying `[ACTIVE STAFF] Your nickname` so other staff members can identify you. The rank management system enforces a strict hierarchy: lower-ranked members such as moderators cannot access data, tools, or actions reserved for administrators or higher ranks.
*** ## Sidebar Navigation The left sidebar contains a set of icons giving quick access to all major sections of the dashboard. | Icon | Section | | ----------- | ---------------------------------------------------------------------------- | | ๐Ÿ  House | **Home** โ€” default landing page, connected staff list, recent announcements | | ๐Ÿ‘ฅ Players | **Player list** โ€” all connected players, profiles, and direct action buttons | | ๐Ÿ“‹ Logs | **Server logs** โ€” filterable history of server events | | ๐ŸŽซ Reports | **Report system** โ€” manage player reports in real time | | โš™๏ธ Settings | **Settings** โ€” delete props/vehicles, toggle god mode and underwater mode | | ๐Ÿ”„ Reload | **Reload** โ€” refresh the current page data |
*** ## Pages * [๐Ÿ  Home Interface](/paid-scripts/madonnadmin/how-to-use-it/in-game-dashboard/home-interface) * [๐Ÿ‘ฅ Players List](/paid-scripts/madonnadmin/how-to-use-it/in-game-dashboard/players-list) * [๐Ÿ“‹ Logs](/paid-scripts/madonnadmin/how-to-use-it/in-game-dashboard/logs) * [๐ŸŽซ Report System](/paid-scripts/madonnadmin/how-to-use-it/in-game-dashboard/report-system) * [โŒจ๏ธ In-Game Commands](/paid-scripts/madonnadmin/how-to-use-it/in-game-dashboard/in-game-commands) * [โš™๏ธ Settings](/paid-scripts/madonnadmin/how-to-use-it/in-game-dashboard/settings) # Home interface When you activate the menu to take your shift as a moderator, the first page that appears is a detailed dashboard providing an overview of essential information. This page centralizes three key elements.
*** ## Connected Staff A complete list of staff members currently connected to the server, presented in a clear table with the following columns: * **Nickname** โ€” quick identification of each staff member * **Rank** โ€” moderator, administrator, or any other defined role * **Status** โ€” whether they are in active moderation mode or in roleplay mode *** ## Latest Announcements A section dedicated to the latest announcements posted by managers or team leaders. These can include reminders, procedure updates, or specific guidelines to follow.
*** ## Player Flag Graph An interactive visual graph compiling the **flags of players currently connected to the server**. This graph provides an immediate overview of player behavior, highlighting potential problematic situations or notable infractions. Staff members can use it to prioritize their interventions based on severity.
# Players list The player list interface displays all players currently connected to the server in a detailed table. For each player you can see their nickname, in-game ID, cumulative playtime, first connection date, and a summary of their sanctions (warns, kicks, bans). Clicking on a player's nickname opens their **Madonn'Admin profile** directly within the in-game menu, where you can view detailed statistics, connection history, and past sanctions.
*** ## Direct Action Buttons Each player profile includes a series of **action buttons** for common moderation interventions, executable in one click without typing any command. The following actions are available by default and can be fully customized in the resource configuration files: | Button | Description | | ------------------- | ------------------------------------------------------------ | | ๐Ÿš€ **Goto** | Teleport to the player's position | | ๐Ÿš— **Goto Vehicle** | Teleport to the player's vehicle | | ๐Ÿ”„ **Bring** | Teleport the player to your position | | โ†ฉ๏ธ **Return** | Send the player back to their original position | | ๐Ÿ’Š **Heal** | Fully restore the player's health | | ๐Ÿ’‰ **Revive** | Revive the player | | ๐Ÿ’€ **Kill** | Kill the player | | ๐ŸงŠ **Freeze** | Freeze or unfreeze the player in place | | *(+ custom)* | Any additional action configured by the server administrator | > ๐Ÿ”ง All quick action buttons are configurable โ€” administrators can add, remove, or modify them freely in the resource configuration files, including the label, the associated action, and the required permission level.
*** ## Sanctions The player profile also includes a detailed view of their **sanction history** (warns, kicks, bans). Administrators can apply new sanctions directly from this in-game panel, using the same options available on the web dashboard. # Logs The logs interface provides a detailed and organized view of server events, structured similarly to the web version of Madonn'Admin. The information is presented in a table with the following columns: | Column | Description | | ------------------- | ------------------------------------------- | | **Date / Time** | Exact timestamp of when the action occurred | | **Player Nickname** | The player involved in the event | | **Player Action** | Description of the event or interaction | | **Details** | Additional context or circumstances |
*** ## Filtering You can filter logs by specific categories to narrow down what you are looking for: * Connections * Chat messages * Weapon shots * Injuries (received or inflicted) * Player deaths * Explosions This filtering system makes it straightforward to track specific incidents, assess player behavior, or detect suspicious activity. # Report System The in-game report system allows players to quickly contact the staff team directly from the game, without leaving their session. Staff members are instantly notified and can manage reports through the in-game administration panel. *** ## How to Submit a Report Any player can open the report interface at any time by using the following command: ``` /report ``` The report flow works in the following steps: **1. Type selection** โ€” A first window opens asking the player to choose the type of report (quick report or custom report). **2. Screenshot** โ€” Once the type is selected, a **screenshot of the player's current view is automatically captured** and attached to the report. **3. Report content** โ€” The report window then opens, displaying the screenshot alongside the report content. **4. Floating notification** โ€” When the player **closes the report window**, a **floating notification widget appears on the left side of the screen**, keeping them informed of any updates in real time. *** ## Report Types Players can choose between two types of reports depending on their situation: ### Quick Reports Quick reports are **pre-configured short messages** defined by the server administrators in the configuration files. They allow players to send a report in just one click, without typing anything. > Quick reports are fully customizable โ€” server administrators can add, edit, or remove them freely in the config. ### Custom Reports Custom reports allow players to **type a detailed message** to describe their issue precisely. This is the recommended option for complex situations requiring context. *** ## What Happens After Submitting? Once the report is submitted and the window is closed: * ๐Ÿ”ฒ A **floating notification widget appears on the left side of the screen**, keeping the player updated without interrupting gameplay * ๐Ÿ”” Staff members are **notified in-game** and can see the new report in the administration panel * ๐Ÿ’ฌ The player will be **updated in real time** through the floating widget whenever: * Their report is **taken in charge** by a staff member * A staff member **sends a message** in response *** ## Communication with Staff The report system includes a **built-in messaging system** between the player and the staff member handling the report. Both parties can exchange messages directly within the report interface, without needing to use any external tool. *** ## Report Status Each report goes through the following status lifecycle: | Status | Description | | ------------------ | -------------------------------------------------------------------------- | | ๐ŸŸก **New** | The report has been submitted and is waiting for a staff member to take it | | ๐Ÿ”ต **In Progress** | A staff member has taken charge of the report and is handling it | | ๐ŸŸข **Closed** | The report has been resolved and closed by the staff | Players are notified at each status change via the **floating notification widget** on the left side of the screen. *** ## Staff Side Staff members receive a **real-time in-game notification** when a new report is submitted. They can then: * View the report details including the **automatic screenshot** * Read the player's message * **Change the report status** (Pending โ†’ In Progress โ†’ Closed) * **Reply directly** to the player through the messaging system * **Execute quick actions** on the reported player directly from the report panel * Manage all active reports from the **in-game administration panel** ### Quick Action Buttons Staff members have access to **configurable quick action buttons** directly within the report panel. These allow them to apply common moderation actions on a player in one click, without having to type any command. The following actions are available by default and can be fully customized in the resource configuration files: | Button | Description | | -------------- | ------------------------------------------------------------ | | ๐Ÿš€ **Goto** | Teleports the staff member to the reported player | | ๐Ÿ”„ **Bring** | Teleports the reported player to the staff member | | โ†ฉ๏ธ **Return** | Sends the reported player back to their original position | | ๐ŸงŠ **Freeze** | Freezes or unfreezes the reported player in place | | ๐Ÿ’Š **Heal** | Fully restores the reported player's health | | ๐Ÿ’€ **Kill** | Kills the reported player | | ๐Ÿ”ง **Fix VCL** | Repairs the reported player's current vehicle | | *(+ custom)* | Any additional action configured by the server administrator | > ๐Ÿ”ง **All quick action buttons are configurable** โ€” server administrators can add, remove, or modify them freely in the resource configuration files, including the button label, the associated action, and the required permission level to use them. *** > ๐Ÿ’ก **Tip for players:** Always use a **custom report** if your issue requires explanation. The automatic screenshot will help staff understand your situation immediately # In Game Commands In addition to the dashboard interface, several chat commands are available for quick in-game interventions. *** ## `/goto [ID]` Teleports you directly to a specific player. Replace `[ID]` with the player's in-game ID. ``` /goto 5 ``` *** ## `/bring [ID]` Teleports a player to your current position. You can bring multiple players at once by separating their IDs with spaces. ``` /bring 10 /bring 10 20 30 ``` *** ## `/return [ID]` Returns a player to their position before they were teleported. Useful for sending a player back after a moderation conversation without leaving them disoriented. ``` /return 10 /return 10 20 30 ``` # Settings The settings panel gives access to tools for cleaning the server environment and managing your moderation state.
*** ### Props & Vehicles Deletion Define a **radius** around your position and delete all props or vehicles within that area in one click. * **Objects** โ€” all prop-type objects generated on the server, whether dropped by players or spawned by scripts * **Vehicles** โ€” player vehicles and NPC-generated or abandoned vehicles Once the radius is configured, click the arrow in the purple frame to apply the deletion. This is particularly useful during events or specific interventions requiring localized cleanup. *** ### Moderation State Options Two additional options are available depending on your permission level: * **Underwater mode** โ€” hides your presence as active staff from players * **God mode** โ€” toggle god mode on or off (enabled by default when switching to active staff) # Discord Functionalities ## ๐Ÿ’ฌ Available Commands Once installed, the bot registers the following slash commands on your Discord server: ### `/infojoueur` Retrieves information about a specific player from your Madonn'Admin community. The bot returns a detailed embed including: * FiveM username * Total playtime * Join date and last connection date * License identifiers * A direct link to their **Madonn'Admin profile** * A **sanction preview** button * An **Apply a sanction** button for quick moderation actions directly from Discord
### `/profil` Displays your own Madonn'Admin profile โ€” your linked player information, rank, and community association. ### `/statut embed` Sends a **permanent status embed** in the current channel. This embed automatically updates to reflect the live status of your FiveM servers, showing: * Server name * Online / Offline status * Number of connected players * The F8 connection command (`connect xxx`) * Last update timestamp and resource version > ๐Ÿ’ก This command is ideal for a dedicated `#server-status` channel. The embed updates automatically โ€” no need to resend it.
### `/statut obtenir` Retrieves the current status of your servers on demand, without posting a permanent embed. Useful for quickly checking server status in any channel. # Exports & Events Madonn'Admin exposes client-side and server-side exports, as well as a server-side HTTP API and custom log events for integration with other resources. *** ## ๐Ÿ–ฅ๏ธ Client-side Exports ### GetStaffRank Returns the staff rank ID of the local player. ```lua local rank = exports['MS_MadonnAdmin']:GetStaffRank() -- Returns: number -- -1 = Super Admin -- 0 = Not a staff member -- 1+ = Staff rank (lower number = higher authority) ``` #### Example ```lua local rank = exports['MS_MadonnAdmin']:GetStaffRank() if rank ~= 0 and rank ~= nil then print("This player is a staff member (rank " .. rank .. ")") end ``` > This export is used by other MadonneStudio resources (e.g. MS\_Delete\_Gun with `MADONNADMIN = "auto"`) to detect whether the local player has staff access. *** ### IsPlayerTrusted Returns whether the local player is considered trusted by the Madonn'Admin trust system. ```lua local trusted = exports['MS_MadonnAdmin']:IsPlayerTrusted() -- Returns: boolean ``` A player is considered **untrusted** if they have any of the following flags active: * `flag_last_chance` * `flag_sanction_lover` * `flag_untrusted_plus` * `flag_untrusted` #### Example ```lua local trusted = exports['MS_MadonnAdmin']:IsPlayerTrusted() if not trusted then -- Apply restrictions for untrusted players end ``` *** ## ๐ŸŒ Server-side Exports ### GetStaffLevelServerSide Returns the staff rank ID of a given player by their server ID. ```lua local rank = exports['MS_MadonnAdmin']:GetStaffLevelServerSide(source) -- Returns: number (same scale as GetStaffRank) -- Returns 0 if the player is not a staff member or not found ``` #### Example ```lua AddEventHandler("playerConnecting", function(name, setReason, deferrals) local rank = exports['MS_MadonnAdmin']:GetStaffLevelServerSide(source) if rank ~= 0 then print(name .. " is connecting as a staff member (rank " .. rank .. ")") end end) ``` *** ### GetStaffStatus Returns whether a given player is currently in **active moderation mode** (i.e. they have activated their staff mode in-game). ```lua local active = exports['MS_MadonnAdmin']:GetStaffStatus(source) -- Returns: boolean ``` #### Example ```lua -- Check if a staff member is actively moderating before assigning them a task local isActive = exports['MS_MadonnAdmin']:GetStaffStatus(source) if isActive then print("Staff member is currently in active moderation mode") end ``` *** ## ๐Ÿ“ก Custom Log Event Madonn'Admin exposes a custom log event that allows any resource to push entries into the Madonn'Admin log system, including Discord webhook delivery and automatic screenshots. ```lua TriggerEvent('MadonnAdmin:SimpleLog', type, playerA, detail, playerB, text, colorEmbed, screenshot, webhookAddress) ``` | Parameter | Type | Description | | ---------------- | ----------------- | --------------------------------------------------------------------------------------------------------------- | | `type` | `number` | Log type. Use `8` for custom logs | | `playerA` | `number` | Server ID of the primary player | | `detail` | `string` | Detail text of the log | | `playerB` | `number` \| `nil` | Server ID of a second player (e.g. the attacker), or `nil` | | `text` | `string` \| `nil` | Custom action label to display in the embed | | `colorEmbed` | `number` | Discord embed color in hex (e.g. `0xFF0000`) | | `screenshot` | `boolean` | If `true`, automatically captures a screenshot of `playerB` (or `playerA`) and attaches it to the Discord embed | | `webhookAddress` | `string` | Discord webhook URL to send the log to | #### Example ```lua -- Log a custom event with a screenshot TriggerEvent( 'MadonnAdmin:SimpleLog', 8, -- type 8 = custom log source, -- playerA "Used a forbidden item", -- detail nil, -- no playerB "Custom Action", -- action label 0x662d91, -- embed color (purple) true, -- take screenshot "https://discord.com/api/webhooks/your-webhook-here" ) ``` *** ## ๐Ÿ”” Custom Notification Handler When `NotificationSystem` is set to `"custom"` in `config/cfg_main.lua`, edit `client/custom/cl_functions.lua` to implement your own notification: ```lua function CustomNotify(text) -- Your custom notification code here -- Example with okokNotify: exports['okokNotify']:Alert("MadonneStudio", text, 5000, 'info', true) end ``` *** ## ๐Ÿ“‹ Custom Log Handler To add your own persistent log logic, edit the provided custom log files: **Client-side** โ€” `client/custom/cl_logs.lua`: ```lua if LOGS.LogsEnabled.Other then CreateThread(function() -- Your custom client-side log code here end) end ``` **Server-side** โ€” `server/custom/sv_logs.lua`: ```lua if LOGS.LogsEnabled.Other then CreateThread(function() -- Your custom server-side log code here -- Use TriggerEvent('MadonnAdmin:SimpleLog', 8, ...) to push to Discord end) end ``` # Common Errors ## ๐Ÿ”ด You lack the required entitlement to use MS\_MadonnAdmin This message indicates that your server does not have the necessary entitlement to start the resource. This is related to FiveM's **Escrow** protection system. Check the following points one by one: * โœ… The **CFX Portal key** listed in your `server.cfg` does not contain any typing error * โœ… The CFX Portal key belongs to the **FiveM account that was used to purchase or claim** the resource * โœ… The resource has been **successfully claimed** on the [CFX Portal](https://portal.cfx.re/) * โœ… The CFX Portal key linked to your server **belongs to you**, and not to your hosting provider > โš ๏ธ Some hosting providers include a shared CFX Portal key as part of their offers. A key that does not belong to you will block the use of **any Escrow-protected resource**, without exception. Always use your own personal key. *** ## ๐Ÿ”ด Error 0xA01 โ€” Failed to initialize Madonn'Admin ``` [ERROR - #0xA01] An error has occured during the loading of MadonnAdmin. Please check your Server Token in the config.lua ``` **Cause:** The Madonn'Admin platform could not be reached, or the Server Token is invalid. **Fix:** * Verify that `Server_Token` in `config/cfg_main.lua` matches exactly the token shown in your community settings on `madonnadmin.com` * Make sure your FiveM server has outbound internet access to `madonnadmin.com` * If the platform is temporarily unavailable, the resource will retry automatically every 5 seconds *** ## ๐Ÿ”ด Error 0xA02 โ€” Community not found or subscription inactive ``` [ERROR - #0xA02] An error has occured during the loading of MadonnAdmin. Please check your Server Token in the config.lua ``` **Cause:** The Server Token is recognized but the associated community cannot be loaded. This usually means the subscription is inactive or the community has been deleted. **Fix:** * Check that your subscription is active on `madonnadmin.com` * Verify that the server is correctly configured in your community dashboard with the right IP address * If your IP has changed, update it in the Madonn'Admin dashboard *** ## ๐Ÿ”ด Error 0xC01 โ€” Player blocked from connecting ``` [ERROR - #0xC01] Player X is not verified through Madonn'Admin and will not be connected ``` **Cause:** Madonn'Admin is offline or unreachable, and `Failure_Override` is set to `false` in `config/cfg_main.lua`, so players are blocked from joining. **Fix:** Set `Failure_Override = true` to allow players to connect even when Madonn'Admin is temporarily unavailable: ```lua Failure_Override = true, ``` > ๐Ÿ’ก When `Failure_Override` is `true`, players will see a brief warning message but will still be able to connect. Bans and permission checks will be suspended until the connection is restored. *** ## ๐Ÿ”ด Error 0xC02 โ€” No response from Madonn'Admin when loading permissions ``` [ERROR - #0xC02] No response received from Madonn'Admin ``` **Cause:** The platform did not respond when loading a player's permissions after they connected. **Fix:** This is usually a temporary network issue. It resolves itself automatically on the next connection attempt. If it happens persistently, check that your server has stable outbound internet access. *** ## ๐Ÿ”ด The admin menu does not open **Cause 1:** The player does not have a staff rank assigned in Madonn'Admin. **Fix:** Go to **Team Staffs โ†’ Manage Staffs** in the dashboard, select the correct server, and assign a role to the player. **Cause 2:** The player has a rank assigned but has not connected since the assignment. **Fix:** Have the player disconnect and reconnect to the server so their permissions are reloaded. **Cause 3:** The key binding is conflicting with another resource. **Fix:** Check the FiveM key bindings in **Settings โ†’ Key Bindings โ†’ FiveM** and look for the **"Open Admin Menu"** entry. Reset it to the configured key (`F10` by default). *** ## ๐Ÿ”ด Staff member has no permissions after being added **Cause:** The player was added to the community but has not yet been assigned a role, or the role has no permissions enabled. **Fix:** * Go to **Team Staffs โ†’ Manage Staffs**, select the server, and assign the correct role to the player * In **Roles**, verify that the role has the necessary permission toggles enabled (teleportations, spectate, god mode, etc.) * Have the player reconnect to reload their permissions *** ## ๐Ÿ”ด Screenshots are not working **Cause 1:** `screenshot-basic` is not installed or not started before `MS_MadonnAdmin`. **Fix:** Install `screenshot-basic` and make sure it is ensured before `MS_MadonnAdmin` in your `server.cfg`: ```cfg ensure screenshot-basic ensure MS_MadonnAdmin ``` **Cause 2:** The Discord webhook in `config/module/cfg_screenshots.lua` is invalid or missing. **Fix:** Replace the webhook URL with a valid one from your Discord server: ```lua SCREENSHOTS = { ScreenshotBasicName = "screenshot-basic", DiscordWebhookToSaveScreenshots = "https://discord.com/api/webhooks/...", } ``` *** ## ๐Ÿ”ด Logs are not appearing in Discord **Cause:** The Discord webhook URLs in `config/module/cfg_logs.lua` are set to `false` or are invalid. **Fix:** Set valid webhook URLs for the log types you want to receive: ```lua LOGS = { DiscordWebhook = { Connections = "https://discord.com/api/webhooks/...", Chat = "https://discord.com/api/webhooks/...", Shots = "https://discord.com/api/webhooks/...", -- etc. } } ``` Set any entry to `false` to disable that log type's webhook. *** ## ๐Ÿ”ด Anti-cheat is not running *(Silver & Gold only)* **Cause 1:** `ModuleAnticheat` is set to `false` in `config/cfg_main.lua`. **Fix:** Set it to `true`: ```lua ModuleAnticheat = true, ``` **Cause 2:** Your subscription tier is **Bronze**. The anti-cheat module requires **Silver or Gold**. **Fix:** Upgrade your subscription at `madonnadmin.com`. *** ## ๐Ÿ”ด Sanction returns "Error 0xS14" or "Error 0xS18" ``` [ERROR - #0xS14] An error occured while applying sanction to X ``` **Cause:** The Madonn'Admin API returned an error when applying the sanction. This can happen if the targeted player's profile is not yet fully synchronized. **Fix:** * Make sure the target player has connected at least once and their profile exists on `madonnadmin.com` * If the error persists, contact support with the full error message *** ## ๐Ÿ”ด Ban screen not showing to a banned player **Cause:** The `Failure_Override` option allowed the player through before the ban check completed, or the player's identifiers changed. **Fix:** * Check that the player's ban is correctly registered on `madonnadmin.com` under their profile * Verify that the player is connecting with the same identifiers (Steam, FiveM, etc.) that were used when the ban was applied *** ## ๐Ÿ’ฌ Still having issues? If you are still experiencing problems after following the steps above, feel free to reach out to us: * ๐Ÿ’ฌ **Discord:** [discord.gg/madonne](https://discord.gg/madonne) * ๐ŸŒ **Website:** [madonnestudio.com](https://madonnestudio.com/) * ๐Ÿ“ง **Email:** # Madonne DOJ Welcome to the complete documentation for **Madonne DOJ**, a comprehensive judicial and police management system for FiveM servers.
## About Madonne DOJ **Madonne DOJ** is a complete FiveM script that enables the management of investigation folders, documents, warrants, examinations, citizen records, and violations for police and justice services. ### Main Features * ๐Ÿ“ **Complete investigation folder management** - Create, organize, and track investigation cases * ๐Ÿ“„ **Document creation and modification** - Generate and manage all types of legal documents * โš–๏ธ **Arrest and search warrant system** - Issue warrants with proper judicial oversight * ๐ŸŽค **Examination management** - Record interrogations of suspects and witnesses * ๐Ÿ“‹ **Citizen criminal records** - Maintain comprehensive criminal history database * ๐Ÿšจ **Violations catalog** - Manage and categorize criminal offenses * ๐Ÿ‘ฅ **Multi-service management** - Support for multiple agencies (LSPD, LSSD, FIB, DOJ, etc.) * ๐Ÿ” **Advanced role-based permissions** - Granular access control using bitmask system * ๐ŸŒ **Multilingual interface** - French and English included, easily extensible * ๐Ÿ“Š **User-personalized dashboard** - Each officer has their own customized view *** ## Quick Links * [Installation Guide](/paid-scripts/madonnedoj/installation) - Get started with Madonne DOJ * [Configuration](/paid-scripts/madonnedoj/configuration) - Configure the script for your server * [Permissions System](/paid-scripts/madonnedoj/configuration/permissions-system) - Understand and configure permissions * [Internationalization](/paid-scripts/madonnedoj/configuration/adding-a-new-language) - Add new languages to the interface * [Usage Guide](/paid-scripts/madonnedoj/usage) - Learn how to use the tablet interface * [Support](/paid-scripts/madonnedoj/support) - Get help when you need it *** **Madonne DOJ v1.0.0** *Developed by M\_g for MadonneStudio ยฉ 2025 - All rights reserved* [Discord](https://discord.gg/madonne) โ€ข [Website](https://madonnestudio.com) โ€ข [Email](mailto:contact@madonnestudio.com) # Installation This guide will walk you through the installation process of **Madonne DOJ** on your FiveM server. ## Prerequisites Before installing Madonne DOJ, make sure you have: * โœ… A **FiveM Server** up and running * โœ… A **MySQL Database** configured ## Installation Steps Follow these steps to install Madonne DOJ on your server: ### Step 1: Download the Resource Download the `MS_MaodonneDOJ` resource and place it in your server's `resources` folder. ``` resources/ โ””โ”€โ”€ MS_MaodonneDOJ/ ``` ### Step 2: Import the Database Execute the SQL file to create the necessary database tables: ```sql -- Execute the db.sql file in your MySQL database ``` You can import it using: * **phpMyAdmin**: Import the `db.sql` file * **MySQL Command Line**: ```bash mysql -u username -p database_name < db.sql ``` * **HeidiSQL** or any other database management tool ### Step 3: Configure the Script Open the `config.lua` file and configure it according to your server's needs. At minimum, you should configure: ```lua CONFIG_MADONNE_DOJ = { OpenTabletCmd = "tablet", -- Command to open the tablet DebugMode = false, -- Set to true only for debugging LocaleUi = "en", -- "fr" or "en" Services = { -- Configure your police and justice services here }, Webhooks = { WarrantView = "YOUR_DISCORD_WEBHOOK_URL_HERE" } } ``` For detailed configuration options, see the [Configuration Guide](/paid-scripts/madonnedoj/configuration). ### Step 4: Add to Server Configuration Add the resource to your `server.cfg` file: ```cfg ensure MS_MaodonneDOJ ``` Make sure it's placed **after** your framework (ESX/QBCore) in the load order. **Example:** ```cfg ensure es_extended ensure oxmysql ensure MS_MaodonneDOJ ``` ### Step 5: Restart Your Server Restart your FiveM server to load the resource: ```bash restart MS_MaodonneDOJ ``` Or restart the entire server if you prefer. ## Verification To verify the installation was successful: 1. **Check the server console** for any errors 2. **Join your server** as a player 3. **Type the command** `/tablet` (or the command you configured) 4. The tablet interface should open successfully ## Troubleshooting ### The tablet won't open * โœ… Check that you have the necessary permissions in your job/service * โœ… Verify the command in `config.lua` matches what you're typing * โœ… Check the server console for errors ### Database errors * โœ… Ensure `db.sql` was imported correctly * โœ… Check your database credentials * โœ… Verify all tables were created ### Configuration errors * โœ… Make sure your `config.lua` syntax is correct * โœ… Verify all required fields are filled * โœ… Enable `DebugMode = true` to see detailed logs ## Next Steps Now that Madonne DOJ is installed, you should: 1. [**Configure your services**](/paid-scripts/madonnedoj/configuration/services-configuration) - Set up your police and justice departments 2. [**Learn how to use it**](/paid-scripts/madonnedoj/usage) - Understand the tablet interface 3. [**Set up language**](https://github.com/DylanPageot/DocumentationAddonsScripts/blob/main/paid-scripts/madonnedoj/broken-reference/README.md) - Configure your preferred language *** Need help? Check our [Support page](/paid-scripts/madonnedoj/support) or join our [Discord](https://discord.gg/madonne). # Usage Guide This guide will help you understand how to use the Madonne DOJ tablet interface effectively. ## Opening the Tablet To open the DOJ tablet, use the command configured in your `config.lua`: ``` /tablet ``` By default, this is `/tablet`, but your server administrator may have changed it. {% hint style="info" %} **Note:** Only players with assigned police or justice services can access the tablet. {% endhint %} ## Interface Overview The tablet interface is divided into two main parts: ### Login or Register ?
Screenshot of the account creation screen

Account creation screen

The first screen you will encounter is the account creation screen. * Enter your role-play information (surname, first name, date of birth) and the department you wish to join. * Click on โ€˜Submit profileโ€™ and a request will be sent to the managers of the requested service. > Administrators can also use the "Connect as a server admin" button to access their view.
Screenshot of the login screen

Login screen

Once your request has been accepted, you will be able to log in to your profile. Simply select it and click on โ€˜Loginโ€™. You also have the option to create other profiles (they are all linked to your Discord ID). ### Sidebar Menu (Left)
Sidebar screenshot

Sidebar

The sidebar contains navigation icons for all available sections: * ๐Ÿ“Š **Dashboard** - Your personal overview * โš™๏ธ **Services** - Service administration * ๐Ÿ“ **Investigations** - Case management * โš–๏ธ **Warrants** - Warrant system * ๐Ÿ‘ค **Records** - Criminal records * ๐Ÿšจ **Violations** - Offense catalog * ๐Ÿ—„๏ธ**Archives** - Archived case viewing {% hint style="info" %} Click on your name to log out. {% endhint %} ### Main Content Area (Right) The main area displays the content for the selected section. ## Features by Section ### ๐Ÿ“Š Dashboard
Dashboard screenshot

Dashboard

Your personal dashboard shows: * **My Investigations** - Cases you're assigned to * **My Documents** - Documents you've created * **My Examinations** - Interrogations you've conducted **Quick Actions:** * Click any item to open it * See recent activity at a glance *** ### โš™๏ธ Services

Detailed vue of a service

Manage service members and pending requests (Chiefs only). **What you can do:** * โœ… View service members * โœ… Approve pending members * โœ… Remove members from service * โœ… Manage service roster {% hint style="warning" %} **Required Permission:** `MANAGE_SERVICES` (128) {% endhint %} **Service Management:** 1. View all current members 2. See pending join requests 3. Approve or deny requests 4. Remove officers from service *** ### ๐Ÿ“ Investigations
Screenshot of the main view of investigations tab

Investigations main view

Detailed view of an investigation

Manage investigation folders and cases. **What you can do :** * โœ… Create new investigation folders * โœ… View all investigations (if you have access) * โœ… Edit investigation details * โœ… Assign officers to cases * โœ… Assign services to investigations {% hint style="warning" %} **Required Permission:** `MANAGE_FOLDERS` (1) {% endhint %} {% hint style="info" %} * The investigations you are responsible for appear in purple. * You only have access to your own investigations or those of your department. {% endhint %} **How to create an investigation:**
Creating an investigation

Creating an investigation

1. Click the **"+"** button 2. Enter investigation title 3. Add description 4. Assign officers in charge 5. Select services involved 6. Click **Save** *** ### โš–๏ธ Warrants

Detailed view of a warrant

Manage arrest warrants and search warrants. **What you can do:** * โœ… Create warrant requests (police) * โœ… View warrants * โœ… Edit pending warrants * โœ… Sign/Issue warrants (justice only) * โœ… Send warrants to Discord {% hint style="warning" %} **Required Permissions:** * `MANAGE_WARRANTS` (4) - Create and edit warrants * `ISSUE_WARRANTS` (8) - Sign and issue warrants (justice department only) {% endhint %} **Warrant Types:** * ๐Ÿš” **Arrest Warrant** - To arrest a suspect * ๐Ÿ” **Search Warrant** - To search property **Warrant Workflow:** 1. **Police Officer** creates warrant request 2. Fills in suspect information 3. Adds probable cause 4. Submits for approval 5. **Judge** reviews the warrant 6. Judge signs and issues if approved 7. Warrant becomes active 8. Notification sent to Discord (if configured) **How to create a warrant:** 1. Click the **"+"** button 2. Select warrant type (Arrest/Search) 3. Select suspect from folder 4. Enter details and probable cause 5. Submit for approval **How to issue a warrant (Justice only):** 1. Open pending warrant 2. Review details 3. Click **Issue Warrant** 4. Enter reason/notes 5. Confirm issuance 6. Warrant is now active *** ### ๐Ÿ“„ Documents (only in investigation view)

Detailed view of a document

Create and manage documents related to investigations. **What you can do:** * โœ… Create new documents * โœ… View documents (from your service or investigations you're assigned to) * โœ… Edit existing documents * โœ… Assign officers to documents * โœ… Add suspects and witnesses {% hint style="warning" %} **Required Permission:** `MANAGE_DOCUMENTS` (2) {% endhint %} *** ### ๐ŸŽค Examinations (only in investigation view)

Detailed view of an examination

Record interrogations and witness statements. **What you can do:** * โœ… Create examination records * โœ… Document interrogations * โœ… Link to investigation folders * โœ… Record suspect/witness statements * โœ… Assign conducting officers {% hint style="warning" %} **Required Permission:** `MANAGE_EXAMINATIONS` (16) {% endhint %} **How to record an examination:** 1. Click the **"+"** button 2. Enter examination title 3. Select examinee (suspect/witness) 4. Add interrogation details/transcript 5. Assign officers present 6. Click **Save** *** ### ๐Ÿ‘ค Records

Detailed view of a criminal record

View and manage citizen criminal records. **What you can do:** * โœ… Search for citizens * โœ… View criminal history * โœ… See all related investigations * โœ… Create new citizen records * โœ… Update citizen information {% hint style="warning" %} **Required Permission:** `MANAGE_RECORDS` (64) {% endhint %} **How to search records:** 1. Use the search bar 2. Enter citizen name or ID 3. Click on result to view full record 4. See all investigations, warrants **Record Information Includes:** * Personal information * Investigation history * Active warrants *** ### ๐Ÿšจ Violations Manage the catalog of criminal offenses. **What you can do:** * โœ… View all violations * โœ… Add new violation types * โœ… Edit violation details * โœ… Set fines and jail times * โœ… Categorize offenses {% hint style="warning" %} **Required Permission:** `MANAGE_VIOLATIONS` (256) {% endhint %} **How to add a violation:** 1. Click the **"+"** button 2. Enter violation name 3. Add description 4. Set fine amount 5. Set jail time 6. Assign category 7. Click **Save** **Violation Categories:** * Traffic offenses * Violent crimes * Property crimes * Drug offenses * White collar crimes * Custom categories *** ## Troubleshooting ### Can't see certain sections **Cause:** You don't have permission\ **Solution:** Contact your supervisor or administrator ### Can't create items **Cause:** Missing required permissions\ **Solution:** Check your role permissions ### Items not saving **Cause:** Server connection issue\ **Solution:** Check console (F8), contact administrator ### Tablet won't open **Cause:** Not assigned to a service or wrong command\ **Solution:** Verify you're employed and using correct command ## Permission Quick Reference To use each section, you need: | Section | Required Permission | Value | | ---------------------- | -------------------- | ----- | | Dashboard | (Any permission) | - | | Investigations | MANAGE\_FOLDERS | 1 | | Documents | MANAGE\_DOCUMENTS | 2 | | Warrants (Create) | MANAGE\_WARRANTS | 4 | | Warrants (Issue) | ISSUE\_WARRANTS | 8 | | Examinations | MANAGE\_EXAMINATIONS | 16 | | Requests | MANAGE\_REQUESTS | 32 | | Records | MANAGE\_RECORDS | 64 | | Services | MANAGE\_SERVICES | 128 | | Violations | MANAGE\_VIOLATIONS | 256 | | Archive investigations | ARCHIVE\_FOLDERS | 512 | For more on permissions, see: * [Permissions System](/paid-scripts/madonnedoj/configuration/permissions-system) ## Getting Help If you need assistance: * ๐Ÿ“– Check this documentation * ๐Ÿ’ฌ Ask your supervisor or chief * ๐ŸŽซ Contact server administration * ๐Ÿ“ง Report bugs to development team # Configuration Madonne DOJ offers extensive configuration options to adapt the script to your server's specific needs. This section will guide you through all available configuration options. ## Configuration Files The main configuration is located in: ``` config.lua ``` This file contains all the settings for: * Basic options (commands, debug mode, language) * Services configuration (police departments, justice services) * Permissions settings * Webhooks configuration ## Configuration Sections Our configuration is divided into several main sections: ### ๐Ÿ”ง Main Configuration General settings that affect the entire script's behavior. * [Main Configuration](/paid-scripts/madonnedoj/configuration/main-configuration) ### ๐Ÿข Services Configuration Configure all your police and justice services, including their names, permissions, and roles. * [Services Configuration](/paid-scripts/madonnedoj/configuration/services-configuration) ### ๐Ÿ” Permissions System Understand and configure the advanced bitmask-based permissions system. * [Permissions System](/paid-scripts/madonnedoj/configuration/permissions-system) ## Quick Start For a quick setup, follow these steps: 1. **Set the tablet command** - Choose the command players will use to open the tablet 2. **Configure your language** - Select `"fr"` or `"en"` (or add your own) 3. **Set up your services** - Add your police departments and justice services 4. **Configure permissions** - Define what each role can do 5. **Add Discord webhook** (optional) - For warrant notifications ## Configuration Best Practices โœ… **Do:** * Test configuration changes in a development environment first * Keep a backup of your `config.lua` before making major changes * Use meaningful names for your services * Document custom permission values for your team โŒ **Don't:** * Use duplicate service names * Forget to configure permissions for each service * Leave debug mode enabled in production * Share your Discord webhooks publicly ## Need Help? If you need assistance with configuration: * ๐Ÿ“– Read the detailed configuration pages in this section * ๐Ÿ’ฌ Join our [Discord](https://discord.gg/madonne) for support * ๐Ÿ“ง Contact us at *** Let's dive into the specific configuration sections! # Main Configuration The main configuration section contains the general settings that affect the entire script's behavior. ## Basic Options ### Opening Command ```lua OpenTabletCmd = "tablet" ``` This is the command players will use to open the tablet interface. | Property | Type | Default | Description | | --------------- | -------- | ---------- | ---------------------------------------- | | `OpenTabletCmd` | `string` | `"tablet"` | Command to open the tablet (without `/`) | **Example:** ```lua OpenTabletCmd = "doj" -- Players will use /doj ``` ### Debug Mode ```lua DebugMode = true ``` Enable or disable debug information in the console. | Property | Type | Default | Description | | ----------- | --------- | ------- | ------------------------------------ | | `DebugMode` | `boolean` | `false` | Display debug information in console | {% hint style="warning" %} **Important:** Set `DebugMode = false` in production to avoid console spam. {% endhint %} **When to use Debug Mode:** * โœ… During initial setup * โœ… When troubleshooting issues * โœ… When testing new configurations * โŒ In production (regular use) ### User Interface Language ```lua LocaleUi = "fr" ``` Set the default language for the user interface. | Property | Type | Default | Options | Description | | ---------- | -------- | ------- | ------------------------- | ------------------------------------------------- | | `LocaleUi` | `string` | `"fr"` | `"fr"`, `"en"`, or custom | UI language (must match a file in `/ui/locales/`) | **Available languages:** * ๐Ÿ‡ซ๐Ÿ‡ท `"fr"` - French * ๐Ÿ‡ฌ๐Ÿ‡ง `"en"` - English * ๐ŸŒ Custom - [Add your own language](/paid-scripts/madonnedoj/configuration/adding-a-new-language) ## Text Messages Customize the messages displayed to players: ```lua Strings = { no_permission = "You are not authorized to use this.", } ``` | Key | Default Value | Description | | --------------- | --------------------------------------- | ------------------------------------------------------------------------ | | `no_permission` | `"You are not authorized to use this."` | Message shown when a player tries to access something without permission | You can add more custom messages here and reference them throughout your script. ## Webhooks Configuration Configure Discord webhooks for notifications: ```lua Webhooks = { WarrantView = "https://discord.com/api/webhooks/YOUR_WEBHOOK_URL_HERE" } ``` | Property | Type | Description | | ------------- | -------- | --------------------------------------------- | | `WarrantView` | `string` | Discord webhook URL for warrant notifications | **How to get a Discord webhook:** 1. Go to your Discord server 2. Select a channel โ†’ Edit Channel 3. Integrations โ†’ Webhooks โ†’ New Webhook 4. Copy the webhook URL 5. Paste it in the configuration **What gets sent:** * Warrant creation notifications * Warrant issuance alerts * Warrant details (suspect, type, issuing officer) {% hint style="info" %} **Optional:** You can leave the webhook empty if you don't want Discord notifications. {% endhint %} ## Example Complete Configuration Here's a complete example of the main configuration: ```lua CONFIG_MADONNE_DOJ = { -- Basic Settings OpenTabletCmd = "tablet", DebugMode = false, LocaleUi = "en", -- Messages Strings = { no_permission = "You are not authorized to use this.", }, -- Services will be configured in the next section Services = { -- See Services Configuration }, -- Discord Integration Webhooks = { WarrantView = "https://discord.com/api/webhooks/1234567890/abcdefgh" } } ``` ## Next Steps Now that you've configured the main settings, continue with: * [Services Configuration](/paid-scripts/madonnedoj/configuration/services-configuration) - Set up your police and justice departments *** Need help? Visit our [Support page](/paid-scripts/madonnedoj/support). # Services Configuration The Services section allows you to configure all police and justice services available on your server. Each service can have its own permissions and access levels. ## Service Structure Each service in the configuration follows this structure: ```lua { name = "LSPD", fullName = "Los Santos Police Department", isJustice = false } ``` ### Properties | Property | Type | Required | Description | | ----------- | --------- | -------- | ------------------------------------------ | | `name` | `string` | โœ… Yes | **Unique** short name/code for the service | | `fullName` | `string` | โœ… Yes | Full display name of the service | | `isJustice` | `boolean` | โœ… Yes | Whether this is a judicial service | {% hint style="danger" %} **Important:** The `name` property must be **unique** across all services. It's used as the service identifier throughout the system. {% endhint %} ## Police Services Police services are standard law enforcement agencies. They have configurable permissions based on roles. ### Example: Police Department ```lua { name = "LSPD", -- MUST BE UNIQUE fullName = "Los Santos Police Department", isJustice = false } ``` ### Common Police Services
Los Santos Police Department (LSPD) ```lua { name = "LSPD", fullName = "Los Santos Police Department", isJustice = false } ```
Los Santos Sheriff's Department (LSSD) ```lua { name = "LSSD", fullName = "Los Santos Sheriff's Department", isJustice = false } ```
San Andreas Highway Patrol (SAHP) ```lua { name = "SAHP", fullName = "San Andreas Highway Patrol", isJustice = false } ```
Federal Investigation Bureau (FIB) ```lua { name = "FIB", fullName = "Federal Investigation Bureau", isJustice = false } ```
## Justice Services Justice services (`isJustice = true`) have special properties and automatically receive **all permissions**. ### Example: Department of Justice ```lua { name = "DOJ", fullName = "Department of Justice", isJustice = true } ``` ### What Justice Services Can Do Services with `isJustice = true` have unlimited access: * โœ… **Access all folders** - View any investigation regardless of service * โœ… **View all documents** - Read all case files across services * โœ… **Issue warrants** - Create and sign arrest/search warrants * โœ… **Sign warrants** - Approve warrants created by police * โœ… **Manage all records** - Edit criminal records ## Complete Configuration Example Here's a complete example with multiple services: ```lua Services = { -- Police Services { name = "LSPD", fullName = "Los Santos Police Department", isJustice = false }, { name = "LSSD", fullName = "Los Santos Sheriff's Department", isJustice = false }, { name = "SAHP", fullName = "San Andreas Highway Patrol", isJustice = false }, { name = "FIB", fullName = "Federal Investigation Bureau", isJustice = false }, -- Justice Services { name = "DOJ", fullName = "Department of Justice", isJustice = true }, } ``` ## Best Practices โœ… **Do:** * Use clear, recognizable service codes (`LSPD`, `SAHP`, etc.) * Have at least one justice service for warrant management * Keep service names consistent with your server's departments โŒ **Don't:** * Use duplicate service names * Give `isJustice = true` to police services * Use special characters in the `name` field * Change service names after data has been created ## Adding a New Service To add a new service to your server: 1. Copy an existing service block 2. Change the `name` to a unique identifier 3. Update the `fullName` to the full service name 4. Set appropriate permission values 5. Set `isJustice` to `true` or `false` 6. Add it to the `Services` table **Example - Adding a Park Ranger service:** ```lua { name = "PARK", fullName = "San Andreas Park Rangers", isJustice = false } ``` *** Need help? Visit our [Support page](/paid-scripts/madonnedoj/support). # Permissions System ## Overview The mg-dojscript permission system allows granular access control for each service. It uses a **bit flags** system to optimize storage and permission checks. ## Accessing the Permissions Page
The permissions management page is accessible via: * Open your service page * Click on role management button ## Available Permissions List The system has **10 distinct permissions**: | Permission | Description | | --------------------- | ----------------------------------------------- | | `MANAGE_FOLDERS` | Create and edit investigations | | `MANAGE_DOCUMENTS` | Create and edit documents | | `MANAGE_WARRANTS` | Create and edit warrants | | `ISSUE_WARRANTS` | Issue/send warrants (Justice only) | | `MANAGE_EXAMINATIONS` | Create and edit examinations | | `MANAGE_REQUESTS` | Manage requests (currently disabled) | | `MANAGE_RECORDS` | Edit criminal records | | `MANAGE_SERVICES` | Manage membership requests and service settings | | `MANAGE_VIOLATIONS` | Create and edit violations | | `ARCHIVE_FOLDERS` | Archive investigations (Justice only) | {% hint style="danger" %} DON'T FORGET TO SAVE {% endhint %} ## Management Interface ### Features #### 1. Adding Roles * Maximum **6 custom roles** per service * The `USER` role is permanent and cannot be deleted * Unique name validation #### 2. Editing Roles * Rename existing roles (except `USER`) * Modify permissions via checkboxes * Deletion possible (except `USER`) #### 3. Permission Management * Table interface with: * **Rows**: List of 10 permissions * **Columns**: Service roles * Checkboxes to enable/disable each permission #### 4. Smart Save During save: **a) Automatic User Synchronization** * Users whose role was deleted are demoted to `USER` role * Users keep their role if it still exists * Automatic update of permission values if modified **b) Service Chiefs Update** * Chiefs automatically receive the **highest role** (highest permission value) * Ensures chiefs always have maximum access **c) Change Propagation** * Changes are sent to the server * Cascading update of service, users, and chiefs # Adding a New Language This guide will walk you through adding a new language translation to Madonne DOJ. Whether you want to add Spanish, German, Portuguese, or any other language, follow these steps. ## Overview Adding a new language involves: 1. Creating translation files 2. Translating all text strings 3. Configuring the script to use your language ## Step-by-Step Guide ### Step 1: Choose Your Language Code Use the standard ISO 639-1 two-letter language code: | Language | Code | | ---------- | ---- | | Spanish | `es` | | German | `de` | | Italian | `it` | | Portuguese | `pt` | | Dutch | `nl` | | Polish | `pl` | | Russian | `ru` | | Turkish | `tr` | For this example, we'll add **Spanish** (`es`). ### Step 2: Create Translation Files You need to create the translation file in the production folder: ``` /ui/locales/es.json ``` **How to create it:** 1. Navigate to `/ui/locales/` 2. Copy the existing `en.json` file 3. Rename the copy to `es.json` (or your language code) {% hint style="info" %} **Tip:** Start with `en.json` as it's usually more up-to-date than `fr.json`. {% endhint %} ### Step 3: Translate the Content Open your new `es.json` file and translate **only the values**, not the keys. #### Translation Example **Before (English):** ```json { "COMPONENTS": { "DASHBOARD": { "NAME": "Dashboard", "MY_DOCUMENTS": "My documents", "MY_FOLDERS": "My investigations" } } } ``` **After (Spanish):** ```json { "COMPONENTS": { "DASHBOARD": { "NAME": "Panel de control", "MY_DOCUMENTS": "Mis documentos", "MY_FOLDERS": "Mis investigaciones" } } } ``` {% hint style="danger" %} **Important:** Never modify the keys (left side), only translate the values (right side)! {% endhint %} ### Step 4: Full Translation Template Here's a complete translation structure for reference:
Complete JSON Structure (click to expand) ```json { "COMPONENTS": { "CREATOR": { "DOCUMENTS": "Documento", "EXAMINATIONS": "Interrogatorio", "FOLDERS": "Investigaciรณn", "INSERT_DESCRIPTION": "Insertar descripciรณn...", "NAME": "nuevo elemento", "RECORDS": "ciudadano", "WARRANTS": "Orden judicial" }, "DASHBOARD": { "MY_DOCUMENTS": "Mis documentos", "MY_EXAMINATIONS": "Mis interrogatorios", "MY_FOLDERS": "Mis investigaciones", "NAME": "Panel de control" }, "DOCUMENTS": { "DATE": "Fecha", "DESCRIPTION": "Descripciรณn", "EMPTY": "No hay documentos", "EMPTY_DESCRIPTION": "Sin descripciรณn", "FOLDER": "Invest.", "IN_CHARGE": "Oficiales a cargo", "NAME": "Documentos", "TITLE": "Nombre" }, "EXAMINATIONS": { "DATE": "Fecha", "DESCRIPTION": "Descripciรณn", "EMPTY": "No hay interrogatorios", "EMPTY_DESCRIPTION": "Sin descripciรณn", "FOLDER": "Invest.", "IN_CHARGE": "Oficiales a cargo", "NAME": "Interrogatorios", "TITLE": "Nombre" }, "FOLDERS": { "DATE": "Fecha", "DESCRIPTION": "Descripciรณn", "EMPTY": "No hay investigaciones", "EMPTY_DESCRIPTION": "Sin descripciรณn", "IN_CHARGE": "Oficiales a cargo", "IN_CHARGE_SERVICES": "Servicios a cargo", "NAME": "Investigaciones", "SEARCH": { "NOT_FOUND": "ยกNo se encontraron resultados!", "PLACEHOLDER": "Buscar investigaciones..." }, "TITLE": "Tรญtulo" }, "WARRANTS": { "DATE": "Fecha", "NAME": "ร“rdenes judiciales", "STATUS": "Estado", "TITLE": "Tรญtulo", "TYPE": "Tipo" }, "RECORDS": { "NAME": "Antecedentes", "SEARCH": "Buscar ciudadano..." }, "VIOLATIONS": { "NAME": "Infracciones", "CATEGORY": "Categorรญa", "FINE": "Multa", "JAIL_TIME": "Tiempo de prisiรณn" }, "SERVICES": { "NAME": "Servicios", "MEMBERS": "Miembros", "PENDING": "Pendientes" } }, "GENERIC": { "SAVE": "Guardar", "CANCEL": "Cancelar", "DELETE": "Eliminar", "EDIT": "Editar", "CREATE": "Crear", "SEARCH": "Buscar...", "LOADING": "Cargando...", "UNKNOWN_DATE": "Fecha desconocida", "CONFIRM": "Confirmar", "CLOSE": "Cerrar" }, "DATE_FORMAT": "dd/MM/yyyy" } ```
### Step 5: Configure Date Format The `DATE_FORMAT` key controls how dates are displayed. Use the format that's common in your region: | Region | Format | Example | | ------ | ------------ | ---------- | | Europe | `dd/MM/yyyy` | 25/12/2024 | | USA | `MM/dd/yyyy` | 12/25/2024 | | ISO | `yyyy-MM-dd` | 2024-12-25 | **Spanish example:** ```json { "DATE_FORMAT": "dd/MM/yyyy" } ``` ### Step 6: Configure in config.lua Update your `config.lua` to use the new language: ```lua CONFIG_MADONNE_DOJ = { LocaleUi = "es", -- Your new language code -- ... rest of config } ``` ### Step 7: Test Your Translation 1. **Restart the script:** ``` restart MS_MaodonneDOJ ``` 2\. **Open the tablet:** ``` /tablet ``` 3\. **Check all sections:** * Dashboard * Investigations * Documents * Warrants * Examinations * Records * Violations * Services 4. **Look for:** * Missing translations (English text appearing) * Truncated text (too long for buttons) * Special characters not displaying correctly * Context issues (wrong meaning) ## Translation Checklist Use this checklist to ensure complete translation: * [ ] All `COMPONENTS.*` sections translated * [ ] All `GENERIC.*` actions translated * [ ] `DATE_FORMAT` set appropriately * [ ] Special characters display correctly * [ ] Text fits in UI elements (not truncated) * [ ] Context is correct (meanings are accurate) * [ ] Empty state messages translated * [ ] Error messages translated * [ ] Tested all interface sections * [ ] Config.lua updated with language code ## Common Translation Keys Here are the most important keys to translate: ### User Actions ```json { "GENERIC": { "SAVE": "...", "CANCEL": "...", "DELETE": "...", "EDIT": "...", "CREATE": "...", "CONFIRM": "..." } } ``` ### Section Names ```json { "COMPONENTS": { "DASHBOARD": { "NAME": "..." }, "FOLDERS": { "NAME": "..." }, "DOCUMENTS": { "NAME": "..." }, "WARRANTS": { "NAME": "..." }, "EXAMINATIONS": { "NAME": "..." }, "RECORDS": { "NAME": "..." }, "VIOLATIONS": { "NAME": "..." }, "SERVICES": { "NAME": "..." } } } ``` ### Empty States ```json { "COMPONENTS": { "FOLDERS": { "EMPTY": "..." }, "DOCUMENTS": { "EMPTY": "..." }, "EXAMINATIONS": { "EMPTY": "..." } } } ``` ## Tips for Quality Translation ### Context Matters Some words have different meanings in different contexts. View the interface to understand: * Is "Record" a verb (to record) or noun (a record)? * Is "File" a document or an action (to file)? * Is "Warrant" singular or can it be plural? ### Keep It Concise UI translations should be: * โœ… Short and clear * โœ… Easy to understand * โœ… Consistent in terminology * โŒ Not overly formal (unless appropriate) * โŒ Not too long for buttons ### Test on Different Screen Sizes Some languages are more verbose than others: * German translations are typically 30% longer than English * Spanish translations are typically 20-25% longer * Make sure text doesn't overflow on smaller screens ## Sharing Your Translation If you've created a translation for a new language: 1. **Test it thoroughly** 2. **Join our Discord** - 3. **Share your translation** - We can include it in future releases! 4. **Get credited** - Your name in the documentation ## Troubleshooting ### Text appears in English instead of my language * โœ… Check the file name matches your `LocaleUi` setting * โœ… Verify the JSON syntax is valid (no missing commas, brackets) * โœ… Ensure the file is in the correct folder (`/ui/locales/`) * โœ… Restart the script ### Special characters don't display correctly * โœ… Save the file with UTF-8 encoding * โœ… Don't use HTML entities (use actual characters) * โœ… Test with various special characters (รฉ, รฑ, รผ, etc.) ### JSON syntax errors * โœ… Use a JSON validator (like jsonlint.com) * โœ… Check for missing commas between items * โœ… Ensure all quotes are properly closed * โœ… Watch for trailing commas (not allowed in JSON) ### Text is cut off in the UI * โœ… Shorten the translation * โœ… Use abbreviations where appropriate * โœ… Check on different screen resolutions ## Example: Complete Spanish Translation Here's a real working example for Spanish: ```json { "COMPONENTS": { "CREATOR": { "DOCUMENTS": "Documento", "EXAMINATIONS": "Interrogatorio", "FOLDERS": "Investigaciรณn", "INSERT_DESCRIPTION": "Insertar descripciรณn...", "NAME": "nuevo elemento", "RECORDS": "ciudadano", "WARRANTS": "Orden" }, "DASHBOARD": { "MY_DOCUMENTS": "Mis documentos", "MY_EXAMINATIONS": "Mis interrogatorios", "MY_FOLDERS": "Mis investigaciones", "NAME": "Panel" } }, "GENERIC": { "SAVE": "Guardar", "CANCEL": "Cancelar", "DELETE": "Eliminar", "EDIT": "Editar", "SEARCH": "Buscar..." }, "DATE_FORMAT": "dd/MM/yyyy" } ``` ## Next Steps After adding your language: * [Configuration](/paid-scripts/madonnedoj/configuration) - Set up your server * [Usage Guide](/paid-scripts/madonnedoj/usage) - Learn the interface * [Support](/paid-scripts/madonnedoj/support) - Get help if needed *** Created a translation? Share it with the community on our [Discord](https://discord.gg/madonne)! # Need Help? Having trouble with Madonne DOJ? We're here to help! This page provides various support resources and troubleshooting guidance. ## Before Requesting Support Before reaching out for help, please try these steps: ### 1. Check the Documentation * โœ… Read relevant documentation sections * โœ… Search for your specific issue * โœ… Review configuration examples ### 2. Enable Debug Mode Enable debug mode to see detailed error messages: ```lua CONFIG_MADONNE_DOJ = { DebugMode = true, -- Enable this } ``` Then restart the script: ``` restart MS_MaodonneDOJ ``` ### 3. Check Server Console Press **F8** in-game to open the console and look for: * โŒ Red error messages * โš ๏ธ Yellow warnings * ๐Ÿ” Debug information (if enabled) ### 4. Reproduce the Issue Try to reproduce the problem: 1. Note the exact steps that cause the issue 2. Check if it happens every time 3. Test with different users/roles 4. Document what you were trying to do *** ## Common Issues ### Installation Issues
Script won't start / Database errors **Symptoms:** * Script fails to load * SQL errors in console * Missing tables **Solutions:** 1. โœ… Verify `db.sql` was imported correctly 2. โœ… Check database credentials in your framework 3. โœ… Ensure all tables were created 4. โœ… Check for table name conflicts
Tablet command doesn't work **Symptoms:** * `/tablet` command doesn't respond * No interface opens **Solutions:** 1. โœ… Verify command in `config.lua` 2. โœ… Check if player is assigned to a service 3. โœ… Look for errors in console (F8) 4. โœ… Ensure script is started after framework
### Configuration Issues
Permissions not working correctly **Symptoms:** * Users have wrong permissions * Sections not visible * Can't perform actions **Solutions:** 1. โœ… Recalculate permission values 2. โœ… Verify service configuration 3. โœ… Check role assignments
Language not changing **Symptoms:** * UI still in wrong language * Translations not appearing **Solutions:** 1. โœ… Check `LocaleUi` value in `config.lua` 2. โœ… Verify language file exists in `/ui/locales/` 3. โœ… Ensure JSON syntax is valid 4. โœ… Restart the script 5. โœ… Clear browser cache (Ctrl+F5)
### Usage Issues
Can't create investigations/documents **Symptoms:** * Create button not visible * Nothing happens when clicking create * Save fails **Solutions:** 1. โœ… Check your permissions 2. โœ… Ensure you're assigned to a service 3. โœ… Fill all required fields 4. โœ… Check console for errors
Warrants not being issued **Symptoms:** * Can't sign warrants * Issue button not available **Solutions:** 1. โœ… Only justice services can issue warrants 2. โœ… Verify `isJustice = true` in config 3. โœ… Check if user has `ISSUE_WARRANTS` permission (or is justice) 4. โœ… Ensure warrant is properly filled out
Discord webhook not working **Symptoms:** * No notifications in Discord * Webhook errors in console **Solutions:** 1. โœ… Verify webhook URL is correct 2. โœ… Check Discord server settings 3. โœ… Ensure webhook wasn't deleted 4. โœ… Test with a simple message 5. โœ… Check firewall settings
### Performance Issues
Tablet is slow/laggy **Symptoms:** * Interface loads slowly * Actions take long time * Freezing **Solutions:** 1. โœ… Check server performance 2. โœ… Optimize database queries 3. โœ… Reduce number of records 4. โœ… Check client-side performance 5. โœ… Clear browser cache
*** ## FAQ ### Can I modify the script? Depends on your license. Check your purchase agreement. Generally: * โœ… You can modify for your server * โŒ You cannot resell or redistribute * โŒ You cannot share modifications publicly ### Can I use this with QBCore? The script may need adaptation for QBCore. Check with support for compatibility. ### How many services can I add? There's no hard limit, but practical considerations: * Keep it reasonable (5-15 services typical) * Too many services can clutter the interface * Consider database performance with many services ### Can players change language individually? No, language is server-wide. All players see the same language configured in `config.lua`. ### Do I need to know coding to use this? Basic knowledge helps for configuration, but: * Installation is straightforward * Configuration uses simple Lua * No coding needed for daily use * Support available if you get stuck ### How often is the script updated? Updates are released for: * Bug fixes (as needed) * New features (periodically) * Security patches (immediately) * Check Discord for announcements *** **Thank you for using Madonne DOJ!** We're committed to providing the best law enforcement management system for FiveM. *Developed by M\_g for MadonneStudio ยฉ 2025 - All rights reserved* # Madonne Seasons Change the way weather and time are handled on your FiveM server. **Madonne Seasons** brings a fully dynamic, realistic, and configurable weather and time system โ€” with seasonal cycles, per-zone weather, AI-powered forecasts, and much more. {% embed url="" %} *** ## ๐Ÿ“– About Madonne Seasons Madonne Seasons replaces GTA V's default static weather system with a living, breathing environment. Weather evolves dynamically over time, follows realistic transition rules, and varies by geographic zone across the map. Days are longer in summer, shorter in winter, and the sun rises and sets accordingly. ## โœจ Main Features * ๐Ÿ—“๏ธ **Seasonal Cycle** โ€” Four seasons (Spring, Summer, Autumn, Winter) with configurable real-time duration (days, weeks, months) * ๐ŸŒ **Per-Zone Weather** โ€” The map is divided into 7+ geographic zones, each with its own weather probabilities per season * โฑ๏ธ **Realistic Time System** โ€” Day/night cycle with variable speed: days are longer or shorter depending on the current season * โ˜€๏ธ **Dynamic Sunrise & Sunset** โ€” Sunrise and sunset hours shift throughout the year based on seasonal progression * ๐ŸŒค๏ธ **Dynamic Weather Transitions** โ€” Weather changes follow realistic transition rules (e.g. RAIN โ†’ THUNDER โ†’ CLEARING) * ๐Ÿ“ป **Weather Forecast System** โ€” Players can request tomorrow's weather forecast via a command, delivered as an audio broadcast * ๐Ÿค– **AI-Powered Forecasts** โ€” Optional OpenAI integration generates unique, voiced weather bulletins in any language using GPT-4o-mini and TTS * ๐Ÿ” **Flexible Permission System** โ€” Supports ACE, Steam, MadonnAdmin, or a fully custom permission handler * ๐Ÿ”” **Notification System** โ€” Compatible with `default`, `chat`, `MS_Madonne_Notify`, or a custom handler * ๐Ÿ“ฑ **LB Phone Compatibility** โ€” Native integration with the LB Phone weather app for consistent time, temperature, forecasts, precipitation, and sun times * ๐Ÿงฉ **Developer Exports** โ€” `GetZonePredictions` and `GetSunTimes` exports for integration with other resources *** ## ๐Ÿ”— Quick Links * [๐Ÿ“ฅ Installation](/paid-scripts/madonne-seasons/installation) * [โš™๏ธ Configuration](/paid-scripts/madonne-seasons/configuration) * [๐Ÿ’ป Commands](/paid-scripts/madonne-seasons/commands) * [๐Ÿงฉ Exports & Events](/paid-scripts/madonne-seasons/exports-and-events) * [๐Ÿ“ฑ Compatibility](/paid-scripts/madonne-seasons/compatibility) * [โ“ Common Errors](/paid-scripts/madonne-seasons/common-errors) # Installation ## ๐Ÿ“‹ Requirements * A **FiveM server** running on artifact `2699` or above * *(Optional)* `MS_Madonne_Notify` for enhanced notifications * *(Optional)* An **OpenAI API key** if using AI-powered forecast generation * *(Optional)* `lb-phone` if using the LB Phone weather app integration *** ## โฌ‡๏ธ Step 1 โ€” Download the resource Download the latest version of **MS\_Madonne\_Seasons** from the [CFX Portal](https://portal.cfx.re/), the official Cfx.re platform for downloading your purchased resources. > ๐Ÿ’ก You must be logged in with the account used to purchase the resource. *** ## ๐Ÿ“ Step 2 โ€” Add to your server Copy the `MS_Madonne_Seasons` folder into your server's **resources directory**. ``` your-server/ โ””โ”€โ”€ resources/ โ””โ”€โ”€ MS_Madonne_Seasons/ โ”œโ”€โ”€ client/ โ”œโ”€โ”€ server/ โ”‚ โ””โ”€โ”€ custom/ โ”œโ”€โ”€ ui/ โ”œโ”€โ”€ config.lua โ””โ”€โ”€ fxmanifest.lua ``` *** ## ๐Ÿ“ Step 3 โ€” Add to server.cfg Add the following line to your `server.cfg`: ```cfg ensure MS_Madonne_Seasons ``` If you plan to use **AI-powered forecasts**, also add your OpenAI API key: ```cfg set openai_key "sk-your-openai-api-key-here" ``` > โš ๏ธ Make sure `MS_Madonne_Seasons` is started **after** any notification resource it depends on (`MS_Madonne_Notify`, etc.). *** ## โš™๏ธ Step 4 โ€” Configure the resource Open `config.lua` and configure the resource to match your server setup. Refer to the [โš™๏ธ Configuration](/paid-scripts/madonne-seasons/configuration) page for a full breakdown of every option. *** ## ๐Ÿ”„ Step 5 โ€” Restart your server Restart your server or run the following command in the console: ``` restart MS_Madonne_Seasons ``` Madonne Seasons is now active! โœ… *** ## ๐Ÿ“ฑ Step 6 โ€” LB Phone integration *(optional)* If you use **lb-phone** and want the weather app to reflect Madonne Seasons data, refer to the [๐Ÿ“ฑ Compatibility](/paid-scripts/madonne-seasons/compatibility) page for the two files to edit. # Configuration All configuration is done in `config.lua`, which is not escrowed and can be freely edited. *** ## ๐Ÿ” Permission System ```lua PERMISSION_SYSTEM = "none", ``` | Value | Description | | --------------- | ------------------------------------------------------------------------ | | `"none"` | All players can use admin commands. Recommended only for testing. | | `"ace"` | Uses FiveM's ACE permission system with configurable permission nodes | | `"steam"` | Restricts access to a list of Steam identifiers defined in `ADMIN_USERS` | | `"madonnadmin"` | Uses MadonnAdmin staff rank detection | | `"custom"` | Uses your own logic defined in `server/custom/sv_permission.lua` | **ACE permission nodes** (when `PERMISSION_SYSTEM = "ace"`): ```lua ACE_PERMISSION = { ["DynamicWeather"] = "madonne.dynweather", ["ChangeWeather"] = "madonne.changeweather", ["NextWeather"] = "madonne.nextweather", ["FreezeTime"] = "madonne.freezetime", ["ChangeTime"] = "madonne.changetime", }, ``` Grant them in your `server.cfg`: ```cfg add_ace group.admin madonne.dynweather allow add_ace group.admin madonne.changeweather allow add_ace group.admin madonne.nextweather allow add_ace group.admin madonne.freezetime allow add_ace group.admin madonne.changetime allow ``` **Steam whitelist** (when `PERMISSION_SYSTEM = "steam"`): ```lua ADMIN_USERS = { ["steam:1100001000056ba"] = true, }, ``` *** ## ๐Ÿ”” Notification System ```lua NOTIFICATION_SYSTEM = "default", ``` | Value | Description | | ----------- | ---------------------------------------------------------------- | | `"default"` | Uses the native GTA V notification | | `"chat"` | Sends notifications as a chat message | | `"madonne"` | Uses MS\_Madonne\_Notify | | `"custom"` | Uses your custom handler in `server/custom/sv_notifications.lua` | *** ## ๐Ÿ—“๏ธ Seasons ```lua SEASONS_NAMES = { SPRING = "Spring", SUMMER = "Summer", AUTUMN = "Autumn", WINTER = "Winter", }, ``` Customize the display names of each season. These names are used in the `/season` command response and in AI-generated forecasts. *** ## โฑ๏ธ Time & Season Length | Option | Example values | Description | | ------------- | ----------------------- | -------------------------------------------------------------------------------------------------- | | `YEAR_LENGTH` | `"2w"`, `"1mo"`, `"3d"` | Real-time duration of a full four-season cycle. Accepts days (`d`), weeks (`w`), or months (`mo`). | | `DAY_LENGTH` | `"48m"`, `"1h"` | Real-time duration of a full in-game day. Accepts minutes (`m`) or hours (`h`). Default: `"48m"`. | > ๐Ÿ’ก A `YEAR_LENGTH` of `"2w"` means one full year (all four seasons) passes in 2 real-world weeks. *** ## ๐ŸŒค๏ธ Dynamic Weather ```lua DYNAMIC_WEATHER = true, WEATHER_DELAY = 10, ``` | Option | Type | Description | | ----------------- | --------- | ------------------------------------------------------------------------------------------------ | | `DYNAMIC_WEATHER` | `boolean` | Enable or disable automatic weather changes. Can also be toggled in-game with `/dynamicweather`. | | `WEATHER_DELAY` | `number` | Time in **minutes** between each automatic weather change. | *** ## ๐Ÿ“ป Forecast System | Option | Type | Description | | ------------------------ | --------- | -------------------------------------------------------------------------------------------------------------------- | | `FORCAST_ENABLED` | `boolean` | Enable the `/forcast` command and forecast system | | `FORCAST_OPENAI` | `boolean` | Use OpenAI to generate a unique AI-voiced weather bulletin. Requires `openai_key` in `server.cfg`. | | `FORCAST_OPENAI_ALL_MAP` | `boolean` | If `true`, the AI bulletin also covers all other zones of the map, not just the player's zone | | `FORCAST_OPENAI_VOICE` | `string` | OpenAI TTS voice to use. Available: `alloy`, `fable`, `onyx`, `nova`. Preview at [openai.fm](https://www.openai.fm/) | | `FORCAST_LANGUAGE` | `string` | Language folder to use for pre-recorded forecasts (e.g. `"FR"`, `"EN"`). Only used when `FORCAST_OPENAI` is `false`. | | `FORCAST_VOLUME` | `number` | Playback volume of the forecast audio (`0.0` to `1.0`) | > โš ๏ธ AI forecast generation costs approximately **$0.001 per forecast** via the OpenAI API. This is not a MadonneStudio cost โ€” it is billed directly to your OpenAI account. **Pre-recorded forecasts** are available for the following weather types, in both `FR` and `EN`: `BLIZZARD` ยท `CLEAR` ยท `CLEARING` ยท `CLOUDS` ยท `EXTRASUNNY` ยท `FOGGY` ยท `NEUTRAL` ยท `OVERCAST` ยท `RAIN` ยท `SMOG` ยท `SNOW` ยท `SNOWLIGHT` ยท `THUNDER` > ๐Ÿ’ก You can add new language folders by placing `.ogg` files in `ui/forcasts/YOUR_LANGUAGE/` and registering them in `fxmanifest.lua`. *** ## ๐ŸŒ Weather Zones The map is divided into named zones, each with its own set of weather probabilities for each season. Each zone is identified by a list of GTA V **zone codes** (`ZoneCodes`). ```lua WEATHER_ZONES = { ["Los Santos"] = { ZoneCodes = { ["DOWNT"] = true, ["HAWICK"] = true, ... }, SpringWeather = { ["CLEAR"] = 20, ["RAIN"] = 10, ... }, SummerWeather = { ["CLEAR"] = 30, ["EXTRASUNNY"] = 30, ... }, AutumnWeather = { ... }, WinterWeather = { ... }, }, ... ["Default"] = { ... } } ``` **Included zones out of the box:** | Zone | Description | | --------------------- | ----------------------------------------------------- | | `Los Santos` | The entire city of Los Santos and its surroundings | | `Costal Beaches` | Coastal and beach areas south of Los Santos | | `Los Santos Hills` | Hilly areas around Vinewood and Tongva Valley | | `Grand Senora Desert` | The desert region around Sandy Shores | | `Northern Moutains` | Mount Gordo, Mount Chiliad, and surrounding highlands | | `Zancudo` | Fort Zancudo area and Lago Zancudo | | `Paleto Bay` | The northern coastal town and surrounding forests | | `Default` | Fallback zone for any area not matched by the above | **Weather probabilities** are defined as weights โ€” the higher the number, the more likely that weather type is to appear. They do not need to sum to 100. *** ## โ˜๏ธ Cloud Opacity ```lua CLOUD_OPACITY = { ["CLEAR"] = 0.0, ["RAIN"] = 1.0, ["EXTRASUNNY"] = 0.5, ... } ``` Controls the cloud layer opacity for each weather type. Values range from `0.0` (no clouds) to `1.0` (full cloud cover). These are applied automatically when weather changes. *** ## ๐Ÿ’ฌ Commands & Text All command names and notification texts can be customized in `config.lua`: ```lua COMMANDS = { DynamicWeather = "dynamicweather", FreezeTime = "freezetime", Forcast = "forcast", ChangeWeather = "changeweather", ChangeTime = "changetime", NextWeather = "nextweather", Season = "season", ... } TEXT = { Enabled = "ENABLED !", Disabled = "DISABLED !", NoPermission = "You do not have permission to do that !", WeatherChangedTo = "Weather is successfully changed to : ", TimeChangedTo = "Time is successfully changed to : ", Season = "We are actually in ", WaitForForcast = "You will receive your weather forcast in few seconds. Please wait...", ... } ``` *** ## ๐Ÿ”ง Custom Handlers **Custom permissions** โ€” `server/custom/sv_permission.lua`: ```lua function IsAllowedToAccessStaffCommandFromCustomMethod(source) -- Return true to grant access, false to deny end ``` **Custom notifications** โ€” `server/custom/sv_notifications.lua`: ```lua function CustomNotify(type, message, source) -- type can be: "error", "info", "success" end ``` # Commands All command names can be customized in the `COMMANDS` table in `config.lua`. *** ## ๐ŸŒค๏ธ Weather Commands ### /changeweather `` Forces the weather to a specific type in the player's current zone. ``` /changeweather RAIN /changeweather EXTRASUNNY /changeweather THUNDER ``` **Available weather types:** | Type | Available | | ------------ | ------------------------------------------------------------------------------ | | `BLIZZARD` | โœ… | | `CLEAR` | โœ… | | `CLEARING` | โœ… | | `CLOUDS` | โœ… | | `EXTRASUNNY` | โœ… | | `FOGGY` | โœ… | | `NEUTRAL` | โœ… | | `OVERCAST` | โœ… | | `RAIN` | โœ… | | `SMOG` | โœ… | | `THUNDER` | โœ… | | `SNOW` | โŒ *(disabled by default โ€” edit `WeatherUsableInCommands` in config to enable)* | | `SNOWLIGHT` | โŒ | | `XMAS` | โŒ | > ๐Ÿ” Requires the `ChangeWeather` permission. *** ### /nextweather Forces an immediate transition to the next weather in the current prediction cycle, skipping the current `WEATHER_DELAY` timer. > ๐Ÿ” Requires the `NextWeather` permission. *** ### /dynamicweather Toggles automatic weather changes on or off. When disabled, weather remains static until manually changed. > ๐Ÿ” Requires the `DynamicWeather` permission. *** ## โฑ๏ธ Time Commands ### /freezetime Toggles time progression. When frozen, the in-game clock stops advancing. > ๐Ÿ” Requires the `FreezeTime` permission. *** ### /changetime `` Sets the in-game time to a specific hour and minute. ``` /changetime 08:30 /changetime 22:00 ``` > ๐Ÿ” Requires the `ChangeTime` permission. *** ## ๐Ÿ“‹ Information Commands ### /season Displays the current in-game season (Spring, Summer, Autumn, or Winter) as configured in `SEASONS_NAMES`. > ๐Ÿ”“ Available to all players. *** ### /forcast Requests a weather forecast for the player's current zone. The forecast covers the next 24 hours and is delivered as an **audio broadcast**. * If `FORCAST_OPENAI` is enabled, a unique AI-generated voice bulletin is produced in the configured language. * If disabled, a pre-recorded `.ogg` file is played based on the predicted weather type. > ๐Ÿ”“ Available to all players. Requires `FORCAST_ENABLED = true` in config. *** ## ๐Ÿ” Permission Reference | Command | Permission key | | ----------------- | ----------------- | | `/dynamicweather` | `DynamicWeather` | | `/changeweather` | `ChangeWeather` | | `/nextweather` | `NextWeather` | | `/freezetime` | `FreezeTime` | | `/changetime` | `ChangeTime` | | `/season` | *(none โ€” public)* | | `/forcast` | *(none โ€” public)* | # Exports & Events Madonne Seasons exposes client-side exports and NetEvents to allow other resources to integrate with its weather and time data. *** ## ๐Ÿ“ค GetZonePredictions *(client-side)* Returns the weather prediction list for a given GTA V zone code. ```lua local predictions = exports['MS_Madonne_Seasons']:GetZonePredictions(zone) ``` | Parameter | Type | Description | | --------- | -------- | --------------------------------------------------------- | | `zone` | `string` | A GTA V zone code (e.g. `"DOWNT"`, `"SANDY"`, `"PALETO"`) | **Returns:** A table of upcoming weather types in order, indexed from `1` to N (where N = number of weather slots for the day). ### Example ```lua local playerCoords = GetEntityCoords(PlayerPedId()) local zone = GetNameOfZone(playerCoords.x, playerCoords.y, playerCoords.z) local predictions = exports['MS_Madonne_Seasons']:GetZonePredictions(zone) for i, weather in ipairs(predictions) do print("Slot " .. i .. ": " .. weather) end ``` *** ## โ˜€๏ธ GetSunTimes *(client-side)* Returns the current sunrise and sunset hours, which vary dynamically with the season. ```lua local sunTimes = exports['MS_Madonne_Seasons']:GetSunTimes() -- Returns: { sunrise = 6.5, sunset = 20.3 } ``` **Returns:** A table with two keys: | Key | Type | Description | | --------- | -------- | --------------------------------- | | `sunrise` | `number` | Sunrise hour (e.g. `6.5` = 6h30) | | `sunset` | `number` | Sunset hour (e.g. `20.3` = 20h18) | ### Example ```lua local sunTimes = exports['MS_Madonne_Seasons']:GetSunTimes() print("Sunrise at " .. sunTimes.sunrise .. "h") print("Sunset at " .. sunTimes.sunset .. "h") ``` *** ## ๐Ÿ“ก NetEvents ### MadonneSeasons:SyncWeathers *(client)* Fired when weather data is synced to the client (on spawn and on each weather change). ```lua RegisterNetEvent("MadonneSeasons:SyncWeathers") AddEventHandler("MadonneSeasons:SyncWeathers", function(data) -- data = { ["Los Santos"] = "CLEAR", ["Grand Senora Desert"] = "EXTRASUNNY", ... } end) ``` *** ### MadonneSeasons:SyncPredictions *(client)* Fired alongside `SyncWeathers`, providing the full prediction table and sun times. ```lua RegisterNetEvent("MadonneSeasons:SyncPredictions") AddEventHandler("MadonneSeasons:SyncPredictions", function(predictions, sunrise, sunset) -- predictions = { ["Los Santos"] = { "CLEAR", "CLOUDS", "RAIN" }, ... } -- sunrise = 6.5, sunset = 20.3 end) ``` *** ### MadonneSeasons:SyncTime *(client)* Fired when time data is synced to the client. ```lua RegisterNetEvent("MadonneSeasons:SyncTime") AddEventHandler("MadonneSeasons:SyncTime", function(offset, base, daySpeed, nightSpeed, freeze) -- offset = time offset in minutes -- base = base time counter -- daySpeed = ticks per minute during daytime -- nightSpeed = ticks per minute during nighttime -- freeze = boolean, whether time is frozen end) ``` # Compatibility ## LB Phone โ€” Weather App Madonne Seasons is fully compatible with the **LB Phone** weather application. With the integration enabled, the phone's weather app will automatically reflect all data driven by Madonne Seasons in real time: * ๐ŸŒก๏ธ **Temperature** โ€” Coherent with the current weather type and season * ๐ŸŒฆ๏ธ **Current weather** โ€” Matches the weather currently active in the player's zone * ๐Ÿ“… **Upcoming forecasts** โ€” Displays the next weather predictions for the player's zone * ๐ŸŒง๏ธ **Precipitation** โ€” Updated based on the active weather * ๐ŸŒ… **Sunrise & sunset times** โ€” Dynamically computed based on the current season and year progression *** ### ๐Ÿ› ๏ธ How to Set Up the Integration Two files need to be edited inside the **lb-phone** resource. Both are located in the apps folder of the LB Phone resource. *** #### ๐Ÿ“„ File 1 โ€” `weather.lua` **Location:** `lb-phone > client > apps > default > weather.lua` This file handles the Lua-side logic that feeds weather data into the LB Phone app. Replace its content with the version provided below, which queries Madonne Seasons exports to retrieve the current weather, predictions, and sun times for the player's zone. > โš ๏ธ The exact implementation may vary depending on your version of lb-phone. Refer to the existing file to understand how data is passed to the NUI layer, and adapt accordingly. *** #### ๐Ÿ“„ File 2 โ€” `Weather-xxxx.js` **Location:** `lb-phone > ui > dist > assets > Weather-xxxx.js` > ๐Ÿ’ก The `xxxx` part of the filename is a hash that changes with each LB Phone update. Look for the file starting with `Weather-` in the assets folder. This file is the compiled JavaScript that handles the weather app's display logic. It needs to be updated to read the data provided by the modified `weather.lua`, including weather type mapping, temperature logic based on season, and precipitation values. > โš ๏ธ **This file is minified.** Editing it requires care. We recommend using your browser's developer tools or a code formatter to make the content readable before editing. The key parts to update are: * The **weather type mapping** โ€” so that GTA weather names (`EXTRASUNNY`, `RAIN`, etc.) correctly display the right icons and labels in the app UI * The **temperature calculation** โ€” to return values coherent with the current season and weather type (e.g. warmer in summer, colder in winter with snow) * The **forecast rendering** โ€” to display the `predictions` array from Madonne Seasons instead of the default LB Phone forecast data *** ### โš ๏ธ Important Notes * These changes need to be **reapplied after each LB Phone update**, as the compiled JS file is regenerated. * The `weather.lua` file may also be overwritten by updates to lb-phone. Keep a backup of your modified version. * If you need help adapting the integration to your specific version of lb-phone, feel free to reach out on our Discord. *** ## ๐Ÿ’ฌ Need Help? * ๐Ÿ’ฌ **Discord:** [discord.gg/madonne](https://discord.gg/madonne) * ๐ŸŒ **Website:** [madonnestudio.com](https://madonnestudio.com/) * ๐Ÿ“ง **Email:** # Common Errors ## ๐Ÿ”ด You lack the required entitlement to use MS\_Madonne\_Seasons This message indicates that your server does not have the necessary entitlement to start the resource. This is related to FiveM's **Escrow** protection system. Check the following points one by one: * โœ… The **CFX Portal key** listed in your `server.cfg` does not contain any typing error * โœ… The CFX Portal key belongs to the **FiveM account that was used to purchase or claim** the resource * โœ… The resource has been **successfully claimed** on the [CFX Portal](https://portal.cfx.re/) * โœ… The CFX Portal key linked to your server **belongs to you**, and not to your hosting provider > โš ๏ธ Some hosting providers include a shared CFX Portal key as part of their offers. A key that does not belong to you will block the use of **any Escrow-protected resource**, without exception. Always use your own personal key. *** ## ๐Ÿ”ด Weather is the same for all players / not changing **Cause 1:** `DYNAMIC_WEATHER` is set to `false` in `config.lua`. **Fix:** Set it to `true`, or toggle it in-game with `/dynamicweather`. **Cause 2:** `WEATHER_DELAY` is set to a very high value. **Fix:** Lower `WEATHER_DELAY` (in minutes) to make weather change more frequently. **Cause 3:** A player used `/dynamicweather` to disable automatic weather changes. **Fix:** Use `/dynamicweather` again in-game to re-enable it, or restrict access to the command via the permission system. *** ## ๐Ÿ”ด All players are in the same zone / per-zone weather isn't working **Cause:** Zone codes in `WEATHER_ZONES` don't match the actual GTA V zone codes for those areas. **Fix:** Verify zone codes using the `GetNameOfZone` native. You can test it in-game by printing the zone name in a script and checking which code is returned at your current position. *** ## ๐Ÿ”ด The `/forcast` command plays no audio **Cause 1:** `FORCAST_ENABLED` is set to `false`. **Fix:** Set `FORCAST_ENABLED = true` in `config.lua`. **Cause 2 (OpenAI):** The `openai_key` convar is missing or incorrect in `server.cfg`. **Fix:** Add or correct the following line in your `server.cfg`: ```cfg set openai_key "sk-your-openai-key-here" ``` **Cause 3 (OpenAI):** Your OpenAI account has no credits. **Fix:** Add credits to your OpenAI account at [platform.openai.com](https://platform.openai.com/). **Cause 4 (pre-recorded):** The `.ogg` file for the predicted weather type is missing in the selected language folder. **Fix:** Make sure all weather `.ogg` files exist under `ui/forcasts/YOUR_LANGUAGE/`. The required files are named after each weather type: `CLEAR.ogg`, `RAIN.ogg`, `THUNDER.ogg`, etc. *** ## ๐Ÿ”ด Time is not synced between players **Cause:** The `playerSpawned` event is not firing, preventing the sync request from being sent. **Fix:** Make sure no other resource is blocking or replacing the `playerSpawned` event. You can also try increasing the timeout in `cl_time.lua` if your server takes longer to spawn players. *** ## ๐Ÿ”ด Admin commands return "You do not have permission" **Cause:** The permission system is not configured correctly for your setup. **Fix:** Check your `PERMISSION_SYSTEM` setting and verify accordingly: * **ACE:** Confirm `add_ace` entries are in `server.cfg` and the player is in the correct group * **Steam:** Confirm the player's Steam hex ID is listed in `ADMIN_USERS` * **MadonnAdmin:** Confirm `MS_MadonnAdmin` is running and the player has a staff rank * **Custom:** Verify your `IsAllowedToAccessStaffCommandFromCustomMethod` function returns `true` for the player *** ## ๐Ÿ”ด Server console shows ERROR 0x01A or 0x01B These are configuration parsing errors: | Code | Cause | Fix | | ------- | ------------------------------- | ------------------------------------------------------------ | | `0x01A` | `YEAR_LENGTH` format is invalid | Use `"Nd"`, `"Nw"`, or `"Nmo"` format (e.g. `"2w"`, `"1mo"`) | | `0x01B` | `DAY_LENGTH` format is invalid | Use `"Nm"` or `"Nh"` format (e.g. `"48m"`, `"1h"`) | *** ## ๐Ÿ’ฌ Still having issues? * ๐Ÿ’ฌ **Discord:** [discord.gg/madonne](https://discord.gg/madonne) * ๐ŸŒ **Website:** [madonnestudio.com](https://madonnestudio.com/) * ๐Ÿ“ง **Email:** # Wearable Weapon Are you fed up with your shootouts always ending badly as weapons spawn in your player's hands when they come out of anywhere ? **MadonneStudio has the solution for you !**
Thanks to our script, you can limit the use of heavy weapons, but also add a feature that will allow your players to carry their weapons on their chest or on their back. The script therefore mainly allows you to force your players to retrieve an heavy weapon from the trunk of a vehicle before being able to use it.
### How to use it ? As you approch a vehicle, use the weapon wheel to select a heavy weapon. To redeposit th eweapon in a vehicle, equip yourself with the weapon, approach a vehicle again and equip yourself with a handgun or your fists. To store your weapon on your chest or on your back, just equip a handgun or your fists, while being away from a vehicle. To take the heavy weapon back in your hands, simply select it again in the weapon selection wheel.
{% hint style="info" %} If one of your moderation team members goes invisible (NoClip for example), the weapon hanging on the body will disappear while the person is invisible to other players. On the death of a player, if a weapon is attached to him, this last will fall to the ground before disappearing, but will not be recoverable by other players. {% endhint %} # Installation 1. After purchasing the resource on our store, log in to Fivem's KeyMaster site (). 2. In the menu on the left, go to **Granted Assets** located in the **Server Owners** section.
3. In the list of resources, select the Download button corresponding to Wearable Weapon. This will download you a .zip file.
4. Open the archive you just downloaded. There you will find a folder named **MS\_Wearable\_Weapons**. 5. Drag this folder into your server's resources folder. 6. Since the resource is already configured and ready to use, all you have to do is edit your server's configuration file (often caller *server.cfg*) and ad ensure *MS\_Wearable\_Weapons* at the bottom of it.
7. Start your server and enjoy your new script ! # Configuration The configuration file (named config.lua) allows you to modify all the different parameters taken into account within our script. In case of problems with the scripts, first check that you have correctly edited this document
Content of the configuration file by default ```lua CONFIG_WEARABLE_WEAPONS = { framework = "none", -- Accepted values : esx | none inventory = "none", -- Only if framework is not none. Accepted values : ox | none -- This option, if set to true, will force your players to retrieve the whitelist weapons from the trunk of a vehicle. heavyWeaponsFromCar = true, -- Accepted values : false | true UseNearestDoor = true, -- Only if HeavyWeaponsFromCar is TRUE. Accepted values : false | true PlayAnimation = true, -- Only if UserNearestDoor is TRUE. Accepted values : false | true -- This option allows you to list the different weapons that can be influenced by the script. Please follow the template below to add new weapons. weaponsAccepted = { -- Example : ["file_name"] = "WEAPON_ID", ["w_ar_carbinerifle"] = "WEAPON_CARBINERIFLE", ["w_ar_assaultrifle"] = "WEAPON_ASSAULTRIFLE", ["w_ar_bullpuprifle"] = "WEAPON_BULLPUPRIFLE", ["w_ar_advancedrifle"] = "WEAPON_ADVANCEDRIFLE", ["w_sb_assaultsmg"] = "WEAPON_ASSAULTSMG", ["w_sb_smg"] = "WEAPON_SMG", ["w_sb_smgmk2"] = "WEAPON_SMGMk2", ["w_sb_gusenberg"] = "WEAPON_GUSENBERG", ["w_mg_combatmg"] = "WEAPON_COMBATMG", ["w_sb_microsmg"] = "WEAPON_MICROSMG", ["w_sr_sniperrifle"] = "WEAPON_SNIPERRIFLE", ["w_sr_marksmanrifle"] = "WEAPON_MARKSMANRIFLE", ["w_sr_heavysniper"] = "WEAPON_HEAVYSNIPER", ["w_sg_assaultshotgun"] = "WEAPON_ASSAULTSHOTGUN", ["w_sg_bullpupshotgun"] = "WEAPON_BULLPUPSHOTGUN", ["w_sg_pumpshotgun"] = "WEAPON_PUMPSHOTGUN", ["w_ar_musket"] = "WEAPON_MUSKET", ["w_sg_heavyshotgun"] = "WEAPON_HEAVYSHOTGUN", ["w_ar_carbineriflemk2"] = "WEAPON_CARBINERIFLE_MK2", ["w_ar_specialcarbine"] = "WEAPON_SPECIALCARBINE" }, -- back_bone : 11816 = back | 24816 = front | 51826 = side attachedBones = { -- back_bone = { 11816 ,24816, 24816, 24816, 11816, 11816, 51826, 24816}, x = { -0.35 ,0.28, -0.02, -0.090, -0.22, -0.070, 0.15, -0.05}, y = { 0.18 ,-0.15, -0.05, -0.15, 0.17, 0.16, 0.07, -0.16}, z = { -0.05 ,0.02, 0.05, -0.080, -0.020, -0.030, 0.11, -0.14}, x_rotation = {360.0 ,0.0, -4.0, -180.0, 183.0, -183.0, -89.0, 0}, y_rotation = {-40.0 ,165.0, 47.0, -515.0, -538.0, -505.0, -540.0, -15}, z_rotation = {1.0 ,0.0, -534.3, -5.0, 0, 4.0, 2.0, -7} }, -- This option determines whether the weapon should be worn on the chest or on the back by default. default_position = 2, -- Accepted values : 1 (Chest) | 2 (Back) bags_can_contain_weapons = true, bags_eup = {41,45} -- Select whether or not the player can choose himself between placing his weapon on his back and placing his weapon on the chest. (Command to use : /weaponposition) playerCanChangePosition = true, -- Accepted values : false | true -- Here you can change the name of the command used to allow the player to choose the location of the weapon they will carry. (Default : weaponposition) (Used if playerCanChangePosition = true) commandUsedToChangePosition = "weaponposition", -- Accepted values : text (without the / ) -- Here you can change all settings about Drop Command and the ability to your player to drop a weapon at ground enableDropCommand = true, commandUsedToDropWeapon = "drop", msg_suggDrop = "Drop the weapon you are currently holding", dropAnimDict = "random@domestic", dropAnimName = "pickup_low", -- This command will allow you to debug your players in case of problems with the script. This will reset the state of the weapon port. commandUsedToDebugWeaponWearing = "debugweapon", -- Accepted values : text (without the / ) -- This prefix corresponds to the name that will be entered at the start of the notifications, related to this script, which will be displayed in the game. globalPrefix = "~r~[MyServer] ~c~", -- Accepted values : text globalPrefixBis = "MyServer", -- Accepted values : text -- Position of notifications. notifPos = "notification", -- Accepted values : notification | chat | other | none -- Notification : In bottom left corner, just on the map -- Chat : In the chat -- Other : Use a custom notifications system (see notif.lua) -- None : Desactivate notifications -- Change color of notification in case of notifPos = "chat" notifChatColor = {255,0,0}, -- Accepted values = RGB Color code = {R,G,B}, -- Message indicating to the player that he must be in front of a vehicle to be able to equip himself with the weapon he has selected. (Used if heavyWeaponsFromCar = true) msg_needCar = "You must be in front of a vehicle to take out this weapon.", -- Accepted values : text -- Message indicating to the player that he must drop the weapon he has on him before he can get a new one out of the car. (Used if heavyWeaponsFromCar = true) msg_alreadyWeared = "You must put down your gun before picking up a new one.", -- Accepted values : text -- Message indicating to the player that his attached weapon was just deleted from his inventory. msg_weaponDeleted = "You no longer have the attached weapon in your inventory.", -- Accepted values : text -- One of these two notifications will be displayed when the player changes the position of their weapon. (Used if playerCanChangePosition = true) msg_emptyargs = "You must specify which position you want", msg_changingPosTo = "You will now carry your weapon on this position : ", -- Accepted values : text msg_dontexist = "Position don't exist, please check your command's args.", -- This sentence will be displayed when the command to change the position of the weapon is suggested. (Used if playerCanChangePosition = true) msg_suggChangePosition = "Allows you to change the position of the weapon (chest or back).", -- Accepted values : text -- This sentence will be displayed when the command to debug the weapon port is suggested. msg_suggDebug = "Command to use in case of problems with carrying a weapon. This will reset the latter to its default state.", -- Accepted values : text } CONFIG_HOLSTER = { weapon = { 'WEAPON_PISTOL', 'WEAPON_COMBATPISTOL', 'WEAPON_APPISTOL', 'WEAPON_PISTOL50', 'WEAPON_SNSPISTOL', 'WEAPON_HEAVYPISTOL', 'WEAPON_PISTOLXM3', 'WEAPON_SNSPISTOL_MK2', 'WEAPON_RAYPISTOL', 'WEAPON_REVOLVER_MK2', 'WEAPON_RAYPISTOL', 'WEAPON_DOUBLEACTION', 'WEAPON_VINTAGEPISTOL', 'WEAPON_GADGETPISTOL', 'WEAPON_FLAREGUN', 'WEAPON_NAVYREVOLVER', 'WEAPON_MARKSMANPISTOL', 'WEAPON_REVOLVER', 'WEAPON_PISTOL_MK2', }, -- Which position of holster must be used by default : side | back | front | leg DefaultHolsterAnimation = "front", -- For each groups of components, as this examples, you must provide depanding of your EUP : ped, component, drawable. -- Components used as holster SideHolsterComponents = { --{"mp_m_freemode_01",{{7,{1,3,6,5,8,2,42,43,110,111,119,120}},{8,{16,18}}}} }, -- Components used as holster BackHolsterComponents = { }, -- Components used as holster FrontHolsterComponents = { }, -- Components used as holster SideLegHolsterAnimation = { }, -- This command will allow you to change the holster animation. You can also change all differents texts for this functionnality. commandUsedToChangeHolsterAnim = "changeHolsterAnim", -- Accepted values : text (without the / ) msg_changingAnim = "Animation changed to : ", msg_suggChangeAnim = "Change your default animation when you try to get a pistol from your holster.", msg_AnimType = "Available animation type.", msg_error = "An error has occured. Please try again." } CONFIG_AIM = { WEAPONS = { 'WEAPON_PISTOL', 'WEAPON_COMBATPISTOL', 'WEAPON_APPISTOL', 'WEAPON_PISTOL50', 'WEAPON_SNSPISTOL', 'WEAPON_HEAVYPISTOL', 'WEAPON_PISTOLXM3', 'WEAPON_SNSPISTOL_MK2', 'WEAPON_RAYPISTOL', 'WEAPON_REVOLVER_MK2', 'WEAPON_RAYPISTOL', 'WEAPON_DOUBLEACTION', 'WEAPON_VINTAGEPISTOL', 'WEAPON_GADGETPISTOL', 'WEAPON_FLAREGUN', 'WEAPON_NAVYREVOLVER', 'WEAPON_MARKSMANPISTOL', 'WEAPON_REVOLVER', 'WEAPON_PISTOL_MK2', }, DefaultAnim = "Default", -- Default - GangsterAS - HillbillAS commandUsedToChangeAimAnim = "changeAimAnim", msg_changingAnim = "The aim animation has been changed to : ", msg_suggChangeAnim = "Change your default aiming animation.", msg_AnimType = "Available animation type." } ```
Main Wearable Weapons configuration Select here your framework and your inventory system. ```lua framework = "none", -- Accepted values : esx | none inventory = "none", -- Only if framework is not none. Accepted values : ox | none ``` This option, if set to true, will force your players to retrieve the whitelist weapons from the trunk of a vehicle. If UseNearestDoor is set to true, you will always use the nearest door of the vehicle to take your weapon. ```lua heavyWeaponsFromCar = true, UseNearestDoor = true, -- Only if HeavyWeaponsFromCar is TRUE. Accepted values : false | true PlayAnimation = true, -- Only if UserNearestDoor is TRUE. Accepted values : false | true ``` This option allows you to list the different weapons that can be influenced by the script. The weapons present in this list must be taken out from a trunk of a vehicle. ```lua weaponsAccepted = { -- Example : ["file_name"] = "WEAPON_ID", ["w_ar_carbinerifle"] = "WEAPON_CARBINERIFLE", ["w_ar_carbineriflemk2"] = "WEAPON_CARBINERIFLE_MK2", ["w_ar_assaultrifle"] = "WEAPON_ASSAULTRIFLE", ["w_ar_specialcarbine"] = "WEAPON_SPECIALCARBINE", ["w_ar_bullpuprifle"] = "WEAPON_BULLPUPRIFLE", ["w_ar_advancedrifle"] = "WEAPON_ADVANCEDRIFLE", ["w_sb_assaultsmg"] = "WEAPON_ASSAULTSMG", ["w_sb_smg"] = "WEAPON_SMG", ["w_sb_smgmk2"] = "WEAPON_SMGMk2", ["w_sb_gusenberg"] = "WEAPON_GUSENBERG", ["w_mg_combatmg"] = "WEAPON_COMBATMG", ["w_sb_microsmg"] = "WEAPON_MICROSMG", ["w_sr_sniperrifle"] = "WEAPON_SNIPERRIFLE", ["w_sr_marksmanrifle"] = "WEAPON_MARKSMANRIFLE", ["w_sr_heavysniper"] = "WEAPON_HEAVYSNIPER", ["w_sg_assaultshotgun"] = "WEAPON_ASSAULTSHOTGUN", ["w_sg_bullpupshotgun"] = "WEAPON_BULLPUPSHOTGUN", ["w_sg_pumpshotgun"] = "WEAPON_PUMPSHOTGUN", ["w_ar_musket"] = "WEAPON_MUSKET", ["w_sg_heavyshotgun"] = "WEAPON_HEAVYSHOTGUN", ["w_ar_carbineriflemk2"] = "WEAPON_CARBINERIFLE_MK2", ["w_ar_specialcarbine"] = "WEAPON_SPECIALCARBINE" }, ``` This option determines all differents possibles positions to wear your weapon on your player. You can also determine wheter the weapon should be worn on the chest or on the back of the player by default. ```lua attachedBones = { -- back_bone = { 11816 ,24816, 24816, 24816, 11816, 11816, 51826, 24816}, x = { -0.35 ,0.28, -0.02, -0.090, -0.22, -0.070, 0.15, -0.05}, y = { 0.18 ,-0.15, -0.05, -0.15, 0.17, 0.16, 0.07, -0.16}, z = { -0.05 ,0.02, 0.05, -0.080, -0.020, -0.030, 0.11, -0.14}, x_rotation = {360.0 ,0.0, -4.0, -180.0, 183.0, -183.0, -89.0, 0}, y_rotation = {-40.0 ,165.0, 47.0, -515.0, -538.0, -505.0, -540.0, -15}, z_rotation = {1.0 ,0.0, -534.3, -5.0, 0, 4.0, 2.0, -7} }, default_position = 2, ``` Select if you want to let the possibility to your players to get weapons from bag, and if yes, in which bags ``` bags_can_contain_weapons = true, bags_eup = {41,45} ``` Select whether or not the player can choose himself between placing his weapon on his back and placing his weapon on the chest. (Command by default : /weaponposition) ```lua playerCanChangePosition = true, ``` Here you can change the name of commands and enable (or disable) the weapon drop functionnality. The first one is used to allow the player to choose the location of the weapon they will carry. The second one will allow a player to be debugged in case of problems with the script. This will reset the state of the weapon port. ```lua commandUsedToChangePosition = "weaponposition", enableDropCommand = true, commandUsedToDropWeapon = "drop", msg_suggDrop = "Drop the weapon you are currently holding", dropAnimDict = "random@domestic", dropAnimName = "pickup_low", commandUsedToDebugWeaponWearing = "debugweapon", ``` This prefixs correspond to the name that will be entered at the start of the notifications, related to this script, which will be displayed in the game. ```lua globalPrefix = "~r~[MyServer] ~c~", globalPrefixBis = "MyServer", ``` This is will allow you to move the position of notificatinos between : the classic GTA notification system, the chat, a custom notification system or simply desactivate notifications. ```lua notifPos = "notification", ``` In the case where you want to show notifications in the chat, you can edit the chat color message (RGB code is used). ```lua notifChatColor = {255,0,0}, ``` All further lines give you the opportunity to edit (or translate) sentences sent by the script. ```lua msg_needCar = "You must be in front of a vehicle to take out this weapon.", msg_alreadyWeared = "You must put down your gun before picking up a new one.", msg_changingPosTo1 = "You will now carry your weapon on your chest.", msg_changingPosTo2 = "You will now carry your weapon on your back.", msg_suggChangePosition = "Allows you to change the position of the weapon (chest or back).", msg_suggDebug = "Command to use in case of problems with carrying a weapon. This will reset the latter to its default state.", ```
Holster system configuration This option allows you to list the different weapons that can be influenced by the scripts. The weapons present in this list will be animated by the holster system. ```lua weapon = { 'WEAPON_PISTOL', 'WEAPON_COMBATPISTOL', 'WEAPON_APPISTOL', 'WEAPON_PISTOL50', 'WEAPON_SNSPISTOL', 'WEAPON_HEAVYPISTOL', 'WEAPON_PISTOLXM3', 'WEAPON_SNSPISTOL_MK2', 'WEAPON_RAYPISTOL', 'WEAPON_REVOLVER_MK2', 'WEAPON_RAYPISTOL', 'WEAPON_DOUBLEACTION', 'WEAPON_VINTAGEPISTOL', 'WEAPON_GADGETPISTOL', 'WEAPON_FLAREGUN', 'WEAPON_NAVYREVOLVER', 'WEAPON_MARKSMANPISTOL', 'WEAPON_REVOLVER', 'WEAPON_PISTOL_MK2', }, ``` With this option, you will can edit which animation is used to get a pistol from a holster. ```lua DefaultHolsterAnimation = "front", ``` This part is a little more complicated and allows you to specify which animation should be used and under what circumstances. You must enter the different accessories available on your server (via EUP in particular) for each of the peds that can carry them. ```lua SideHolsterComponents = { {"mp_m_freemode_01",{{7,{1,3,6,5,8,2,42,43,110,111,119,120}},{8,{16,18}}}} }, BackHolsterComponents = { }, FrontHolsterComponents = { }, SideLegHolsterAnimation = { } ``` For each ped, you need to enter the model of the ped, and each accessories for each categories. If you need help to configure this part, don't hesitate to ask us on our Discord. This command will allow you to change the holster animation. You can also change all differents texts for this functionnality. ````lua ``` commandUsedToChangeHolsterAnim = "changeHolsterAnim", -- Accepted values : text (without the / ) msg_changingAnim = "Animation changed to : ", msg_suggChangeAnim = "Change your default animation when you try to get a pistol from your holster.", msg_AnimType = "Available animation type.", msg_error = "An error has occured. Please try again." ``` ````
Aim animation configuration This option allows you to list the different weapons that can be influenced by the scripts. The weapons present in this list will be animated by the aiming animation system. ``` weapon = { 'WEAPON_PISTOL', 'WEAPON_COMBATPISTOL', 'WEAPON_APPISTOL', 'WEAPON_PISTOL50', 'WEAPON_SNSPISTOL', 'WEAPON_HEAVYPISTOL', 'WEAPON_PISTOLXM3', 'WEAPON_SNSPISTOL_MK2', 'WEAPON_RAYPISTOL', 'WEAPON_REVOLVER_MK2', 'WEAPON_RAYPISTOL', 'WEAPON_DOUBLEACTION', 'WEAPON_VINTAGEPISTOL', 'WEAPON_GADGETPISTOL', 'WEAPON_FLAREGUN', 'WEAPON_NAVYREVOLVER', 'WEAPON_MARKSMANPISTOL', 'WEAPON_REVOLVER', 'WEAPON_PISTOL_MK2', }, ``` With this option, you will can edit which animation is used to aim. ```lua DefaultAnim = "Default", -- Default - GangsterAS - HillbillAS ``` This command will allow you to change the aiming animation. You can also change all differents texts for this functionnality. ```lua commandUsedToChangeAimAnim = "changeAimAnim", msg_changingAnim = "The aim animation has been changed to : ", msg_suggChangeAnim = "Change your default aiming animation.", msg_AnimType = "Available animation type." ```
# Common Errors
You lack the required entitlement to use MS_WearableWeapon This message indicates that you do not have permission to launch the Wearable Weapons resource. The causes can be multiple. We therefore advise you to check these different points : * The Patreon key listed in your server.cfg does not contain a typing error. * The Patreon key listed in your server.cfg belongs to the FiveM account that was used to purchase our resource. * The resource has been successfully purchased in our shop. * The Patreon key linked to my server belongs to me and does not belong to the host of my server. However, we would like to warn you about this last point. Hosts offering Patreons keys in their offers are rarely trustworthy. This will also block the use of any resource protected by FiveM's Escrow system, without exception. We can only strongly advise you to use your own Patreon keys.
# Madonne PVP Many players come to roleplay servers with the intention of harming the experience of other players, including by shooting twists and turns. MadonnePVP allows you to limit access to PVP by asking players to answer a completely personalizable quiz, using questions that you will have previously filled in.
Upon successful completion of the quiz, the player will gain access to PvP features. It is still possible for people authorized to do so, to engage the passive mode, thus disabling any damage on the entire server.
### Showcase Video {% embed url="" %} # Installation 1. After purchasing the resource on our store, log in to Fivem's KeyMaster site (). 2. In the menu on the left, go to **Granted Assets** located in the **Server Owners** section.
3. In the list of resources, select the Download button corresponding to MadonnePVP. This will download you a .zip file.
4. Open the archive you just downloaded. There you will find two folders named **MS\_Madonne\_PVP** and **oxmysql**. 5. Drag this folders into your server's resources folder. 6. Since the resource is already configured and ready to use, all you have to do is edit your server's configuration file (often caller *server.cfg*) and add ensure *ensure oxmysql* and *MS\_Madonne\_PVP* at the bottom of it.
7. If it's not already done, add this line at the top of your server.cfg, and replace each XXX by your database server informations. ```properties set mysql_connection_string "server=XXX;port=XXX;userid=XXX;password=XXX;database=XXX" ``` 8. Start your server and enjoy your new script ! # Configuration
Content of the configuration file by default ```lua CONFIG_MADONNE_PVP = { -- Amount of time a player must wait if they fail all three tries. In days. ResetOfTestsEvery = 1, PeacetimeStateByDefault = false, PeacetimeEnabled = "ATTENTION : Le mode passif a รฉtรฉ activรฉ. Vous รชtes donc ร  l'abri de tous dรฉgรขts.", PeacetimeDisabled = "ATTENTION : Le mode passif a รฉtรฉ dรฉsactivรฉ. Retour ร  la normale de la situation.", QuizUiIsLoading = "Chargement de l'interface d'accรจs au PVP...", AlreadyHavePvp = "Vous disposez dรฉjร  des accรจs PVP.", NoTryRemaining = "Il ne t'en reste plus.", OneTryRemaining = "Il t'en reste 1.", TwoTryRemaining = "Il t'en reste 2.", ThreeTryRemaining = "Il t'en reste 3.", NOTIFICATION_TYPE = "notification", notifChatColor = {255,255,255}, globalPrefixBis = "MadonneStudio", } ```
Main Madonne PVP configuration Number of days required for the test counter to reset. ```lua ResetOfTestsEvery = 1, ``` Default state of passive mode. ```lua PeacetimeStateByDefault = false, ``` Translations of the various phrases used in the script. ```lua PeacetimeEnabled = "ATTENTION : Le mode passif a รฉtรฉ activรฉ. Vous รชtes donc ร  l'abri de tous dรฉgรขts.", PeacetimeDisabled = "ATTENTION : Le mode passif a รฉtรฉ dรฉsactivรฉ. Retour ร  la normale de la situation.", QuizUiIsLoading = "Chargement de l'interface d'accรจs au PVP...", AlreadyHavePvp = "Vous disposez dรฉjร  des accรจs PVP.", NoTryRemaining = "Il ne t'en reste plus.", OneTryRemaining = "Il t'en reste 1.", TwoTryRemaining = "Il t'en reste 2.", ThreeTryRemaining = "Il t'en reste 3.", ``` Changing notification preferences. ```lua NOTIFICATION_TYPE = "notification", notifChatColor = {255,255,255}, globalPrefixBis = "MadonneStudio", ```
Questions configuration In the questions.lua, you can edit each questions you want to ask to your players in the quiz. He is pretty simple to edit. ```lua QuestionsFromCFG = { { question = "Un joueur roule tranquillement, en voiture civil. Je me dรฉcide de l'arrรชter pour le contrรดler. Ce dernier m'indique qu'il ne veut pas particier ร  l'action.", answerA = "Je comprends sa dรฉcision et repart patrouiller. ", answerB = "J'insiste en disant que s'il coopรจre pas, il sera envoyรฉ en garde ร  vue.", answerC = "J'ignore ce qu'il dit et continue mon contrรดle.", answerD = "Je contacte un membre du staff avec la commande /report.", goodAnswer = "A", }, { question = "Pendant un braquage de banque, je me fais tuer alors que j'effectuais un assaut pour apprรฉhender les ravisseurs.", answerA = "Je reviens en me tรฉlรฉportant pour continuer la scรจne avec mes collรจgues.", answerB = "Je reviens sur la scรจne, en voiture, afin de la continuer avec mes collรจgues.", answerC = "J'attends que l'action soit terminรฉe avant de retourner sur place.", answerD = "Je crie au freekill et insulte la personne qui m'a tuรฉ.", goodAnswer = "C", }, { question = "Dans le chat HRP, vous pouvez lire qu'un joueur ร  dit qu'il avait tuรฉ quelqu'un.", answerA = "Je cherche le joueur sur la map pour l'interpeller, il a quand mรชme tuer quelqu'un !", answerB = "Je venge la personne qu'il a tuรฉ.", answerC = "Je ne prends pas compte de ce message dans mon roleplay.", answerD = "Je vais voir d'autres policiers pour leur faire passer l'information.", goodAnswer = "C", }, { question = "Etant actuellement un civil, je croise un policier en voiture.", answerA = "Je fais demi-tour, m'arrรชte ร  son niveau et klaxonne pour le provoquer.", answerB = "Je lui tire dessus pour qu'il se mette ร  me poursuivre.", answerC = "Je lui propose une course-poursuite pour tester mes compรฉtences de conduite.", answerD = "Je continue ma route comme tout bon citoyen lambda.", goodAnswer = "D", }, { question = "En tant que civil, je souhaite rรฉaliser une attaque terroriste sur le serveur.", answerA = "Je me lance directement et tire sur le premier joueur qui passe.", answerB = "Je demande ร  un staff si c'est possible de le faire et la rรฉalise oรน je le souhaite.", answerC = "Je demande ร  un staff si c'est possible de le faire et la rรฉalise ร  l'endroit qu'il m'indique.", answerD = "Je fais juste un /ano pour prรฉvenir et me met ร  tirer sur tout le monde.", goodAnswer = "C", }, { question = "Lequel de ces quatre pseudos est interdit sur le serveur ?", answerA = "Jean Neymar", answerB = "Jean Culetamer", answerC = "Franรงois Hollande", answerD = "Xx-KillerDu33-xX", goodAnswer = "B", }, } -- DON'T TOUCHE BELOW THIS LINE -- function GetQuestionsFromCfg() return questionsFromCFG end ```
# Common Errors
You lack the required entitlement to use MS_Madonne_PVP This message indicates that you do not have permission to launch the MadonnePVP resource. The causes can be multiple. We therefore advise you to check these different points : * The Patreon key listed in your server.cfg does not contain a typing error. * The Patreon key listed in your server.cfg belongs to the FiveM account that was used to purchase our resource. * The resource has been successfully purchased in our shop. * The Patreon key linked to my server belongs to me and does not belong to the host of my server. However, we would like to warn you about this last point. Hosts offering Patreons keys in their offers are rarely trustworthy. This will also block the use of any resource protected by FiveM's Escrow system, without exception. We can only strongly advise you to use your own Patreon keys.
# Madonne Car Spawner Spawn your vehicles the right way! **Madonne Car Spawner** gives your players an intuitive and fully configurable vehicle spawning interface, with realistic NPC delivery, parking slot detection, department restrictions, and permission-based limits. {% embed url="" %} *** ## ๐Ÿ“– About Madonne Car Spawner Madonne Car Spawner allows players to browse and spawn their vehicles through a clean NUI interface โ€” **without relying on ESX, QBCore, or any other framework**. Vehicles are delivered to one of the **11,000+ pre-listed parking slots** present in the game. If no slot is available nearby, a configurable **NPC mechanic** will drive the vehicle directly to the player. Server owners can define **spawn areas** with markers and NPCs, restrict vehicles by **department**, configure **per-player vehicle limits** with VIP tier overrides, and fully customize categories, vehicle lists, and parking zones. A **badge system** allows locked vehicles to remain visible in the interface with a visual indicator.
*** ## โœจ Main Features * ๐Ÿ–ฅ๏ธ **Intuitive NUI Interface** โ€” Players browse vehicles by category with photos, names, and livery previews * ๐Ÿ…ฟ๏ธ **Smart Parking Detection** โ€” Vehicles spawn on the nearest available slot out of 11,000+ pre-listed locations * ๐Ÿšถ **NPC Delivery System** โ€” If no slot is found nearby, a configurable NPC mechanic brings the vehicle to the player * ๐Ÿ“ **Spawn Areas** โ€” Restrict menu access to defined map zones, with optional markers and NPC attendants * ๐Ÿข **Department Restrictions** โ€” Each area can be limited to specific departments (LSPD, LSSD, SAFRโ€ฆ) * ๐Ÿ”’ **Vehicle & Category Whitelisting** โ€” Vehicles and categories can be locked behind a permission code * ๐Ÿ… **Badge System** โ€” Locked vehicles can remain visible in the interface with a custom badge (icon, color, label) * ๐Ÿš— **Vehicle Limit per Player** โ€” Configurable default limit with VIP-tier overrides * ๐ŸŽจ **Livery, Extras & Colors** โ€” Define livery index, extras to enable/disable, and primary/secondary colors per vehicle * โš™๏ธ **Framework Support** โ€” Works standalone or with **ESX** (job-based permissions via `Framework = "esx"`) * ๐ŸŒ **Full Translation Support** โ€” All in-game strings are editable in a dedicated `TRANSLATIONS` table
*** ## ๐Ÿ”— Quick Links * [๐Ÿ“ฅ Installation](/paid-scripts/madonne-car-spawner/installation) * [โš™๏ธ Configuration](/paid-scripts/madonne-car-spawner/configuration) * [โ“ Common Errors](/paid-scripts/madonne-car-spawner/common-errors) # Installation ## ๐Ÿ“‹ Requirements * A **FiveM server** running on artifact `2699` or above * *(Optional)* `MS_Madonne_Notify` for enhanced notifications * *(Optional)* `es_extended` if using `Framework = "esx"` *** ## โฌ‡๏ธ Step 1 โ€” Download the resource Download the latest version of **MS\_Madonne\_CarSpawner** from the [CFX Portal](https://portal.cfx.re/), the official Cfx.re platform for downloading your purchased resources. > ๐Ÿ’ก You must be logged in with the FiveM account used to purchase the resource. *** ## ๐Ÿ“ Step 2 โ€” Add to your server Copy the `MS_Madonne_CarSpawner` folder into your server's **resources directory**. ``` your-server/ โ””โ”€โ”€ resources/ โ””โ”€โ”€ MS_Madonne_CarSpawner/ โ”œโ”€โ”€ cfg/ โ”‚ โ”œโ”€โ”€ config.lua โ”‚ โ”œโ”€โ”€ categories.lua โ”‚ โ”œโ”€โ”€ vehicles.lua โ”‚ โ””โ”€โ”€ parkings.lua โ”œโ”€โ”€ framework/ โ”‚ โ””โ”€โ”€ esx.lua โ”œโ”€โ”€ ui/ โ”œโ”€โ”€ client.lua โ”œโ”€โ”€ permissions.lua โ””โ”€โ”€ fxmanifest.lua ``` > โš ๏ธ The folder name must remain exactly `MS_Madonne_CarSpawner`. Renaming it will break the resource. *** ## ๐Ÿ“ Step 3 โ€” Add to server.cfg Add the following line to your `server.cfg`: ```cfg ensure MS_Madonne_Notify # optional, if using it for notifications ensure MS_Madonne_CarSpawner ``` > โš ๏ธ If you use `MS_Madonne_Notify`, make sure it is started **before** `MS_Madonne_CarSpawner`. *** ## โš™๏ธ Step 4 โ€” Configure the resource Open the files inside the `cfg/` folder and configure them to match your server setup. Refer to the [โš™๏ธ Configuration](/paid-scripts/madonne-car-spawner/configuration) page for a full breakdown of every option. *** ## ๐Ÿ”„ Step 5 โ€” Restart your server Restart your server or run the following command in the console: 
refresh
ensure MS_Madonne_CarSpawner
Madonne Car Spawner is now ready to use! โœ… Players can open the vehicle menu by pressing **`F7`** (default), using the **`/vehicle`** command, or by walking into a configured spawn area. # Configuration ## Default configuration file (config.lua) ### General settings Set delays before initialization and before the menu opens, to ensure all data is received in time. ```lua Delay_Before_Init = 1000, -- ms Delay_Before_Opening_Menu = 200, -- ms ``` Select the framework your server uses. Set to `"esx"` to enable job-based permissions โ€” the ESX job name is then used as `permissionCode` in your categories and vehicles. ```lua Framework = "standalone", -- "standalone" or "esx" ``` Configure the available ways to open the vehicle menu. ```lua Enable_Command_To_Debug_Shipping = true, Command_To_Debug_Shipping = "debug", -- Without '/' Enable_Command_To_Open = true, Command_To_Open = "vehicle", -- Without '/' Enable_Keybind_To_Open = true, Keybind_To_Open = 'F7', ``` > ๐Ÿ’ก The debug command lets staff manually unstick a vehicle delivery blocked in the "en route" state. Select whether players must stand inside a defined zone to open the menu. Markers and NPC attendants can be added per area. ```lua Player_Must_Be_In_Area_To_Open = true, Set_A_Marker_In_Area = true, Set_A_NPC_In_Area = false, ``` Configure how the script behaves when no parking slot is found within detection range. ```lua Ship_Vehicle_If_Zero_Slot_Available = true, -- if false, spawn is cancelled and a notification is sent ParkingSlotDectionRange = 200, ``` > โš ๏ธ Avoid setting `ParkingSlotDectionRange` to very large values โ€” it may cause performance issues on busy servers. *** ### Areas Define each spawn area with its world coordinates, detection radius, marker appearance, optional NPC model, and department restrictions. ```lua Areas = { [1] = { x = -802.311, y = 175.056, z = 72.8446, h = 0.0, radius = 5.0, marker_type = 36, -- https://docs.fivem.net/docs/game-references/markers/ marker_color = {r = 255, g = 255, b = 255, a = 255}, marker_rotation = true, NPC_Model = "s_m_y_cop_01", departments = {"LSPD","LSSD"}, -- set to {} or false to allow all departments }, }, ``` | Parameter | Description | | ------------------ | ---------------------------------------------------------------------------------------------------- | | `x`, `y`, `z`, `h` | World coordinates and heading of the area center | | `radius` | Detection radius in units to trigger menu access | | `marker_type` | Marker type ID โ€” see [FiveM markers reference](https://docs.fivem.net/docs/game-references/markers/) | | `marker_color` | RGBA color of the marker | | `marker_rotation` | Whether the marker rotates | | `NPC_Model` | Ped model for the NPC attendant (`Set_A_NPC_In_Area` must be `true`) | | `departments` | List of department names to restrict access; `{}` or `false` to allow all | *** ### Vehicle blips & ejection Configure whether a minimap blip appears when a vehicle is delivered, and whether unauthorized drivers are ejected. ```lua EjectDriverIfCantDrive = true, Add_Blip_To_Vehicle = true, Blip_Sprite = 56, Blip_Colour = 57, ``` Blip sprite and colour IDs are available at [docs.fivem.net](https://docs.fivem.net/docs/game-references/blips/). *** ### NPC mechanic per vehicle type When no nearby parking slot is found, an NPC drives the vehicle to the player. Configure the ped model used per vehicle type. ```lua Mechano_Ped = { { vehicle_type = 1, ped = "s_m_y_cop_01" }, -- Police { vehicle_type = 2, ped = "s_m_y_fireman_01" }, -- Fire department { vehicle_type = 3, ped = "s_m_m_paramedic_01" }, -- EMS { vehicle_type = 4, ped = "s_m_y_armymech_01" }, -- Military { vehicle_type = "default", ped = "mp_m_waremech_01" }, -- Default / civilian }, ``` Vehicle type IDs are defined in `vehicles.lua`. *** ### Player vehicle limits Limit how many vehicles a player can have spawned simultaneously. Permission tiers can raise the limit above the default. ```lua Cars_Limit_By_Player = true, Default_Cars_Limit = 3, Permissions_Codes_For_Limits = { { name = "VIP OR", limit = 6 }, { name = "VIP ARGENT", limit = 5 }, { name = "VIP BRONZE", limit = 4 }, }, ``` > ๐Ÿ’ก Permission codes must exactly match those assigned by your permission system. *** ### Notifications Accepted values: `"notification"` (default FiveM notification), `"chat"` (chat message), or `"other"` (fires the `MS_CarSpawner_Notification` client event for a custom handler). ```lua Notifications_Type = "notification", Notifications_Chat_Color = {255, 255, 255}, ``` *** ### Badges Badges display on locked vehicles in the interface. Each badge is associated with a permission code and shows a custom icon, color, and label. Icons use names from [Remix Icon](https://remixicon.com/). ```lua Badges = { ["VIP OR"] = { label = "VIP OR", icon_badge = "verified-badge-fill", -- icon name from remixicon.com (without ri- prefix) color_badge = "#c7a635", display_if_locked = true, }, }, ``` | Parameter | Description | | --------------------- | -------------------------------------------------------------------------------------------------------- | | Key (e.g. `"VIP OR"`) | Must match the `permissionCode` set on the vehicle or category | | `label` | Text displayed next to the icon | | `icon_badge` | Remix Icon name, without the `ri-` prefix | | `color_badge` | Hex color of the badge | | `display_if_locked` | If `true`, the vehicle stays visible in the menu with a lock overlay when the player doesn't have access | *** ### Translations All in-game messages are editable in the `TRANSLATIONS` table at the bottom of `config.lua`. ```lua TRANSLATIONS = { Vehicle_Already_Coming = "...", Shipping_In_Progress = "...", Vehicle_On_Nearest_Slot = "...", Vehicle_Arrived = "...", CantDrive = "...", OpenDashboard = "Press ~INPUT_SELECT_CHARACTER_TREVOR~ to access the Car Spawner", OpenKeySettings = "Open Car Spawner", NotPossibleToOpenDashboardFromHere = "...", OpenCommandDescription = "...", DebugCommandDescription = "...", NoParkingSlotAvailable = "...", Shipping_Debugged = "...", } ``` *** ## File : categories.lua Define each category visible in the spawn menu. The variable must be named `VEHICLES_CATEGORIES`. ```lua VEHICLES_CATEGORIES = { { name = "LSPD", logo = "https://cdn.discordapp.com/attachments/.../logo.png", whitelist = false, permissionCode = "", }, } ``` | Parameter | Description | | ---------------- | ---------------------------------------------------------------------------------------- | | `name` | Category name shown in the interface โ€” must match the `category` field in `vehicles.lua` | | `logo` | URL of the category logo image | | `whitelist` | `true` to restrict access to players with the permission code | | `permissionCode` | Required permission code. Can be a `string` or a table of strings | > ๐Ÿ’ก When using `Framework = "esx"`, set `permissionCode` to the ESX job name (e.g. `"police"`). The default file includes 12 pre-configured categories: LSPD, LSPP, LSSD, BCSO, SAHP, SASP, FIB, USMS, NOOSE, SAMR, SAFR, USARMY. *** ## File : vehicles.lua Add each vehicle to the menu. The variable must be named `VEHICLES`. ```lua VEHICLES = { { type = 1, category = "LSPD", name = "2011 Ford CVPI - Rotatif", model = "mst11vic", spawnIn = false, livery = 0, photo = "https://cdn.discordapp.com/.../photo.jpg", whitelist = false, permissionCode = "", extraToEnable = {1, 4}, extraToDisable = {2, 3, 5, 6, 7}, primaryColor = 0, secondaryColor = 0, }, } ``` | Parameter | Description | | ---------------- | ----------------------------------------------------------------------------------------------------- | | `type` | Vehicle type: `0` civilian, `1` police, `2` fire department, `3` EMS, `4` military | | `category` | Must exactly match a `name` value in `categories.lua` | | `name` | Display name shown in the interface | | `model` | In-game spawn name of the vehicle | | `spawnIn` | `true` to teleport the player inside the vehicle on spawn | | `livery` | Livery index (`0` = default) | | `photo` | URL of the vehicle preview image | | `whitelist` | `true` to restrict to a permission code | | `permissionCode` | Required permission code. Can be a `string` or a table of strings | | `extraToEnable` | List of extra IDs to enable on the vehicle | | `extraToDisable` | List of extra IDs to disable on the vehicle | | `primaryColor` | Primary vehicle color ID โ€” see [color reference](https://wiki.rage.mp/index.php?title=Vehicle_Colors) | | `secondaryColor` | Secondary vehicle color ID | *** ## File : parkings.lua Contains all pre-listed parking slots used for vehicle delivery. The variable must be named `PARKING_SLOTS`. ```lua PARKING_SLOTS = { -- vehicle_type, X, Y, Z, heading {0, 1110.62, -1506.04, 34.03, 268.66}, } ``` A `vehicle_type` of `0` makes the slot available for all types. Use a specific type ID to restrict a slot to one category. > ๐Ÿ’ก The default file includes **11,000+ parking slots** mapped across the entire GTA V map. Only edit this file if you want to add custom spots or restrict available locations. *** ## File : permissions.lua This server-side file handles permission assignment. By default it grants the `STAFF` permission to players with the `madonne.vclstaff` ace permission. ```lua RegisterNetEvent("MS_CS_CheckPermissions") AddEventHandler("MS_CS_CheckPermissions", function() local src = source if IsPlayerAceAllowed(source, "madonne.vclstaff") then TriggerClientEvent("MS_CS_AddPermissionCode", src, "STAFF") else -- Add your own permission logic here -- TriggerClientEvent("MS_CS_AddPermissionCode", src, "YOUR_CODE") end end) ``` > ๐Ÿ’ก You can call `TriggerClientEvent("MS_CS_AddPermissionCode", src, "...")` multiple times to assign several permission codes to a player at once. # Common Errors ## โŒ The resource does not start / is not found **Error message:** `Couldn't start resource MS_Madonne_CarSpawner` or similar. **Possible causes:** * The resource folder is not named exactly `MS_Madonne_CarSpawner` * The `ensure MS_Madonne_CarSpawner` line is missing from your `server.cfg` * The resource was placed in a sub-folder not scanned by FiveM **Fix:** Verify the folder name matches exactly, check your `server.cfg`, then restart your server. *** ## โŒ CFX Portal entitlement error โ€” resource refuses to start **Error message:** `Couldn't load resource MS_Madonne_CarSpawner` or `Escrow: invalid entitlement`. This error means the FiveM account linked to your server's license key does not have access to this resource. Please verify the following: * The CFX key in your `server.cfg` contains no typo * The key belongs to the FiveM account used to purchase the resource * The resource has been successfully purchased on our store * The key belongs to you and not to your hosting provider > โš ๏ธ Hosts offering shared CFX keys in their packages prevent the use of any resource protected by FiveM's Escrow system, without exception. *** ## โŒ Menu opens but no vehicles are displayed **Possible causes:** * `vehicles.lua` is empty or contains a syntax error * The `category` field in a vehicle entry does not match any `name` in `categories.lua` * The player's department doesn't match the restrictions set in the area's `departments` table **Fix:** Check that category names match exactly between `vehicles.lua` and `categories.lua`. Enable `DEBUG = true` in `config.lua` to print loaded permission codes in the console. *** ## โŒ Vehicle delivery is stuck "en route" The NPC was spawned but the vehicle never arrives and the status stays blocked. **Fix:** Use the debug command (default `/debug`) to manually reset the delivery. If this happens frequently, check that: * `ParkingSlotDectionRange` is not set too high * No other resource is deleting NPC-driven vehicles before they arrive * The NPC ped model defined in `Mechano_Ped` is valid and loadable *** ## โŒ Vehicle spawns far from the player / NPC delivery triggered unexpectedly **Possible causes:** * No parking slot was found within `ParkingSlotDectionRange`, so the NPC delivery fallback was triggered (expected behavior when `Ship_Vehicle_If_Zero_Slot_Available = true`) **Fix:** If you want vehicles to always spawn nearby, add custom parking slots near your most-used areas in `parkings.lua`, or increase `ParkingSlotDectionRange` slightly. *** ## โŒ Players can access vehicles they should not **Possible causes:** * `whitelist = false` is set on a vehicle or category that should be restricted * `permissionCode` does not exactly match the code returned by your permission system * The `departments` table in the area config is set to `{}` instead of a specific list, allowing all departments **Fix:** Review the `whitelist` and `permissionCode` values in `vehicles.lua` and `categories.lua`. Check `permissions.lua` to confirm the codes being assigned to players match what you expect. *** ## โŒ Notifications are not displayed **Possible causes:** * `Notifications_Type` is set to an unrecognized value โ€” valid values are `"notification"`, `"chat"`, and `"other"` * The `MS_Madonne_Notify` resource is not started before `MS_Madonne_CarSpawner` in `server.cfg` **Fix:** Set `Notifications_Type = "notification"` to use native FiveM notifications, or ensure `MS_Madonne_Notify` is ensured first in your `server.cfg`. *** ## โŒ ESX jobs are not recognized as permission codes **Possible causes:** * `Framework` is still set to `"standalone"` in `config.lua` * The `permissionCode` in categories or vehicles doesn't exactly match the ESX job name **Fix:** Set `Framework = "esx"` in `config.lua`, then set `permissionCode` to the ESX job name (e.g. `"police"`). The ESX integration is handled automatically via `framework/esx.lua`. *** ## ๐Ÿ’ฌ Need further help? Join our support server on Discord: [discord.gg/madonne](https://discord.gg/madonne) # Madonne EUP Menu Dress your players the right way. **Madonne EUP Menu** gives your FiveM server a clean, fully configurable outfit equipping interface โ€” with department restrictions, spawn areas, permission-based access, and gender filtering.
*** ## ๐Ÿ“– About Madonne EUP Menu Madonne EUP Menu allows players to browse and equip outfits through a simple NUI interface โ€” **without any framework dependency**. Outfits are organized by category (department), each with its own logo and optional whitelist. Players can only see outfits matching their ped gender. Server owners can define **spawn areas** with markers and optional NPC attendants, restrict outfit access by **department**, and fully control permissions via a dedicated `permissions.lua` file or any custom system. *** ## โœจ Main Features * ๐Ÿ–ฅ๏ธ **Intuitive NUI Interface** โ€” Players browse outfits by category with photos and names * ๐Ÿข **Department Restrictions** โ€” Each spawn area can be limited to specific departments * ๐Ÿ”’ **Outfit & Category Whitelisting** โ€” Lock outfits or entire categories behind a permission code * ๐Ÿ‘จ๐Ÿ‘ฉ **Gender Filtering** โ€” Outfits are automatically filtered by the player's ped gender (MP male / MP female) * ๐Ÿ“ **Spawn Areas** โ€” Restrict menu access to defined map zones with optional markers and NPC attendants * ๐ŸŽจ **Full Outfit Customization** โ€” Configure every ped component (top, pants, shoes, hat, glasses, accessoriesโ€ฆ) and props per outfit * ๐Ÿ”” **Notification System** โ€” Compatible with `notification`, `chat`, and custom handlers * ๐ŸŒ **Full Translation Support** โ€” All in-game strings are editable in a dedicated `TRANSLATIONS` table *** ## ๐Ÿ”— Quick Links * [๐Ÿ“ฅ Installation](/paid-scripts/madonne-eup-menu/installation) * [โš™๏ธ Configuration](/paid-scripts/madonne-eup-menu/configuration) * [โ“ Common Errors](/paid-scripts/madonne-eup-menu/common-errors) # Installation ## ๐Ÿ“‹ Requirements * A **FiveM server** running on artifact `2699` or above * An **EUP** pack installed on your server (ped components and props must exist server-side) *** ## โฌ‡๏ธ Step 1 โ€” Download the resource Download the latest version of **MS\_Madonne\_EUPMenu** from the [CFX Portal](https://portal.cfx.re/), the official Cfx.re platform for downloading your purchased resources. > ๐Ÿ’ก You must be logged in with the FiveM account used to purchase the resource. *** ## ๐Ÿ“ Step 2 โ€” Add to your server Copy the `MS_Madonne_EUPMenu` folder into your server's **resources directory**. ``` your-server/ โ””โ”€โ”€ resources/ โ””โ”€โ”€ MS_Madonne_EUPMenu/ โ”œโ”€โ”€ client/ โ”‚ โ”œโ”€โ”€ core/ โ”‚ โ””โ”€โ”€ custom/ โ”‚ โ””โ”€โ”€ notifications.lua โ”œโ”€โ”€ server/ โ”‚ โ”œโ”€โ”€ core/ โ”‚ โ””โ”€โ”€ custom/ โ”‚ โ””โ”€โ”€ permissions.lua โ”œโ”€โ”€ config/ โ”‚ โ”œโ”€โ”€ config.lua โ”‚ โ”œโ”€โ”€ categories.lua โ”‚ โ””โ”€โ”€ outfits.lua โ”œโ”€โ”€ ui/ โ””โ”€โ”€ fxmanifest.lua ``` > โš ๏ธ The folder name must remain exactly `MS_Madonne_EUPMenu`. Renaming it will break the resource. *** ## ๐Ÿ“ Step 3 โ€” Add to server.cfg Add the following line to your `server.cfg`: 
ensure MS_Madonne_EUPMenu
*** ## โš™๏ธ Step 4 โ€” Configure the resource Open the files inside the `config/` folder and configure them to match your server setup. Refer to the [โš™๏ธ Configuration](/paid-scripts/madonne-eup-menu/configuration) page for a full breakdown of every option. *** ## ๐Ÿ”„ Step 5 โ€” Restart your server Restart your server or run the following command in the console: ``` refresh ensure MS_Madonne_EUPMenu ``` Madonne EUP Menu is now ready to use! โœ… Players can open the outfit menu by pressing **`F7`** (default), using the **`/eup`** command, or by walking into a configured spawn area. > โš ๏ธ Players must be using an **MP freemode ped** (`mp_m_freemode_01` or `mp_f_freemode_01`) to access the menu. The resource will display a notification if the player's ped is not compatible. # Configuration ## Default configuration file (config.lua) ### General settings Set a delay before the script initializes, to ensure all data is received before allowing players to open the menu. ```lua Delay_Before_Init = 1000, -- ms ``` Configure the available ways to open the outfit menu. ```lua Enable_Command_To_Open = true, Command_To_Open = "eup", -- Without '/' Enable_Keybind_To_Open = true, Keybind_To_Open = 'F7', ``` Select whether players must stand inside a defined zone to open the menu. Markers and NPC attendants can be added per area. ```lua Player_Must_Be_In_Area_To_Open = true, Set_A_Marker_In_Area = true, Set_A_NPC_In_Area = false, ``` *** ### Areas Define each spawn area with its world coordinates, detection radius, marker appearance, optional NPC model, and department restrictions. ```lua Areas = { [1] = { x = -802.311, y = 175.056, z = 72.8446, h = 0.0, radius = 5.0, marker_type = 21, -- https://docs.fivem.net/docs/game-references/markers/ marker_color = {r = 255, g = 255, b = 255, a = 255}, marker_rotation = true, NPC_Model = "s_m_y_cop_01", departments = {"LSPD"}, -- set to {} or false to show all departments }, }, ``` | Parameter | Description | | ------------------ | ---------------------------------------------------------------------------------------------------- | | `x`, `y`, `z`, `h` | World coordinates and heading of the area center | | `radius` | Detection radius in units to trigger menu access | | `marker_type` | Marker type ID โ€” see [FiveM markers reference](https://docs.fivem.net/docs/game-references/markers/) | | `marker_color` | RGBA color of the marker | | `marker_rotation` | Whether the marker rotates | | `NPC_Model` | Ped model for the NPC attendant (`Set_A_NPC_In_Area` must be `true`) | | `departments` | List of department names to restrict access; `{}` or `false` to allow all | *** ### Notifications Accepted values: `"notification"` (default FiveM notification), `"chat"` (chat message), or `"other"` (fires the `MS_EUPMenu_Notification` client event for a custom handler). ```lua Notifications_Type = "notification", Notifications_Chat_Color = {255, 255, 255}, ``` To use a custom notification script, edit `client/custom/notifications.lua`: ```lua RegisterNetEvent("MS_EUPMenu_Notification") AddEventHandler("MS_EUPMenu_Notification", function(text) -- Example with okokNotify: exports['okokNotify']:Alert("MadonneStudio", text, 5000, 'info', true) end) ``` *** ### Translations All in-game messages are editable in the `TRANSLATIONS` table at the bottom of `config.lua`. ```lua TRANSLATIONS = { OpenCommandDescription = "Open EUP Menu", OpenKeySettings = "Open EUP Menu", OpenDashboard = "Press ~INPUT_SELECT_CHARACTER_TREVOR~ to access the EUP Menu", NotPossibleToOpenDashboardFromHere = "It's not possible to open the EUP menu from here.", NeedToBeAMPPed = "You need to be a MP ped to use the EUP menu.", } ``` *** ## File : categories.lua Define each outfit category visible in the menu. The variable must be named `OUTFITS_CATEGORIES`. ```lua OUTFITS_CATEGORIES = { { name = "LSPD", logo = "https://cdn.discordapp.com/attachments/.../logo.png", whitelist = false, permissionCode = "", }, } ``` | Parameter | Description | | ---------------- | --------------------------------------------------------------------------------------- | | `name` | Category name shown in the interface โ€” must match the `category` field in `outfits.lua` | | `logo` | URL of the category logo image | | `whitelist` | `true` to restrict access to players with the permission code | | `permissionCode` | Required permission code. Can be a `string` | *** ## File : outfits.lua Add each outfit to the menu. The variable must be named `OUTFITS`. Each outfit defines every ped component and prop using the format `"drawableId:textureId"` (both 1-indexed). ```lua OUTFITS = { { category = "LSPD", name = "Classe A", image = "https://cdn.discordapp.com/.../photo.jpg", gender = "M", -- "M" or "F" whitelist = false, permissionCode = "", ---------------------------- mask = "1:1", upperskin = "7:1", pants = "36:1", parachute = "33:2", shoes = "62:1", accessories = "237:1", undercoat = "225:1", armor = "201:1", decal = "1:1", top = "201:9", hat = "1:1", glasses = "1:1", ear = "1:1", watch = "1:1", }, } ``` | Parameter | Description | | ---------------- | -------------------------------------------------------------------------- | | `category` | Must exactly match a `name` value in `categories.lua` | | `name` | Display name shown in the interface | | `image` | URL of the outfit preview image | | `gender` | `"M"` for MP male ped, `"F"` for MP female ped | | `whitelist` | `true` to restrict to a permission code | | `permissionCode` | Required permission code | | `mask` โ€ฆ `watch` | Ped component or prop value in `"drawableId:textureId"` format (1-indexed) | **Component reference:** | Field | Ped component slot | | ------------- | --------------------------- | | `mask` | Component 1 | | `upperskin` | Component 3 | | `pants` | Component 4 | | `parachute` | Component 5 (bag/parachute) | | `shoes` | Component 6 | | `accessories` | Component 7 | | `undercoat` | Component 8 | | `armor` | Component 9 | | `decal` | Component 10 | | `top` | Component 11 | | `hat` | Prop 0 | | `glasses` | Prop 1 | | `ear` | Prop 2 | | `watch` | Prop 6 | > ๐Ÿ’ก Set a component to `"1:1"` to apply drawable index 0 / texture 0 (the first available). For props, `"1:1"` will **clear** the prop slot entirely. *** ## File : permissions.lua This server-side file handles permission assignment. By default it grants the `STAFF` permission to players with the `madonne.staffoutfit` ace permission. ```lua RegisterNetEvent("MS_EM_CheckPermissions") AddEventHandler("MS_EM_CheckPermissions", function() local src = source if IsPlayerAceAllowed(source, "madonne.staffoutfit") then TriggerClientEvent("MS_CS_AddPermissionCode", src, "STAFF") else -- Add your own permission logic here -- TriggerClientEvent("MS_CS_AddPermissionCode", src, "YOUR_CODE") end end) ``` > ๐Ÿ’ก You can call `TriggerClientEvent("MS_CS_AddPermissionCode", src, "...")` multiple times to assign several permission codes to a player at once. # Common Errors ## โŒ The resource does not start / is not found **Error message:** `Couldn't start resource MS_Madonne_EUPMenu` or similar. **Possible causes:** * The resource folder is not named exactly `MS_Madonne_EUPMenu` * The `ensure MS_Madonne_EUPMenu` line is missing from your `server.cfg` * The resource was placed in a sub-folder not scanned by FiveM **Fix:** Verify the folder name matches exactly, check your `server.cfg`, then restart your server. *** ## โŒ CFX Portal entitlement error โ€” resource refuses to start **Error message:** `Couldn't load resource MS_Madonne_EUPMenu` or `Escrow: invalid entitlement`. This error means the FiveM account linked to your server's license key does not have access to this resource. Please verify the following: * The CFX key in your `server.cfg` contains no typo * The key belongs to the FiveM account used to purchase the resource * The resource has been successfully purchased on our store * The key belongs to you and not to your hosting provider > โš ๏ธ Hosts offering shared CFX keys in their packages prevent the use of any resource protected by FiveM's Escrow system, without exception. *** ## โŒ "You need to be a MP ped" notification appears The menu refuses to open because the player is not using a freemode ped. **Fix:** The resource only works with `mp_m_freemode_01` (MP male) and `mp_f_freemode_01` (MP female). Make sure your players spawn with one of these ped models. Custom ped models are not supported. *** ## โŒ Menu opens but no outfits are displayed **Possible causes:** * `outfits.lua` is empty or contains a syntax error * The `category` field in an outfit entry does not match any `name` in `categories.lua` * The `gender` field does not match the player's current ped model * The `departments` restriction in the area config is set to a list that doesn't include the player's department **Fix:** Check that category names match exactly between `outfits.lua` and `categories.lua`. Verify the `gender` field (`"M"` or `"F"`) matches the ped the player is using. *** ## โŒ Outfit is equipped incorrectly / wrong component applied **Possible causes:** * A component value uses the wrong format โ€” the expected format is `"drawableId:textureId"` with both values **1-indexed** (so `"1:1"` = drawable 0, texture 0) * A drawable or texture index doesn't exist in your EUP pack **Fix:** Double-check all component values in `outfits.lua`. Remember that `"1:1"` corresponds to index 0 in-game. For props (`hat`, `glasses`, `ear`, `watch`), setting `"1:1"` clears the prop slot. *** ## โŒ Menu cannot be opened from the configured area **Possible causes:** * `Player_Must_Be_In_Area_To_Open = true` but the area coordinates or radius are not set correctly * The `departments` table in the area config doesn't include the player's department name **Fix:** Verify the `x`, `y`, `z` coordinates and `radius` in your `Areas` config. Make sure the department names in `departments` exactly match those in `categories.lua`. *** ## โŒ Notifications are not displayed **Possible causes:** * `Notifications_Type` is set to an unrecognized value โ€” valid values are `"notification"`, `"chat"`, and `"other"` * When using `"other"`, the event handler in `client/custom/notifications.lua` is not properly set up **Fix:** Set `Notifications_Type = "notification"` to use native FiveM notifications, or configure your custom handler in `client/custom/notifications.lua`. *** ### ๐Ÿ’ฌ Need further help? Join our support server on Discord: [discord.gg/madonne](https://discord.gg/madonne) # Madonne Notify A lightweight and elegant notification system for your FiveM server. **Madonne Notify** displays stylish toast notifications to your players, with support for multiple types, titles, messages, sounds, and custom durations. *** ## ๐Ÿ“– About Madonne Notify Madonne Notify is a free, plug-and-play notification resource built with **Vue 3**. Notifications appear in the **top-right corner** of the screen as animated toast cards, each color-coded and icon-tagged by type. It is natively supported by other MadonneStudio resources such as **MS\_Delete\_Gun** and **MS\_Madonne\_Seatbelt**, and can be used as a standalone notification system on any FiveM server. *** ## โœจ Main Features * ๐ŸŽจ **11 Notification Types** โ€” Each type has its own color and icon: `success`, `error`, `warning`, `info`, `announce`, `progress`, `achievement`, `msg`, `radio`, `system`, `vehicle` * ๐Ÿ”Š **Optional Sound** โ€” Play a built-in UI sound on notification display * โฑ๏ธ **Custom Duration** โ€” Control exactly how long each notification stays on screen * ๐Ÿ“Œ **Title + Message** โ€” Display a bold title, a subtitle message, or both * ๐ŸŽž๏ธ **Smooth Animations** โ€” Slide-in / slide-out transitions on every notification * ๐Ÿงฉ **Export-based API** โ€” Trigger notifications from any resource via a simple client or server export * ๐Ÿ“ก **Event-based API** โ€” Also supports triggering via NetEvents for server-to-client notifications * ๐Ÿ†“ **Free Script** โ€” No escrow, fully open source *** ## ๐Ÿ”— Quick Links * [๐Ÿ“ฅ Installation](/free-scripts/madonne-notify/installation) * [๐Ÿ“ก Usage & API](/free-scripts/madonne-notify/usage-and-api) * [โ“ Common Errors](/free-scripts/madonne-notify/common-errors) # Installation ## ๐Ÿ“‹ Requirements * A **FiveM server** running on artifact `2699` or above * No additional dependencies required *** ## โฌ‡๏ธ Step 1 โ€” Download the resource Download the latest version of **MS\_Madonne\_Notify** from the [CFX Portal](https://portal.cfx.re/), the official Cfx.re platform for downloading your purchased or claimed resources. > ๐Ÿ’ก You must be logged in with the account used to claim the resource. *** ## ๐Ÿ“ Step 2 โ€” Add to your server Copy the `MS_Madonne_Notify` folder into your server's **resources directory**. ``` your-server/ โ””โ”€โ”€ resources/ โ””โ”€โ”€ MS_Madonne_Notify/ โ”œโ”€โ”€ ui/ โ”œโ”€โ”€ client.lua โ”œโ”€โ”€ server.lua โ””โ”€โ”€ fxmanifest.lua ``` *** ## ๐Ÿ“ Step 3 โ€” Add to server.cfg Add the following line to your `server.cfg`. This resource has no dependencies, so it can be started at any point: ```cfg ensure MS_Madonne_Notify ``` > โš ๏ธ If other resources depend on MS\_Madonne\_Notify (e.g. MS\_Madonne\_Seatbelt with `NotificationsType = "MS_Madonne_Notify"`), make sure `MS_Madonne_Notify` is started **before** them. *** ## ๐Ÿ”„ Step 4 โ€” Restart your server Restart your server or run the following command in the console: ``` refresh start MS_Madonne_Notify ``` Madonne Notify is now ready to use! โœ… # Usage & API Madonne Notify exposes a simple API usable from any resource via **exports** (client-side or server-side). *** ## ๐Ÿ–ฅ๏ธ Client-side Export Trigger a notification directly from a client-side script: ```lua exports['MS_Madonne_Notify']:Notify(type, title, message, duration, sound) ``` ### Parameters | Parameter | Type | Description | | ---------- | --------- | ---------------------------------------------------------------- | | `type` | `string` | Notification type (see types below) | | `title` | `string` | Title displayed in bold. Pass `""` to hide. | | `message` | `string` | Subtitle message. Pass `""` to hide. | | `duration` | `number` | Display duration in **milliseconds** (e.g. `5000` for 5 seconds) | | `sound` | `boolean` | `true` to play a UI sound when the notification appears | ### Example ```lua exports['MS_Madonne_Notify']:Notify("success", "Seatbelt", "Seatbelt fastened!", 4000, true) exports['MS_Madonne_Notify']:Notify("error", "Alert", "You are not allowed to do this.", 5000, false) exports['MS_Madonne_Notify']:Notify("info", "", "Server restart in 10 minutes.", 6000, true) ``` *** ## ๐ŸŒ Server-side Export Trigger a notification from a server-side script, targeting a specific player by their server ID: ```lua exports['MS_Madonne_Notify']:Notify(target, type, title, message, duration, sound) ``` ### Parameters | Parameter | Type | Description | | ---------- | --------- | --------------------------------------------------- | | `target` | `number` | Player server ID (`-1` to broadcast to all players) | | `type` | `string` | Notification type (see types below) | | `title` | `string` | Title displayed in bold. Pass `""` to hide. | | `message` | `string` | Subtitle message. Pass `""` to hide. | | `duration` | `number` | Display duration in **milliseconds** | | `sound` | `boolean` | `true` to play a UI sound | ### Example ```lua -- Send to a specific player exports['MS_Madonne_Notify']:Notify(source, "warning", "Warning", "Your behavior has been noted.", 5000, true) -- Broadcast to all players exports['MS_Madonne_Notify']:Notify(-1, "announce", "Server", "An event is starting!", 8000, true) ``` *** ## ๐Ÿ“ก NetEvent (Client-side) Notifications can also be triggered via a NetEvent, useful for more dynamic or event-driven systems: ```lua TriggerEvent('MST_Notify:Notify', type, title, message, duration, sound) ``` Or from the server: ```lua TriggerClientEvent('MST_Notify:Notify', source, type, title, message, duration, sound) ``` *** ## ๐ŸŽจ Notification Types Each type comes with a dedicated color and icon: | Type | Color | Icon | Use case | | ------------- | -------- | -------------- | ------------------------- | | `info` | Purple | โ„น๏ธ Information | General information | | `announce` | Purple | ๐Ÿ“ข Megaphone | Server announcements | | `progress` | Purple | โณ Hourglass | Ongoing actions | | `success` | Green | โœ… Check | Successful actions | | `achievement` | Green | ๐Ÿ† Trophy | Unlocked achievements | | `error` | Dark Red | โš ๏ธ Warning | Errors or blocked actions | | `warning` | Orange | ๐Ÿ”” Alert | Warnings | | `msg` | White | ๐Ÿ’ฌ Message | Chat or messages | | `radio` | White | ๐Ÿ“ป Broadcast | Radio communications | | `system` | White | โš™๏ธ Settings | System events | | `vehicle` | White | ๐Ÿš— Car | Vehicle-related events | *** > ๐Ÿ’ก **Tip:** You can omit the title or message by passing an empty string `""`. The notification will adapt its layout accordingly and only show the content you provide. # Common Errors ## ๐Ÿ”ด Notifications are not showing up **Cause 1:** `MS_Madonne_Notify` is not started on your server. **Fix:** Make sure the resource is added to your `server.cfg` and started before any resource that depends on it: ```cfg ensure MS_Madonne_Notify ``` **Cause 2:** The resource started but the NUI page failed to load. **Fix:** Check your server console for any errors related to `MS_Madonne_Notify`. Make sure the `ui/` folder is present and intact in the resource directory. *** ## ๐Ÿ”ด Export call throws an error **Cause:** The resource name in the export call doesn't match the actual folder name. **Fix:** Make sure you are using the exact resource name. The correct call is: ```lua exports['MS_Madonne_Notify']:Notify(...) ``` Double-check that the folder is named `MS_Madonne_Notify` (case-sensitive on Linux servers). *** ## ๐Ÿ”ด Server-side export doesn't send the notification to the player **Cause:** The `target` parameter is incorrect or the player is no longer connected. **Fix:** Make sure you are passing a valid active server ID. Use `source` inside a server event handler, or verify the player is still online before triggering. ```lua -- Correct server-side usage exports['MS_Madonne_Notify']:Notify(source, "info", "Title", "Message", 5000, false) ``` *** ## ๐Ÿ”ด The notification appears but no sound plays **Cause:** The `sound` parameter is set to `false` or omitted. **Fix:** Pass `true` as the last parameter: ```lua exports['MS_Madonne_Notify']:Notify("success", "Title", "Message", 5000, true) ``` *** ## ๐Ÿ”ด You lack the required entitlement to use MS\_Madonne\_Notify This message indicates that your server does not have the necessary entitlement to start the resource. This is related to FiveM's **Escrow** protection system. Check the following points one by one: * โœ… The **CFX Portal key** listed in your `server.cfg` does not contain any typing error * โœ… The CFX Portal key belongs to the **FiveM account that was used to purchase or claim** the resource * โœ… The resource has been **successfully claimed** on the [CFX Portal](https://portal.cfx.re/) * โœ… The CFX Portal key linked to your server **belongs to you**, and not to your hosting provider > โš ๏ธ **Important warning about hosting provider keys** > > Some hosting providers include a shared CFX Portal key as part of their offers. We strongly advise against using such keys. A key that does not belong to you will block the use of **any resource protected by FiveM's Escrow system**, without exception โ€” not just this one. Always use your own personal CFX Portal key. *** ## ๐Ÿ’ฌ Still having issues? If you are still experiencing problems after following the steps above, feel free to reach out to us: * ๐Ÿ’ฌ **Discord:** [discord.gg/madonne](https://discord.gg/madonne) * ๐ŸŒ **Website:** [madonnestudio.com](https://madonnestudio.com/) * ๐Ÿ“ง **Email:** # Madonne Seatbelt Protect yourself from road accidents by fastening your seat belt! **Madonne Seatbelt** adds a realistic and fully configurable seatbelt system to your FiveM server, with ejection physics, sound effects, visual warnings, and developer hooks. {% embed url="" %} *** ## ๐Ÿ“– About Madonne Seatbelt Madonne Seatbelt simulates real-world seatbelt mechanics in GTA V. Players can fasten and unfasten their seatbelt with a configurable key. If they are involved in a high-speed collision without their seatbelt on, they will be **physically ejected from the vehicle**. A **visual warning icon** blinks on-screen when the player is in a moving vehicle without a seatbelt, and an **alarm sound** can be configured to play after a set interval. *** ## โœจ Main Features * ๐Ÿชข **Realistic Ejection System** โ€” Players are expelled from their vehicle on sharp deceleration if unbuckled, with configurable sensitivity and velocity multiplier * ๐Ÿ–ผ๏ธ **Visual Warning Indicator** โ€” An animated blinking seatbelt icon appears on screen when the player is unbuckled * ๐Ÿ”” **Alarm Sound** โ€” A looping alert plays when the player drives above a configurable speed without their seatbelt * ๐Ÿ”Š **Buckle / Unbuckle Sounds** โ€” Realistic audio feedback when toggling the seatbelt * โŒจ๏ธ **Configurable Key Binding** โ€” Default key is `K`, fully remappable by players in their FiveM settings * ๐Ÿš— **Vehicle & Class Exclusions** โ€” Disable seatbelts for specific vehicle models or entire vehicle classes (bikes, boats, helicoptersโ€ฆ) * ๐Ÿ’บ **Per-Seat Whitelisting** โ€” Prevent ejection from specific seats in specific vehicles (e.g. police car passenger seats) * ๐Ÿ”” **Notification System** โ€” Compatible with `default`, `MS_Madonne_Notify`, `okokNotify`, or a fully custom handler * ๐Ÿงฉ **Developer Exports** โ€” `GetSeatbeltStatus` and `SetSeatbeltStatus` exports for integration with other resources * ๐Ÿช **Custom Hooks** โ€” `FastenedSeatbelt()` and `UnfastenedSeatbelt()` functions in `custom/main.lua` for your own logic *** ## ๐Ÿ”— Quick Links * [๐Ÿ“ฅ Installation](/free-scripts/madonne-seatbelt/installation) * [โš™๏ธ Configuration](/free-scripts/madonne-seatbelt/configuration) * [๐Ÿงฉ Exports & Events](/free-scripts/madonne-seatbelt/exports-and-events) * [โ“ Common Errors](/free-scripts/madonne-seatbelt/common-errors) # Installation ## ๐Ÿ“‹ Requirements * A **FiveM server** running on artifact `2699` or above * *(Optional)* `MS_Madonne_Notify` or `okokNotify` for enhanced notifications *** ## โฌ‡๏ธ Step 1 โ€” Download the resource Download the latest version of **MS\_Madonne\_Seatbelt** from the [CFX Portal](https://portal.cfx.re/), the official Cfx.re platform for downloading your purchased resources. > ๐Ÿ’ก You must be logged in with the account used to purchase the resource. *** ## ๐Ÿ“ Step 2 โ€” Add to your server Copy the `MS_Madonne_Seatbelt` folder into your server's **resources directory**. ``` your-server/ โ””โ”€โ”€ resources/ โ””โ”€โ”€ MS_Madonne_Seatbelt/ โ”œโ”€โ”€ client/ โ”œโ”€โ”€ custom/ โ”œโ”€โ”€ ui/ โ”œโ”€โ”€ config.lua โ”œโ”€โ”€ server.lua โ””โ”€โ”€ fxmanifest.lua ``` *** ## ๐Ÿ“ Step 3 โ€” Add to server.cfg Add the following line to your `server.cfg`, **after** any optional notification resource: ```cfg ensure MS_Madonne_Notify # optional, if using it for notifications ensure MS_Madonne_Seatbelt ``` > โš ๏ธ If you use `NotificationsType = "MS_Madonne_Notify"` or `"okokNotify"`, make sure those resources are started **before** MS\_Madonne\_Seatbelt. *** ## โš™๏ธ Step 4 โ€” Configure the resource Open `config.lua` and configure the resource to match your server setup. Refer to the [โš™๏ธ Configuration](/free-scripts/madonne-seatbelt/configuration) page for a full breakdown of every option. *** ## ๐Ÿ”„ Step 5 โ€” Restart your server Restart your server or run the following command in the console: ``` ensure start MS_Madonne_Seatbelt ``` Madonne Seatbelt is now ready to use! โœ… Players can fasten their seatbelt by pressing **`K`** (default) while inside a vehicle. # Configuration All configuration is done in `config.lua`, which is not escrowed and can be freely edited. *** ## ๐Ÿš— Vehicle Exclusions ```lua DisableSeatbeltsForThisVehicles = { "harley","blazer","bmx","cruiser","gator3" -- add any vehicle model name here }, ``` List of **specific vehicle models** for which the seatbelt system is completely disabled. Useful for bicycles, ATVs, forklifts, and similar vehicles where a seatbelt makes no sense. *** ```lua DisableSeatbeltsForThisVehcilesClasses = { 8, 13, 14, 15, 16, 21, 22 }, ``` List of **vehicle class IDs** for which the seatbelt system is disabled. This is the recommended way to exclude entire categories (motorcycles, boats, helicopters, planesโ€ฆ). > ๐Ÿ“– Full class list: [FiveM Natives โ€” GetVehicleClass](https://docs.fivem.net/natives/?_0x29439776AAA00A62) *** ## โŒจ๏ธ Key Binding & Controls | Option | Type | Description | | ------------------------------ | --------- | --------------------------------------------------------------------- | | `SeatbeltKey` | `string` | Default key to toggle the seatbelt. Default: `"K"` | | `KeymapText` | `string` | Label shown in the FiveM key binding settings | | `EnableWhenDead` | `boolean` | If `true`, the seatbelt system remains active when the player is dead | | `Cooldown` | `number` | Minimum delay in **milliseconds** between two seatbelt toggles | | `LeaveVehicleWhenSeatbeltIsOn` | `boolean` | If `false`, the player cannot exit the vehicle while buckled | *** ## ๐Ÿ–ผ๏ธ Visual Warning | Option | Type | Description | | --------------------------------- | --------- | -------------------------------------------------------------------------------------------------------- | | `ShowBlinker` | `boolean` | Show the seatbelt warning icon when the player is unbuckled | | `SetBlinkerPermanent` | `boolean` | If `true`, the icon stays visible permanently until the seatbelt is fastened. If `false`, it blinks | | `ShowBlinkerWhenVehicleIsStopped` | `boolean` | Show the warning even when the vehicle is stationary | | `BlinkerMinSpeed` | `number` | Minimum speed (km/h) to show the warning. Only applies when `ShowBlinkerWhenVehicleIsStopped` is `false` | *** ## ๐Ÿ”Š Sound | Option | Type | Description | | --------------- | --------- | ------------------------------------------------------------- | | `ActivateSound` | `boolean` | Play buckle/unbuckle sound effects when toggling the seatbelt | | `LoopSound` | `boolean` | Enable the looping alarm when driving unbuckled | | `Volume` | `number` | Volume of buckle/unbuckle sounds (`0.0` to `1.0`) | *** ## ๐Ÿ”” Notifications | Option | Type | Description | | --------------------- | --------- | --------------------------------------------------------------- | | `EnableNotifications` | `boolean` | Show a notification when the seatbelt is fastened or unfastened | | `NotificationsType` | `string` | Notification system to use. See values below. | ### **Notification type values:** | Value | Behavior | | ----------- | --------------------------------------------------------------------------------------------------------------------- | | `"default"` | Uses the native GTA V notification system | | `"auto"` | Detects automatically โ€” checks for **MS\_Madonne\_Notify** first, then **okokNotify**, then falls back to `"default"` | | `"custom"` | Uses your custom handler defined in `custom/notifs.lua` | ### **Notification strings:** ```lua Strings = { notification_title = "Seatbelt System", seatbelt_on = 'Seatbelt : ~g~set', seatbelt_off = 'Seatbelt : ~r~removed', }, ``` You can edit these strings to change the notification text and title. *** ## ๐Ÿ’ฅ Ejection Physics | Option | Type | Description | | ----------------------------- | --------- | ------------------------------------------------------------------------------------------- | | `DiffTrigger` | `number` | Speed difference threshold that triggers ejection. Lower = more sensitive. Default: `0.325` | | `MinSpeed` | `number` | Minimum vehicle speed (m/s) at which ejection can occur. Default: `13.9` (\~50 km/h) | | `VelocityMultiplicator` | `number` | Multiplier applied to the player's ejection velocity. Higher = further ejection | | `DisableEjectionWhenBreaking` | `boolean` | If `true`, ejection is disabled while the player is actively pressing the brake | *** ## ๐Ÿšจ Alarm | Option | Type | Description | | ---------------- | --------- | ------------------------------------------------------------- | | `AlarmEnabled` | `boolean` | Enable the seatbelt alarm system | | `AlarmOnlySpeed` | `boolean` | Only trigger the alarm when the vehicle is above `AlarmSpeed` | | `AlarmDuration` | `number` | Interval in **milliseconds** between each alarm sound loop | | `AlarmSpeed` | `number` | Minimum speed (km/h) to trigger the alarm | | `AlarmVolume` | `number` | Volume of the alarm sound (`0.0` to `1.0`) | *** ## ๐Ÿ’บ Per-Seat Ejection Whitelist The `DisallowEjectionFromSeats` table lets you prevent ejection for specific **seats in specific vehicles**. This is useful for police vehicles where passengers should never be ejected. ```lua DisallowEjectionFromSeats = { DisableAlarmInThisSituations = true, ["police"] = {-1, 1, 2}, ["policeb"] = {-1}, } ``` | Option | Type | Description | | ------------------------------ | --------- | ------------------------------------------------------------------------------ | | `DisableAlarmInThisSituations` | `boolean` | If `true`, the alarm and blinker are also hidden for whitelisted seats | | `["model"]` | `table` | Vehicle model name mapped to a list of seat indexes where ejection is disabled | > ๐Ÿ“– Seat index reference: [FiveM Natives โ€” GetPedInVehicleSeat](https://docs.fivem.net/natives/?_0x22AC59A870E6A669) > > `-1` = driver seat, `0` = front passenger, `1` = rear left, `2` = rear right, etc. *** ## ๐Ÿช Custom Hooks โ€” custom/main.lua Two empty functions are available in `custom/main.lua` for you to add your own logic when the seatbelt state changes: ```lua function FastenedSeatbelt() -- Called when the player fastens the seatbelt end function UnfastenedSeatbelt() -- Called when the player unfastens the seatbelt end ``` *** ## ๐Ÿ”” Custom Notifications โ€” custom/notifs.lua Used when `NotificationsType` is set to `"custom"`. Edit the two event handlers to implement your own notification logic: ```lua RegisterNetEvent("MS_MS_Seatbelt_Fastened_Notification") AddEventHandler("MS_MS_Seatbelt_Fastened_Notification", function() -- Your notification for seatbelt fastened end) RegisterNetEvent("MS_MS_Seatbelt_Unfastened_Notification") AddEventHandler("MS_MS_Seatbelt_Unfastened_Notification", function() -- Your notification for seatbelt unfastened end) ``` # Exports & Events Madonne Seatbelt exposes two **client-side exports** for integration with other resources, allowing you to read or control the seatbelt state programmatically. *** ## ๐Ÿ“ค GetSeatbeltStatus Returns the current seatbelt status of the local player. ```lua local isBuckled = exports['MS_Madonne_Seatbelt']:GetSeatbeltStatus() -- Returns: true (buckled) or false (unbuckled) ``` ### Example use case ```lua -- Prevent a player from exiting a vehicle if unbuckled if not exports['MS_Madonne_Seatbelt']:GetSeatbeltStatus() then TriggerEvent('chat:addMessage', { args = { "You must fasten your seatbelt before exiting!" } }) end ``` *** ## ๐Ÿ“ฅ SetSeatbeltStatus Forces the seatbelt state of the local player to a specific value. ```lua exports['MS_Madonne_Seatbelt']:SetSeatbeltStatus(status) ``` | Parameter | Type | Description | | --------- | --------- | ------------------------------------------------- | | `status` | `boolean` | `true` to force buckle, `false` to force unbuckle | ### Example use case ```lua -- Force buckle the player when entering a specific vehicle exports['MS_Madonne_Seatbelt']:SetSeatbeltStatus(true) -- Force unbuckle on player death exports['MS_Madonne_Seatbelt']:SetSeatbeltStatus(false) ``` > โš ๏ธ `SetSeatbeltStatus` only updates the internal state. It does not trigger the buckle/unbuckle sounds, notifications, or custom hooks. If you need those, trigger the seatbelt toggle manually through player input or use `FastenedSeatbelt()` / `UnfastenedSeatbelt()` in `custom/main.lua`. *** ## ๐Ÿช Custom Hook Functions Two functions in `custom/main.lua` are called automatically by the resource when the player toggles their seatbelt. You can add any logic inside them: ```lua function FastenedSeatbelt() -- Called every time the player buckles up -- Example: sync state to server, trigger animations, update HUD... end function UnfastenedSeatbelt() -- Called every time the player unbuckles end ``` *** ## ๐Ÿ“ก Custom Notification Events When `NotificationsType` is set to `"custom"`, the following client-side events are triggered: ```lua -- Triggered when the player fastens the seatbelt RegisterNetEvent("MS_MS_Seatbelt_Fastened_Notification") -- Triggered when the player unfastens the seatbelt RegisterNetEvent("MS_MS_Seatbelt_Unfastened_Notification") ``` These are already set up in `custom/notifs.lua` for you to fill in. # Common Errors ## ๐Ÿ”ด Players are not being ejected from vehicles **Cause 1:** The vehicle is in the `DisableSeatbeltsForThisVehicles` or `DisableSeatbeltsForThisVehcilesClasses` exclusion list. **Fix:** Remove the vehicle model or class from the exclusion list in `config.lua`. **Cause 2:** `DiffTrigger` is set too high, making the ejection threshold too insensitive. **Fix:** Lower the `DiffTrigger` value (e.g. from `0.325` to `0.2`) to make ejection trigger more easily. **Cause 3:** `MinSpeed` is set too high, so ejection never triggers at normal speeds. **Fix:** Lower the `MinSpeed` value. The default is `13.9` (approximately 50 km/h). Set it lower if needed. **Cause 4:** The player is in a whitelisted seat defined in `DisallowEjectionFromSeats`. **Fix:** Check the `DisallowEjectionFromSeats` table in `config.lua` and adjust the vehicle/seat entries as needed. *** ## ๐Ÿ”ด The seatbelt warning icon is not showing **Cause:** `ShowBlinker` is set to `false`. **Fix:** Set `ShowBlinker` to `true` in `config.lua`. *** ## ๐Ÿ”ด The alarm is not playing **Cause 1:** `AlarmEnabled` is set to `false`. **Fix:** Set `AlarmEnabled` to `true`. **Cause 2:** `AlarmOnlySpeed` is `true` and the vehicle speed is below `AlarmSpeed`. **Fix:** Either lower `AlarmSpeed` or set `AlarmOnlySpeed` to `false` to always play the alarm when unbuckled. *** ## ๐Ÿ”ด Notifications are not showing **Cause:** The configured `NotificationsType` resource is not running on your server. **Fix:** Either: * Set `NotificationsType` to `"auto"` to let the resource detect the best available system automatically * Set it to `"default"` to use the native GTA V notification system * If using `"custom"`, make sure your handlers are correctly defined in `custom/notifs.lua` *** ## ๐Ÿ”ด The resource loads but the seatbelt key does nothing **Cause:** The key binding may have been remapped or is conflicting with another resource. **Fix:** Check the FiveM key bindings in your game settings under `Settings > Key Bindings > FiveM` and look for the **"(Un)fasten seatbelt"** entry. Reset it to the default key if needed. *** ## ๐Ÿ”ด You lack the required entitlement to use MS\_Madonne\_Seatbelt This message indicates that your server does not have the necessary entitlement to start the resource. This is related to FiveM's **Escrow** protection system. Check the following points one by one: * โœ… The **CFX Portal key** listed in your `server.cfg` does not contain any typing error * โœ… The CFX Portal key belongs to the **FiveM account that was used to purchase or claim** the resource * โœ… The resource has been **successfully claimed** on the [CFX Portal](https://portal.cfx.re/) * โœ… The CFX Portal key linked to your server **belongs to you**, and not to your hosting provider > โš ๏ธ **Important warning about hosting provider keys** > > Some hosting providers include a shared CFX Portal key as part of their offers. We strongly advise against using such keys. A key that does not belong to you will block the use of **any resource protected by FiveM's Escrow system**, without exception โ€” not just this one. Always use your own personal CFX Portal key. *** ## ๐Ÿ’ฌ Still having issues? If you are still experiencing problems after following the steps above, feel free to reach out to us: * ๐Ÿ’ฌ **Discord:** [discord.gg/madonne](https://discord.gg/madonne) * ๐ŸŒ **Website:** [madonnestudio.com](https://madonnestudio.com/) * ๐Ÿ“ง **Email:** # Delete Gun Do you want to offer your administrators a simple, effective, and fun solution for deleting abandoned vehicles, peds, or any entity on the map? The **Delete Gun** is available for free!
*** ## ๐Ÿ“– About Delete Gun With the Delete Gun, all you have to do is **aim and shoot** at any entity using the configured weapon to instantly delete it from the server. No commands, no menus โ€” just point and fire. The resource is designed to be lightweight, flexible, and compatible with most FiveM server setups. *** ## โœจ Main Features * ๐ŸŽฏ **Aim & Shoot** โ€” Point the configured weapon at any entity and shoot to delete it instantly * ๐Ÿ”ซ **Configurable Weapon** โ€” Choose any weapon model to use as the delete gun * ๐Ÿ” **Flexible Permission System** โ€” Supports ACE permissions, MadonnAdmin, ESX, or a fully custom system * ๐Ÿงฉ **Multi-Mode Support** โ€” Configure multiple gun modes with different behaviors (delete, freeze, custom actionsโ€ฆ) * ๐Ÿ”” **Notification System** โ€” Compatible with default GTA notifications, chat, MS\_Madonne\_Notify, okokNotify, or a fully custom handler * ๐ŸŽ **Auto-Give Weapon** โ€” Automatically gives the weapon to authorized players on join * โš™๏ธ **ESX & ox\_inventory Compatible** โ€” Native support for ESX framework and ox\_inventory * ๐Ÿ› ๏ธ **Customizable Actions** โ€” Define your own client-side and server-side behaviors per mode *** ## ๐Ÿ”— Quick Links * [๐Ÿ“ฅ Installation](/free-scripts/delete-gun/installation) * [โš™๏ธ Configuration](/free-scripts/delete-gun/configuration) * [โ“ Common Errors](/free-scripts/delete-gun/common-errors) # Installation ## ๐Ÿ“‹ Requirements Before installing Delete Gun, make sure you have the following: * A **FiveM server** running on artifact `2699` or above * *(Optional)* `es_extended` if using the ESX framework * *(Optional)* `ox_inventory` if using ESX + ox inventory * *(Optional)* `MS_MadonnAdmin` if using MadonnAdmin for permissions *** ## โฌ‡๏ธ Step 1 โ€” Download the resource Download the latest version of **MS\_Delete\_Gun** from the [CFX Portal](https://portal.cfx.re/), the official Cfx.re platform for downloading your purchased resources. > ๐Ÿ’ก You must be logged in with the account used to purchase the resource. *** ## ๐Ÿ“ Step 2 โ€” Add to your server Copy the `MS_Delete_Gun` folder into your server's **resources directory**. ``` your-server/ โ””โ”€โ”€ resources/ โ””โ”€โ”€ MS_Delete_Gun/ โ”œโ”€โ”€ config/ โ”œโ”€โ”€ customs/ โ”œโ”€โ”€ framework/ โ”œโ”€โ”€ main/ โ””โ”€โ”€ fxmanifest.lua ``` *** ## ๐Ÿ“ Step 3 โ€” Add to server.cfg Add the following line to your `server.cfg`, **after** any dependency resources (ESX, ox\_inventory, MS\_MadonnAdmin): ```cfg ensure MS_Delete_Gun ``` > โš ๏ธ Make sure `MS_Delete_Gun` is started **after** any framework or inventory resource it depends on. *** ## โš™๏ธ Step 4 โ€” Configure the resource Open `config/main.lua` and configure the resource to match your server setup. Refer to the [โš™๏ธ Configuration](/free-scripts/delete-gun/configuration) page for a full breakdown of every option. *** ## ๐Ÿ” Step 5 โ€” Set up permissions Depending on the permission system you chose, you will need to grant access to your staff members. ### ACE Permissions *(default)* Add the following to your `server.cfg` for each admin group or player you want to grant access to: ```cfg add_ace group.admin madonne.deletegun allow ``` > The permission name `madonne.deletegun` can be changed in `customs/perms.lua`. ### MadonnAdmin If `MADONNADMIN` is set to `true` or `auto` and MS\_MadonnAdmin is running, permissions are handled automatically based on staff rank. No additional configuration needed. ### Custom Permission System Edit `customs/perms.lua` and implement your own logic inside the `GetPerms` function: ```lua function GetPerms(src) -- Your custom permission check here -- return true to grant access, false to deny return false end ``` *** ## ๐Ÿ”„ Step 6 โ€” Restart your server Restart your server or run the following command in the console: ``` refresh start MS_Delete_Gun ``` Your Delete Gun is now ready to use! โœ… # Configuration All configuration files are located in the `config/` and `customs/` folders. These files are **not escrowed** and can be freely edited. *** ## config/main.lua This is the main configuration file for the resource. ```lua CONFIG_DELETE_GUN = { FRAMEWORK = "none", INVENTORY = "ox", MADONNADMIN = "auto", INIT_DELAY = 1, PERMISSION_SYSTEM = "ace", ENABLE_MULTI_MODE = false, WEAPON_TO_USE = "WEAPON_RAYCARBINE", AUTOMATICALLY_GIVE_WEAPON = true, NOTIFICATION_TEXT = "Entity deleted !", NOTIFICATION_TITLE = "Delete Gun", NOTIFICATION_TYPE = "default", notifChatColor = {255, 255, 255}, } ``` *** ### ๐Ÿงฉ Framework & Inventory | Option | Values | Description | | ----------- | ------------------- | -------------------------------------------------------------------------------------------------- | | `FRAMEWORK` | `"esx"` \| `"none"` | Set to `"esx"` if your server uses ESX. Use `"none"` for standalone or other frameworks. | | `INVENTORY` | `"ox"` \| `"none"` | Only relevant if `FRAMEWORK` is `"esx"`. Set to `"ox"` if using ox\_inventory, `"none"` otherwise. | *** ### ๐Ÿ” Permissions | Option | Values | Description | | ------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `MADONNADMIN` | `"auto"` \| `"true"` \| `"false"` | Controls whether MadonnAdmin is used for permissions. `"auto"` will automatically detect if MS\_MadonnAdmin is running on your server. | | `PERMISSION_SYSTEM` | `"ace"` \| `"custom"` | Defines the permission system to use. If MadonnAdmin is enabled, this value is ignored. Use `"custom"` to implement your own logic in `customs/perms.lua`. | > ๐Ÿ’ก When using ACE, the default permission node is `madonne.deletegun`. You can change this in `customs/perms.lua`. *** ### โฑ๏ธ Initialization | Option | Values | Description | | ------------ | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `INIT_DELAY` | Integer *(seconds)* | Delay before the resource initializes and checks permissions on the client side. If MadonnAdmin is used, an additional 10-second delay is added on top of this value. | *** ### ๐Ÿ”ซ Weapon | Option | Values | Description | | --------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------- | | `WEAPON_TO_USE` | Any weapon name | The weapon model used as the Delete Gun. Default is `"WEAPON_RAYCARBINE"`. You can use any valid GTA V weapon name. | | `AUTOMATICALLY_GIVE_WEAPON` | `true` \| `false` | If `true`, the weapon is automatically given to authorized players when they join. | *** ### ๐Ÿ”” Notifications | Option | Values | Description | | -------------------- | ------------------------------------------------ | ----------------------------------------------------------------------- | | `NOTIFICATION_TEXT` | String | The message displayed to the player when an entity is deleted. | | `NOTIFICATION_TITLE` | String | The title of the notification (used by supported notification systems). | | `NOTIFICATION_TYPE` | `"default"` \| `"chat"` \| `"auto"` \| `"other"` | Controls how notifications are displayed. See details below. | | `notifChatColor` | `{R, G, B}` | Text color when `NOTIFICATION_TYPE` is set to `"chat"`. | #### **Notification types:** | Value | Behavior | | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | `"default"` | Uses the native GTA V notification system | | `"chat"` | Sends the notification as a chat message | | `"auto"` | Automatically detects a running notification resource โ€” checks for **MS\_Madonne\_Notify** first, then **okokNotify**, then falls back to `"default"` | | `"other"` | Triggers the `MS_DeleteGun_Notification` event, allowing a fully custom notification in `customs/notifs.lua` | *** ### ๐Ÿงฉ Multi-Mode | Option | Values | Description | | ------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------- | | `ENABLE_MULTI_MODE` | `true` \| `false` | Enables the multi-mode system, allowing the gun to have multiple behaviors. When enabled, refer to `config/modes.lua`. | *** ## config/modes.lua This file is only used when `ENABLE_MULTI_MODE` is set to `true`. ```lua DELETE_GUN_MODES = { ["CommandNameToChangeMode"] = "gunmode", ["CommandDescription"] = "Edit the mode of your tool gun", ["CommandNotify"] = "Gun mode changed to", ["1"] = { ModeName = "Delete Gun", AcePermissions = false, MadonnAdmin = {1,2,3,4,5}, NotificationText = "Entity deleted !", ClientSide = function(entity) -- Your client-side code here end, ServerSide = function(entity) DeleteEntity(entity) end, } } ``` | Option | Description | | ------------------------- | ---------------------------------------------------------------------------- | | `CommandNameToChangeMode` | The command (without `/`) used to cycle through modes in-game | | `CommandDescription` | Description shown in the chat suggestion | | `CommandNotify` | Prefix of the notification displayed when the mode changes | | `ModeName` | Display name of the mode | | `AcePermissions` | ACE permission node required for this mode, or `false` to disable | | `MadonnAdmin` | List of MadonnAdmin rank IDs allowed to use this mode, or `false` to disable | | `NotificationText` | Notification displayed when this mode is triggered | | `ClientSide` | Lua function executed **client-side** when the gun fires in this mode | | `ServerSide` | Lua function executed **server-side** when the gun fires in this mode | > โž• You can add as many modes as needed by duplicating the `["1"]` block and incrementing the key (`"2"`, `"3"`โ€ฆ). *** ## customs/notifs.lua Used when `NOTIFICATION_TYPE` is set to `"other"`. Edit this file to define your own notification handler: ```lua RegisterNetEvent("MS_DeleteGun_Notification") AddEventHandler("MS_DeleteGun_Notification", function(msg) -- Your custom notification code here exports['okokNotify']:Alert("Delete Gun", msg, 5000, 'error', true) end) ``` *** ## customs/perms.lua Used when `PERMISSION_SYSTEM` is set to `"custom"`. Edit the `GetPerms` function to implement your own permission logic: ```lua function GetPerms(src) -- return true to grant access, false to deny return false end ``` # Common Errors ## ๐Ÿ”ด The weapon is given but the gun doesn't delete anything **Cause:** The player has the weapon but doesn't have the required permissions. **Fix:** Make sure the permission system is correctly configured: * **ACE:** Check that `add_ace group.yourgroup madonne.deletegun allow` is present in your `server.cfg` and that the player is in the correct group. * **MadonnAdmin:** Ensure `MS_MadonnAdmin` is started **before** `MS_Delete_Gun` and that the player has a valid staff rank. * **Custom:** Verify that your `GetPerms` function in `customs/perms.lua` returns `true` for the player. *** ## ๐Ÿ”ด The weapon is not automatically given on join **Cause 1:** `AUTOMATICALLY_GIVE_WEAPON` is set to `false`. **Fix:** Set it to `true` in `config/main.lua`. **Cause 2:** The player doesn't have the required permissions, so the weapon is intentionally not given. **Fix:** Grant the player the correct permission (see above). **Cause 3 (ESX + ox\_inventory):** The `INVENTORY` option is not set correctly. **Fix:** Make sure `FRAMEWORK` is set to `"esx"` and `INVENTORY` is set to `"ox"` if you are using ox\_inventory. *** ## ๐Ÿ”ด Notifications are not showing up **Cause:** The `NOTIFICATION_TYPE` is set to a system that is not running on your server. **Fix:** Either: * Set `NOTIFICATION_TYPE` to `"auto"` to let the resource detect the available system automatically. * Set it to `"default"` to use the native GTA V notification. * If using `"other"`, make sure your custom handler is correctly defined in `customs/notifs.lua`. *** ## ๐Ÿ”ด Multi-mode command doesn't work **Cause:** `ENABLE_MULTI_MODE` is set to `false`. **Fix:** Set `ENABLE_MULTI_MODE` to `true` in `config/main.lua`, and make sure `config/modes.lua` is properly configured with at least one mode. *** ## ๐Ÿ”ด The resource loads but nothing happens (no weapon, no permissions) **Cause:** The `INIT_DELAY` may be too short, causing the resource to check permissions before the player is fully loaded. **Fix:** Increase the `INIT_DELAY` value in `config/main.lua` (e.g. set it to `3` or `5`). > โš ๏ธ If you are using MadonnAdmin, an additional **10-second delay** is always applied on top of `INIT_DELAY`. This is normal behavior. *** ## ๐Ÿ”ด `MS_Delete_Gun` throws errors on start **Cause:** A dependency resource is not started before `MS_Delete_Gun`. **Fix:** Make sure your `server.cfg` starts resources in the correct order: ```cfg ensure es_extended # if using ESX ensure ox_inventory # if using ox_inventory ensure MS_MadonnAdmin # if using MadonnAdmin ensure MS_Delete_Gun # always last ``` *** ## ๐Ÿ”ด You lack the required entitlement to use MS\_Delete\_Gun This message indicates that your server does not have the necessary entitlement to start the resource. This is related to FiveM's **Escrow** protection system. Check the following points one by one: * โœ… The **CFX Portal key** listed in your `server.cfg` does not contain any typing error * โœ… The CFX Portal key belongs to the **FiveM account that was used to purchase or claim** the resource * โœ… The resource has been **successfully claimed** on the [CFX Portal](https://portal.cfx.re/) * โœ… The CFX Portal key linked to your server **belongs to you**, and not to your hosting provider > โš ๏ธ **Important warning about hosting provider keys** > > Some hosting providers include a shared CFX Portal key as part of their offers. We strongly advise against using such keys. A key that does not belong to you will block the use of **any resource protected by FiveM's Escrow system**, without exception โ€” not just this one. Always use your own personal CFX Portal key. *** ## ๐Ÿ’ฌ Still having issues? If you are still experiencing problems after following the steps above, feel free to reach out to us: * ๐Ÿ’ฌ **Discord:** [discord.gg/madonne](https://discord.gg/madonne) * ๐ŸŒ **Website:** [madonnestudio.com](https://madonnestudio.com/) * ๐Ÿ“ง **Email:** # SASPR Pack Equip your Park Rangers in the most beautiful way thanks to our livery pack specially designed to dress up their vehicles.
Our pack is available for a total of 13 differents vehicles, the vehicle can be implemented on various vehicles, see compatibility test at the bottom
**Available vehicles :** * 2011 CVPI * 2014 TAHOE * 2016 FPIS * 2016 FPIU * 2016 RAM * 2018 SILVERADO * 2018 TAHOE * 2019 SILVERADO * Ford F150 * Ford F250 * John Deere Gator * Bell 412 * Brunswick
**Compatibility test :** [IMGUR Album](https://imgur.com/gallery/wU14daH) {% hint style="info" %} **DEPENDANCIES :** Vehicles that use the template used to make this livery pack {% endhint %} # How to install ? 1. After purchasing our resource via our Website, download the ZIP archive present in the email that was sent to you automatically. 2. Open the .zip file and go to the Livery folder and extract the files. 3. Open OpenIV and go inside the folder where your vehicle is installed. 4. With OpenIV open the .ytd files of your vehicle and find a texture named ( \[vehicle]\_sign\_1 ). 5. Replace this texture using the replace button by our livery corresponding to your vehicle. 6. Save and close.