Skip to content

Home

Jump to bottom
CustomCodex edited this page Aug 17, 2024 · 1 revision

🏠 Home

Welcome to the Codex-Flitsmeister Wiki!

Codex-Flitsmeister is a dynamic FiveM script designed to enhance your role-playing server with advanced speed monitoring and notification systems. This project provides real-time speed alerts, dynamic camera management, and detailed logging of speeding events.

📜 Project Overview

Introduction

Codex-Flitsmeister is a FiveM resource that introduces an advanced speed monitoring system. It includes features for tracking player speed, managing speed camera locations, and integrating with Discord for real-time event logging.

Features

  • 🏎️ Real-Time Speed Monitoring: Monitors player speed and provides alerts when exceeding the limit.
  • 📍 Dynamic Speed Cameras: Mobile and fixed cameras with visible map blips.
  • 🔔 Customizable Notifications: Configure alerts with cooldown periods to avoid spamming.
  • 🌐 Webhook Logging: Log speeding events with detailed information to Discord.
  • 📜 In-Game Menu: Toggle notifications and adjust settings via an in-game command.

Technologies Used

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

🛠️ Roadmap

Current Status

  • Version 1.0: Initial release with core features including speed monitoring, camera management, and webhook logging.
  • Version 1.1: Planned updates for enhanced notification features and UI improvements.

Planned Features

  • 🚦 Advanced Camera Management: Improved management of mobile and fixed cameras.
  • 📈 Enhanced Notification System: More control over notification settings and triggers.
  • 🖥️ User Interface Improvements: Better UI for in-game menu and configuration options.

Timeline

  • Q1 2024: Release Version 1.1 with enhanced camera management and notification features.
  • Q2 2024: Focus on UI improvements and additional features based on user feedback.

⚙️ 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-flitsmeister folder into your server’s resources directory.

  3. Configure the Resource

    • Edit config.lua to set your WebhookURL, camera locations, and notification preferences.

  4. Start the Resource

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

  5. Restart Your Server

    • Reload or restart your server to apply the changes.

🚀 Usage

Getting Started

  1. Locate Cameras

    • Mobile and fixed cameras will appear on the map if enabled in the configuration.

  2. Monitor Speed

    • Receive alerts when exceeding the set speed limit.

  3. Use In-Game Command

    • Use /flits to open a menu for toggling notifications and adjusting settings.

  4. Check Discord Logs

    • Review detailed logs of speeding events sent to your configured Discord webhook.

Configuration

  • Camera Locations: Set camera spawn points in config.lua under Config.MobileCameras and Config.FixedCameras.
  • Notification Settings: Configure notification preferences and cooldowns in config.lua.
  • Webhook Settings: Set the Discord webhook URL in Config.WebhookURL.

How to Contribute

We welcome contributions to Codex-Flitsmeister! 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-Flitsmeister 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: Notifications not appearing

    • Solution: Check the Config.SpeedingNotificationCooldown setting and ensure notifications are enabled.

🌐 Community

Support

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

Clone this wiki locally