bits4kids-Bot

About

The bits4kids-Discord bot helps Coding Trainers manage Online Coding Clubs on the bits4kids-Discord Server.

Features

• Auto-Role-Assignment based on invites
• XP and level system
• VoiceLog system: Attendance tracking
• Automatic Discord event management system using Google Sheets API
• Offer a simplified experience for Discord beginners
• Various fun commands

Setup Guide

1. Clone this repository using git
2. Install Node.js
3. Run npm install in the project folder
4. Copy config.sample.json to config.json
5. Configure all options in config.json
   • To get your Discord token, you will need to create a new Discord application
   • To obtain an OpenWeatherMap API key, you will need an account on their site
6. Copy badgeLevelconfig.sample.json to badgeLevelconfig.json
7. Configure all options in badgeLevelconfig.json as preferred
   • To create custom badges, an image file has to be placed in the badges folder and its filename referenced in the fileName property
   • For each guild, a set of roles corresponding to the badges should be created. For each badge object, rename the property name(s) of the roleIDs object to the guild ID(s). Then, the ID of each role has to be referenced in the guild ID property of the roleIDs object of the corresponding badge object.
   • The badge name and level hurdle for each badge can be chosen freely
   • There is no limitations in the amount of badges
   • The badges do not have to be in any specific order
8. Copy OCCconfig.sample.json to OCCconfig.json
9. Configure all options in OCCconfig.json as preferred
   • The spreadsheet ID can be obtained using the Google Drive URL of the Google Sheets file
10. Register a Google service account using the Google Cloud Console, then create a private key and save it as credentials.json in the project folder
11. Run the bot using node index.js