Skip to content

Latest commit

 

History

History
94 lines (60 loc) · 6.47 KB

readme.md

File metadata and controls

94 lines (60 loc) · 6.47 KB
Raw

zdiscord (v7)

Note: zdiscord v7 and high REQUIRE FiveM artifacts build 4890 or newer
zdiscord v5-6 REQUIRES artifacts 4800 or newer.
Older artifacts will require use of the v4 eris branch instead.

Setup | Donate | FAQ | Support | Docs

About

A Discord bot that runs in FiveM for the purpose of whitelisting, moderation and utilities using discord.js. The goal is for this this resource to be easy to setup and expand upon while giving your staff team an easy method of support and moderation of players in game without actually launching FiveM. This resource also heavily support QBCore in most of it's functionality but it's not required

Features

  • Standalone FiveM resource (no external hosting required)
  • Uses Slash commands with help/suggestions
  • Moderation tools (kick, ban, inspect, etc)
  • QBCore commands included!
  • Easy to expand and customize with modular commands!
  • Can be configured with convars
  • Automatic Ace Permission granting system
  • Helpful exports
  • bi-directional staff chat
  • AND MORE!

Setup

Requirements

  • FiveM artifacts build 4890 or higher
  • cfx-server-data in your resources (yarn ([system]/[builders]/yarn/) at least)
  • Optional: screenshot-basic if you want the /screenshot command to work

Steps

  1. Get a bot application if you haven't already Guide Here

  2. IMPORTANT: Enable BOTH intents on the bot page of step 1 (Picture example) *If you don't do this.. your bot will NOT work.

  3. Add the bot to your server - To do this copy the following link and replace YOUR-BOT-ID with your bots ID then follow the invite process to your discord from the link https://discord.com/api/oauth2/authorize?client_id=YOUR-BOT-ID&permissions=8&scope=bot%20applications.commands
    NOTE: If the bot is already in your server you might need to run the link above again anyways to make sure it can get the needed slash command scope (unrelated to permissions)

  4. Copy the resource into your fiveM resources directory and make sure it's named zdiscord (no -main or anything)

  5. Double check that you have the cfx-server-data resource in your resources (or yarn [system]/[builders]/yarn/ at the very least)

  6. In your server.cfg do the following:
    6a. Add ensure zdiscord (after qb-core and/or convars you may have)
    6b. Add the following anywhere in your .cfg:

    add_ace resource.zdiscord command allow
add_ace group.zdiscordstaff zdiscord.staffchat allow

  7. Adjust the config.js variables to how you'd like them. (Optionally use Convars)

  8. If you missed step 2, go back and do it.. or else IT WONT WORK!

  9. If you run into any errors check out the FAQ where a lot of common problems are listed and answered

Support

Please note we only support the official, free and open source, QBCore framework and not old "qbus" or paid copies of QBCore

If you have any errors or problems please first check:

If neither of those solve your problem Open a ticket or message me on Discord (My name is Tony#1275 on discord)

Donate

I've built and polished this resource from the ground up for free and open sourced it for everybody. If you use it, enjoy it, get support from me or just want to support the project please consider sending a tip or donation through any of the following platforms:

Donate on PayPal Sub on Patreon Buy Me a Pizza

Any contribution is greatly appreciated but you're amazing regardless ♥

License

Note: as of version 7.0.0 zdiscord, it is licensed under CC-BY-NC-SA-4.0

zdiscord © 2021 by zfbx is licensed under Attribution-NonCommercial-ShareAlike 4.0 International

TL;DR

  • BY: Credit must be given to me, the creator. (Tony/zfbx)
  • NC: Only noncommercial use of your work is permitted. (You can use in your own FiveM server which may make money itself BUT can't in any way sell zdiscord itself in any way for any commercial advantage or monetary compensation)
  • SA: Adaptations must be shared under the same terms.