Skip to content

Latest commit

 

History

History
143 lines (130 loc) · 8.32 KB

README.md

File metadata and controls

143 lines (130 loc) · 8.32 KB

NOTICE: With the release of text channels in voice channels, any version of discord.js older than v13.8.0 will crash upon creating. I am aware of this and do plan on updating the code to to prevent the crashes..

FiveM Server Status

A custom discord bot providing functionality for interacting with FiveM & Discord servers.

Need Help?

Notices:

  • Please make sure you Google your errors before joining the support server. I don't have time to help you setup the bot. Google is your friend make use of it.... stack overflow is very handy!
  • The FiveM Queue script that was included the original repository is no longer needed to run this project
  • If you are unable to get the bot to query your server please make sure you check that the IP address and port for you server are correct in the config.json file before asking for support
    • Also make sure your firewall on your host isn't blocking inbound connections
  • If you get an error in console saying (node:121108) UnhandledPromiseRejectionWarning: TypeError: fields.flat is not a function you'll need to update your Node.js version. I have provided a link-to that explains how to update your Node.js version here
  • If you get an error in console saying ! Make sure you have the latest version of node.js and npm installed. you'll need to make sure both your NPM & Node.js is on the latest version. I have provided a link-to that explains how to update your NPM version here and Node.js version here

Creating a Bot Application

  1. Open https://discord.com/developers/applications and sign in
  2. Click the button that says 'New Application' in the top right hand corner of the page
  3. Enter a name for your bot
  4. In the menu on the left side of the page click 'Bot' then click 'Add Bot'
    • If you don't want random users to invite your bot, uncheck the feature that says 'Public Bot' on the bot page
  5. Your new bot's token will display under the name field and you can click 'Copy' to copy the token to your clipboard

Inviting a Bot

  1. Open https://discord.com/developers/applications and sign in
  2. In the menu on the left side of the page make sure you are on 'General Information'
  3. Locate the 'APPLICATION ID' and click copy
  4. With the ID you just copied insert it into the URL below where 'APPLICATIONID' is; then open the link

Setup

  1. Add the included fivemqueue script to your server resources
  2. Start the fivemqueue in your server.cfg
  3. Set enviroment variables as described below in a config.json file
Variables Description Required?
URL_SERVER Base URL for the FiveM server e.g. http://127.0.0.1:3501 (don't end with /) Yes
SERVER_NAME The name of your FiveM server Yes
SERVER_LOGO A logo for your FiveM server No
EMBED_COLOR Color of the status embed Yes
PERMISSION Permission needed to set the server status +status Yes
LOG_LEVEL Number 0-4 specifying level of logs 4 = No Logs Yes
BOT_TOKEN Discord bot token Yes
CHANNEL_ID Channel ID that will be used for updates to be pushed to Yes
MESSAGE_ID Message ID of previous update to edit No
SUGGESTION_CHANNEL Channel that will create suggestion embeds in Yes
BUG_CHANNEL Channel that will recieve bug reports Yes
BUG_LOG_CHANNEL Channel that will log bug reports Yes
LOG_CHANNEL Channel that will log status changes Yes
RESTART_TIMES Will display restart times for the server Yes
Example of the config.json file

All variables must be filled for the bot to work properly!

{
    "URL_SERVER": "http://127.0.0.1:30120",
    "SERVER_NAME": "BaySide RP",
    "SERVER_LOGO": "https://cdn.discordapp.com/icons/820669620339998770/cdbc882432a90b72ee921f57643526fa.webp?size=128",
    "EMBED_COLOR": "#b434eb",
    "LOG_LEVEL": "2",
    "PERMISSION": "MANAGE_MESSAGES",
    "BOT_TOKEN": "[BOT TOKEN HERE]",
    "CHANNEL_ID": "617873518960574464",
    "MESSAGE_ID": "828635715121840178",
    "SUGGESTION_CHANNEL": "617873319609368669",
    "BUG_CHANNEL": "617873444238786617",
    "BUG_LOG_CHANNEL": "657070256925442058",
    "LOG_CHANNEL": "617873550648279051",
    "RESTART_TIMES": "12am, 1pm, 3pm"
  }

List of permissions for the PERMISSION variable in the config.json file

Permission Description
ADMINISTRATOR Implicitly has all permissions, and bypasses all channel overwrites
CREATE_INSTANT_INVITE Create invitations to the guild
KICK_MEMBERS Allows kicking members
BAN_MEMBERS Allows banning members
MANAGE_CHANNELS Edit and reorder channels
MANAGE_GUILD Edit the guild information, region, etc.
ADD_REACTIONS Add new reactions to messages
VIEW_AUDIT_LOG Allows for viewing of audit logs
PRIORITY_SPEAKER Allows for using priority speaker in a voice channel
STREAM Allows the user to go live
VIEW_CHANNEL Allows guild members to view a channel, which includes reading messages in text channels
SEND_MESSAGES Allows for sending messages in a channel
SEND_TTS_MESSAGES Allows for sending of /tts messages
MANAGE_MESSAGES Delete messages and reactions
EMBED_LINKS Links posted will have a preview embedded
ATTACH_FILES Allows for uploading images and files
READ_MESSAGE_HISTORY View messages that were posted prior to opening Discord
MENTION_EVERYONE Allows for using the @everyone tag to notify all users in a channel, and the @here tag to notify all online users in a channel
USE_EXTERNAL_EMOJIS Use emojis from different guilds
VIEW_GUILD_INSIGHTS Allows for viewing guild insights
CONNECT Connect to a voice channel
SPEAK Speak in a voice channel
MUTE_MEMBERS Mute members across all voice channels
DEAFEN_MEMBERS Deafen members across all voice channels
MOVE_MEMBERS Move members between voice channels
USE_VAD Use voice activity detection
CHANGE_NICKNAME Allows for modification of own nickname
MANAGE_NICKNAMES Change other members' nicknames
MANAGE_ROLES Allows management and editing of roles
MANAGE_WEBHOOKS Allows management and editing of webhooks
MANAGE_EMOJIS Allows management and editing of emojis

How to start/run the bot

Make sure you are in the directory where the bot files are located before running the following commands!

Way #1 Way #2ㅤ
1. npm i 1. npm install
2. npm start 2. node ./index.js

Commands

Command Description
+status <Message> Adds a warning message to the server status embed
+status clear Clears the warning message
+help Displays the bots commands

Example Embed

Screenshot

Credits

Name URLS Other
Sky https://github.com/TheONLYGod1 | https://godsnetwork.live God's Groove
Roque https://github.com/RoqueDEV
Douile https://github.com/Douile
Drazero https://github.com/draZer0
Queue script https://github.com/anderscripts/FiveM_Queue