Home

Codex-PoliceArmory

🏠 Overview

Codex-PoliceArmory is a FiveM ESX-based police armory system designed to enhance the role-playing experience by allowing players to purchase and return weapons. The system integrates with Discord for logging events and supports custom configurations.

🔑 Key Features

• 🔫 Weapon Management: Purchase and return weapons through an in-game menu.
• 💬 Discord Integration: Logs weapon transactions to Discord.
• 👮‍♂️ Custom NPC Interactions: Interaction with a Dutch police NPC.
• 📝 Detailed Logging: Includes player information and weapon details.

Installation Guide

🛠️ Prerequisites

• FiveM Server with ESX framework
• MySQL Database
• Discord Webhook URLs

📥 Steps

1. Download the Resource

   • Clone or download the repository from GitHub.
   • Extract and place the Codex-PoliceArmory folder in your server’s resources directory.

2. Database Setup

   • Import the provided SQL schema into your MySQL database.
   • Ensure tables user_weapons and police_armory are created.

3. Configure the Resource

   • Open config.lua and set the NPCCoords and NPCHeading to your desired values.
   • Replace placeholder webhook URLs in server/main.lua with your actual Discord webhook URLs.

4. Start the Resource

   • Add start Codex-PoliceArmory to your server configuration file (server.cfg).
   • Restart your FiveM server.

5. Testing

   • Ensure the NPC appears at the designated location.
   • Test weapon purchase and return functionality.
   • Check Discord for webhook messages.

Configuration

📍 config.lua

• NPCCoords: Coordinates where the NPC will spawn.
• NPCHeading: Heading direction of the NPC.

4. Roadmap

Planned features and improvements for the project.

Roadmap

🚀 Current Version

• Weapon purchase and return functionality
• Discord webhook integration
• Basic NPC interactions

📅 Planned Features

• Advanced NPC interactions: Custom dialogues and responses.
• Weapon customization: Allow players to modify weapon components.
• Extended logging: More detailed logging and analytics.
• UI Enhancements: Improved menus and user interface elements.

🕰️ Future Considerations

• Support for multiple languages
• Integration with other FiveM resources
• Performance optimizations

FAQ

🤔 How do I customize the NPC appearance?

The NPC appearance is defined by the model used in client/main.lua. You can replace 'a_m_y_police_01' with any other model you prefer.

🛠️ What should I do if the NPC doesn’t spawn?

Check the coordinates and heading values in config.lua. Ensure the NPC model is loaded correctly.

💰 How can I adjust weapon prices?

Modify the price value in the buyWeapon function in server/main.lua.

💬 Where can I get help if I encounter issues?

• Check the Issues page on GitHub.
• Join our Discord server for community support.