Skip to content
/ zdiscord Public

A Discord bot that runs in FiveM for the purpose of whitelisting, moderation and utilties using discord.js

License

Notifications You must be signed in to change notification settings

zfbx/zdiscord

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

zdiscord (v4)

Note: this is an older and slightly less focused build of zdiscord built around the eris discord framework. Future work will be put into the djs branch which is built around the discord.js framework and uses slash commands. if you are running FiveM artifacts before 4800 you will have to stick with this version

MIT License Donate on PayPal Sub on Patreon Buy Me a Pizza

A Discord whitelist (allowlist) and moderation tool

I've not seen many decent whitelist systems out there that connect with discord and the good ones seem to use oauth but I wanted more.. specifically I wanted to be able to have a full blown bot built in and be able to have bi-directional communication between the server and discord, so here it is!

Features

  • Completely standalone, no dependencies or need for running external applications
  • Commands to see online users, info, etc
  • Moderation commands to kick someone or everyone
  • Send server wide announcements from a command in discord
  • Easy to translate and customize with locales!
  • Built in !help command for discord (prefix may be different if you changed it in your config)
  • Easy to expand and customize with modular commands!
  • Supports QBCore! Included: !revive, !jail, !giveitem, !kill, !setjob and more!

Support

Before we get into the setup I just want to say, I've built and polished this resource from the ground up for free and open sourced it for you. If you enjoy it and would like to send a thanks I have a ko-fi, Paypal and I even have a Patreon! Any and all support is greatly appreciated but in no way manditory, all my resources will be free and open source :)

How to use

All the config options for this module are to be set inside your server .cfg file

  1. Copy the inner zdiscord directory into your fiveM resources directory
  2. Add ensure zdiscord (or whatever you renamed it to) to your server's .cfg
  3. Adjust the config.js variables to how you'd like them.
  • MAKE SURE TO ENABLE Presence Intent AND Server Members Intent ON THE DISCORD BOT SETTINGS OR THE BOT WONT START! (Getting really tired of seeing tickets and questions about this when it's in the setup guide and FAQ) Picture

More detailed Setup Guide

Languages

  • en - English - By zfbx
  • de - Deutsch / German - By Anonymous
  • pl - Polish - By insaneArian
  • vn - Vietnamese - By xenfovn
  • ar - Arabic - By RadhwaneDZ
  • tr - Turkish - By alp1x

FAQ

Moved to FAQ Wiki Page

Change log

4.0.0 - permissions! bye yarn!.. and esx.

  • Dependencies are now embeded libs making the project slimer on install and not requiring yarn.
  • ESX support was dropped, it wasn't getting used and I don't have an esx server for testing.
  • translations were slimmed down to fivem messages only.
  • add/removepermissions merged into perms command
  • Convars changed to be more readable using standard FiveM format with _ spacing

3.2.0 - Convars everywhere!

  • Convar hooks added for nearly every config option Read More
  • Slimmed up locales by removing console log messages
  • Added {{prefix}} to the global variables
  • New Add/Remove permissions command for QBCore

3.1.0 - QBCore (potential ESX) support added

  • Commands starting with qb- will load automatically if QBCore is detected.
  • Placeholders for esx- commands have been added.

3.0.0 - Modular commands!

  • Commands are now loaded dynamically from the /commands folder
  • Help command now has sub commands !help commandName
  • New DM command
  • various Error checks and fixes

2.0.0 - Github Release

  • polished standalone
  • Added translation support

1.0.0 - First unsupported build

  • A lot.

License

I'm releasing this under the MIT License asking only that you preserve my credit (zfbx) in whatever you do with it :)