Skip to main content

Introduction

CC-discordStatus

ccDiscordWrapper is an open-source custom Discord bot built on Node.js, specifically designed for seamless interaction between FiveM and Discord. If you're developing a FiveM server and want to enhance the communication and integration with your Discord community, ccDiscordWrapper is the perfect solution.

Features​

  • Real-time Interaction: ccDiscordWrapper facilitates real-time communication between your FiveM server and Discord, ensuring your players stay connected and informed.

  • Customizable Commands: Easily create and manage custom commands that can be executed directly from Discord, making server management and interaction more user-friendly.

  • Player Statistics: Display player stats, server status, and other relevant information directly in your Discord server for easy monitoring.

  • Event Notifications: Get notified in Discord when specific events occur in the FiveM server, such as player joins, disconnects, or significant incidents.

  • Rich Presence Integration: ccDiscordWrapper supports rich presence integration, allowing your Discord community to see in-game activities of players.

How to Use​

Follow these steps to set up ccDiscordWrapper for your FiveM server:

  1. Automatic Installation:

    • ccDiscordWrapper can be automatically installed using FiveM's yarn dependency manager. Simply add ensure ccDiscordWrapper to your server's server.cfg file, and FiveM will handle the installation process for you.

  2. Configuration:

    • All necessary configuration files are already included in the repository.
    • Open config.jsonc and adjust the settings to fit your server's needs. This file contains well-organized configurations for easy customization.
    • Rename env.example.js to env.js and provide the required sensitive variables, such as your Discord Bot Token and Discord Webhook URL.

  3. Invite the Bot:

    • Create an invite link for your bot on the Discord Developer Portal. You can find detailed instructions in Discord's developer documentation.
    • Invite the bot to your Discord server using the generated link.

  4. Customize and Expand:

    • Feel free to customize the bot's functionality by modifying the code to suit your server's needs.
    • Refer to the documentation for detailed explanations of the available commands and features.

Contribution Guidelines​

We welcome contributions to ccDiscordWrapper! If you'd like to contribute to the project, please follow these guidelines:

  • Fork the repository and create a new branch for your contribution.
  • Ensure your code adheres to the established coding standards.
  • Submit a pull request, and our team will review your changes.

Feedback and Support​

If you encounter any issues or have suggestions for improving ccDiscordWrapper, feel free to open an issue on GitHub. We appreciate your feedback and are dedicated to making this project as useful as possible.

License​

ccDiscordWrapper is released under the MIT License, making it open and free for anyone to use and modify.

Thank you for choosing ccDiscordWrapper for your FiveM server's Discord integration! We hope this bot enhances the communication and overall experience for your community. Should you need any assistance or have questions, don't hesitate to reach out. Happy gaming!