Skip to content

๐Ÿค– a custom Discord bot built on NodeJS for interacting between FiveM and Discord.

License

Notifications You must be signed in to change notification settings

Concept-Collective/ccDiscordWrapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

68 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Discord Status

๐ŸŽฎ ccDiscordWrapper - Discord โžก๏ธ FiveM

ccDiscordWrapper is a powerful resource that simplifies Discord integration for your FiveM server. It allows you to seamlessly connect your server to Discord, enabling exciting features for your community. Whether you want to send messages, retrieve player Discord information, or sync roles, ccDiscordWrapper has got you covered!

Documentation | Report Bug | Download Now

Discord Invite

๐ŸŽจ Showcase

Screenshots or videos of ccDiscordWrapper in action:

Screenshots

image|620x500

image|690x393

image|390x500




Dependency Note: Yarn

ccDiscordWrapper requires Yarn as a dependency for its proper functioning. However, there's no need to worry as Yarn is built into FiveM, and the server will automatically handle the installation.

You don't have to install Yarn separately. When you add ccDiscordWrapper to your resources folder and start your FiveM server, the server will handle the dependency and ensure smooth operation.

If you encounter any issues related to Yarn, please ensure you have the latest version of FiveM server artifacts installed and update your server accordingly.

โš ๏ธ Important Notice

If ccDiscordWrapper is a dependency for another resource, you can ignore this notice.

Please be aware that ccDiscordWrapper does not include any pre-written commands or chat messages. You'll need to create them yourself. This resource is designed for experienced scripters who have some knowledge of scripting. Only those familiar with scripting will receive support.

โœ… Features

  • Discord Message Sending: Send Discord messages using the configured Discord Bot Token or Webhook URL.
  • Player Discord Information: Retrieve in-game players' Discord Avatars and highest prioritized Discord Roles.
  • Discord Role Sync: Synchronize in-game roles with corresponding Discord roles.
  • Player Verification: Implement a user verification system to link players to their Discord accounts.
  • Customizable Chat Integration: Customize and integrate Discord chat with your FiveM server.
  • Server Status Updates: Send periodic status updates to a designated Discord channel.
  • Error Logging: Log server errors and critical events to a specified Discord channel.
  • Command Handling: Implement a command handling system to register and manage custom Discord commands.

๐Ÿ› ๏ธ Installation

Follow the official guide to install ccDiscordWrapper.

Download

Download the latest release here.

Install

  1. Create a new folder in your resources folder named ccDiscordWrapper.
  2. Extract the contents of the archive to your ccDiscordWrapper folder.
  3. Add start ccDiscordWrapper in your server.cfg.

๐ŸŒฑ Source Code

ccDiscordWrapper's source code is available on GitHub.

You are free to use and modify this code as long as you provide proper credit and never claim it as your own. Selling ccDiscordWrapper or any code derived from it is not allowed. If you create your own version, please link to the original GitHub repo or release it via a Forked repo.

We're thrilled to share ccDiscordWrapper with the FiveM community. Feel free to use it, experiment with it, and let us know your feedback!

Happy coding and Discord integration! ๐Ÿš€๐Ÿ˜„

Roadmap (Builtin Examples)

  • FiveM Player Count -> Discord Channel Embed โœ…
  • FiveM Player Count -> Discord Channel Name โœ…
  • Discord GuildMember Information -> FiveM โณโœ…
  • more integrations to come soon!

Support

For support, please join our Discord server.

Documentation

Coming Soon

Environment Variables

In order to run CC-discordStatus's Discord player count module, you will need to add the following environment variables to your env.js file

sv_config.Discord_Token

FAQ

Coming

Soon.

Coming

Soon.

License

MIT

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

Feedback

If you have any feedback, please reach out to us via our Discord.

Authors

Installation

Coming Soon

Features

  • Basic functionality โœ…
  • More to come!