PondoBot

a simple bot for Ponderosa High School hub discord servers invite me

Dont forget to read my Privacy Policy And follow my Terms Of Use

Features

random Presences whenever the bot starts some Commands

commands

a * after the sub-command indicates it requires authorization authorized users are users with MANAGE_GUILD in the server they are in or are on a special list here

help

sends a ephermral (hidden from other users) embed containg command names and help text

reload*

a command used by any whitelisted user

• bot reloads the bot via one of two methods (exit or service(requires a value in unifiedConfig.json))
• commands reloads global or guild commands (or all if no scope is specified)

classroom

command for linking email and classroom with the bot

• link run the first time to get a code then run and provide code to link (this is how you verify your email)
• unlink removes API tokens from your account and un-verified your email
• classes list your classes (can specify whether or not to use cached data)

students

command that involves student data current has 3 sub Commands

• set-grade - sets the grade you are in
• get-role - gives you your role if the server has been configured
• lookup - looks up stored information about a user

config*

command that configures variables for your server

• set-roles takes 4 optional arguments for each role (if left blank it will create roles for them)
• current shows current configs
• email sets the role for email-verified users
• show-message Config to show messages (whether or not to show ephemeral messages)

Fallback Mode

sometimes accidents happen and when those accidents are severe enough the bot enters fallback mode in fallback mode a few things happen

1. running /reload (or any sub-command) reloads the bot no matter permissions
2. all commands except /reload will return a message noting that the bot is in fallback mode and the current bot logs will be attached

Contribuiting

adding a command

commands are .js files placed in /commands a example command has been provided here as you can see the module has to export a dictionary containg values these values are as follows:

• data The command made by @discordjs/builders.SlashCommandBuilder
• helpStr The string shown when running /help
• canDeploy Boolean determining whether or not command can be sent to all servers the bot is in
• guildIds List of strings of guild ids, used when running guildCommand.js
• function the async function to be called when the command has been ran, it has two values passed to it first is the interaction second is the client

FAQ

can I run this bot for my school?

A: yes you just need to set the correct values in unifiedConfig.json a empty json looks like

{
	"DISCORD_TOKEN": "discord bot token to run the bot",
	"DISCORD_CLIENT": "your discord client id",
	"EMAIL_SUFFIX": "the part after the @ schools email ex: @eduhsd.k12.ca.us",
	"SERVICE": "optional systemd service for /reload bot method: service",
	"GoogleOAuth": "google OAuth2 desktop credentials json here"
}

then after those are set just run node guildCommands.js note: if you want to deploy to specific servers with the above command you need to specify it in the module.exports.guildIds of the command then node globalCommands.js