Domas_RPXP

Domas_RPXP: Advanced Experience System for FiveM

Overview

Domas_RPXP System is a robust and customizable experience (XP) system for FiveM, designed to provide a seamless and feature-rich progression system for your role-playing server. This script manages player XP, allowing server administrators to reward, query, and adjust XP for players dynamically

Features

1. Player Progression:

   • Gain XP through various in-game activities.
   • Automatically calculates player levels based on configurable XP thresholds.

2. Database Integration:

   • Supports multiple database frameworks: mysql-async, oxmysql, and ghmattimysql.
   • Easily configurable for compatibility with your preferred database.

3. Real-time XP Updates:

   • Set, add, or remove XP in real-time through server-side exports.
   • Updates client-side XP for seamless integration with in-game systems.

4. Passive XP System:

   • Optionally enable a passive XP system to reward players for staying active on the server.
   • Customize the amount of XP, cooldown time, and frequency of passive rewards.

5. Admin Commands:

   • Grant administrators the ability to check, set, add, and remove XP for themselves and other players.
   • Configurable admin commands and permissions for fine-tuned control.

6. Debugging and Notifications:

   • Choose between different debug modes to monitor system behavior.
   • Configurable notification types: chat, notify, or print for XP-related events.

Usage

1. Player Connection:

   • Players are automatically registered in the RPXP system when they connect to the server.
   • Existing players have their XP loaded from the database, creating a seamless experience.

2. XP Commands:

   • Players can check their own XP using the /checkxp command.
   • Administrators can check other players' XP using the /admincheckxp command.

3. Admin Control:

   • Administrators can set, add, and remove XP from players using /setxp, /addxp, and /removexp commands, respectively.

4. Passive XP:

   • Enable or disable the passive XP system in the configuration (Config.PassiveXP).
   • Configure passive XP amount, cooldown, and frequency to suit your server's needs.

Installation Guide

1. Database Setup:

   • Create a table named Domas_RPXP with columns id (int), identifier (varchar), and xp (int) using your preferred database management tool.

2. Configuring Database Options:

   • Set the desired database option (mysql-async, oxmysql, or ghmattimysql) in the Config.Database variable.

3. Configuring Passive XP:

   • Adjust the Config.PassiveXP, Config.PassiveAmount, and Config.PassiveCooldown variables to tailor the passive XP system to your server's needs.

4. Command Permissions:

   • In your server.cfg, grant the necessary ACE permissions for admin commands: csharpCopy code

add_ace group.admin domas_setxp allow add_ace group.admin domas_addxp allow add_ace group.admin domas_removexp allow

5. Publishing to the Forums:
   • Share the script with the FiveM community by creating a forum post. Provide comprehensive documentation, and encourage users to customize the system to suit their server's unique requirements.

Configuration Options (Config.lua):

• Debug Mode (Config.Debug):

  • Toggle debug mode to monitor system behavior.

• Database Framework (Config.Database):

  • Choose from mysql-async, oxmysql, and ghmattimysql for database integration.

• XP Check Command (Config.CheckXPCommand):

  • Set the command for players to check their own XP (/checkxp by default).

• Admin Commands (Config.AdminCheckCommand, Config.SetXpCommand, Config.AddXpCommand, Config.RemoveXpCommand):

  • Configure commands for admins to check, set, add, and remove XP.

• Passive XP Settings (Config.PassiveXP, Config.PassiveAmount, Config.PassiveCooldown):

  • Customize the passive XP system to reward players for staying active.

Feedback

For feedback, or feature requests, please visit our FiveM forum thread

Support and Updates

The Domas_RPXP system is designed to be easily adaptable, but if you encounter any issues or have suggestions for improvements, feel free to reach out. Regular updates and support will be provided to ensure the system remains a valuable addition to your FiveM server.

Happy role-playing!