Home

🏠 Home

Welcome to the Codex Black Market Wiki!

Codex Black Market is a dynamic FiveM script designed to enhance your role-playing server with an engaging black market system. This project offers interactive NPCs, item purchases, and real-time transaction logging.

📜 Project Overview

Introduction

Codex Black Market is a FiveM resource that introduces a sophisticated black market system. It includes features for managing item sales through NPCs, applying discounts, and integrating with Discord for real-time transaction notifications.

Features

• 🕵️‍♂️ Dynamic NPC Spawns: NPCs appear at random locations and times.
• 💸 Discount System: Apply and manage item discounts.
• 🌐 Webhook Notifications: Log transactions to Discord.
• 💰 Flexible Payment Options: Supports cash, bank, and black money.
• 🛠️ Lua 5.4 Compatibility: Updated for Lua 5.4.

Technologies Used

• FiveM (GTA V Modding Framework)
• ESX (EssentialMode Extended)

🛠️ Roadmap

Current Status

• Version 1.0: Initial release with basic features including NPC interactions, item purchases, and Discord notifications.
• Version 1.1: Planned updates for additional features and improvements.

Planned Features

• 🔄 Enhanced NPC Behavior: Improved NPC interaction and spawning logic.
• 🛡️ Advanced Discount System: More control over discount application.
• 🖥️ User Interface Enhancements: Improved UI for easier configuration and interaction.

Timeline

• Q1 2024: Release Version 1.1 with advanced NPC behavior and discount features.
• Q2 2024: Focus on UI enhancements and additional improvements.

⚙️ Installation

Requirements

• FiveM server with ESX framework installed.
• Access to server configuration files.

Setup Instructions

1. Download the Resource

   • Clone the repository or download the latest release from GitHub.

2. Add to Server Resources

   • Place the codex-blackmarket folder into your server’s resources directory.

3. Configure the Resource

   • Edit config.lua to set the WebhookURL, NPC locations, and item details.

4. Start the Resource

   • Add start codex-blackmarket to your server configuration file (server.cfg).

5. Restart Your Server

   • Reload or restart your server to apply the changes.

🚀 Usage

Getting Started

1. Find an NPC

   • Locate the black market NPCs that appear at various locations.

2. Open Interaction Menu

   • Interact with the NPC to access the black market menu.

3. Purchase Items

   • Choose items, apply discounts, and pay using cash, bank, or black money.

4. Check Discord Logs

   • Review transaction details sent to your configured Discord webhook.

Configuration

• NPC Locations: Set NPC spawn points in config.lua under Config.NPCs.
• Item Definitions: Define items and prices in Config.Items.
• Webhook Settings: Configure the Discord webhook URL in Config.WebhookURL.

---

How to Contribute

We welcome contributions to Codex Black Market! To contribute:

1. Fork the Repository: Create your own copy of the project.
2. Create a New Branch: Work on your feature or bug fix.
3. Make Changes and Test: Implement your changes and test thoroughly.
4. Submit a Pull Request: Provide a detailed description of your changes.

📚 Documentation

Architecture

Codex Black Market is designed with a modular approach, separating configuration, client-side, and server-side logic to ensure flexibility and ease of maintenance.

Common Issues

• Issue: Webhook not sending notifications

  • Solution: Verify the WebhookURL in config.lua and ensure the Discord webhook is correctly configured.

• Issue: NPC not spawning

  • Solution: Check Config.NPCs for correct coordinates and ensure server has necessary permissions for NPCs.

🌐 Community

Support

For support, please visit our GitHub Issues or join our Discord server for discussions and assistance.

Acknowledgements

• Contributor 1: For major contributions.
• Library: For providing essential tools and libraries.