Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twotau/discordspartabot
A friendly bot for the Skyline Spartabots' Discord server
https://github.com/twotau/discordspartabot
bot discord nodejs
Last synced: 14 days ago
JSON representation
A friendly bot for the Skyline Spartabots' Discord server
- Host: GitHub
- URL: https://github.com/twotau/discordspartabot
- Owner: TwoTau
- License: mit
- Created: 2017-10-12T04:33:07.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T19:27:33.000Z (almost 2 years ago)
- Last Synced: 2023-02-27T18:25:45.706Z (over 1 year ago)
- Topics: bot, discord, nodejs
- Language: TypeScript
- Homepage:
- Size: 1.34 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Discord SpartaBot
SpartaBot is a Discord bot made by [@TwoTau](https://github.com/twotau) using [discord.js](https://discord.js.org "discord.js home page"). This repository contains all the source code for the bot. If you want to fork this and run it yourself, follow the instructions in [Creating a config file](#creating-a-config-file).
## (Partial) List of commands
See the [commands folder](commands/) for a full list of commands.
### info ``
Returns info about the mentioned member or if no member is mentioned, the author of the message.
Screenshot of `!info spartabot` (with discriminator and User ID removed):
### repeat ``
Repeats the message and then deletes the author's message.
### when ``
Will tell you how much time there is until an event. The events are specified in `config.events`.
Screenshot of `!when kickoff`:
### togglerole ``
Removes or adds a role from the author of the message. The role name must be in `config.toggleable_roles`;
### eval ``
Executes JavaScript. This command can only be used by the bot creator, specified by `config.bot_creator` and requires that `config.options.allow_eval_command` is true.
### purge ``
Delete the last _n_ comments. This command can only be used by admins, specified by `config.admin_role`. If `config.options.restrict_purge_to_bot_creator` is false, then this command can only be used by the bot creator.
The bot also sends a quote from the dystopian novels _Farenheit 451_ or _Nineteen Eighty-Four_ to discourage abuse of this command.
Screenshot of `!purge 30`:
### log ``
Returns the history of the person's sign-ins and outs. This depends on the sign-in database being used (AKA `config.firebase_db_url`).
- _If argument is specified_
- _If the author is an admin_
- Sends partial data in the same channel.
- Sends the full sign-in history in the same channel.
- _Else (author not an admin)_
- Sends partial data in the same channel.
- _Else (no argument is specified)_
- Sends partial data in the same channel.
- Direct messages the author their full sign-in history.
### tophours
Sends a list of the top nine people with the most hours.
Screenshot of `!tophours` with placeholder names and hours:
### subtracthours `` `
Screenshot of `!subtracthours "Vishal Devireddy" "1:00"`:
### tbateam ``
Returns information about a team using [TheBlueAlliance's API](https://www.thebluealliance.com/apidocs) given the team number.
Screenshot of `!tbateam 2976`:
### emoji `` ``
Sends an animated emoji and deletes the author's message. Only works with animated emoji. The number to repeat can be between 1 and 10.
### kys
Terminates the program. This command can only be used by the bot creator.
### help ``
Returns a list of the non-hidden commands along with a description and example usage of each.
Screenshot of `!help`:
Screenshot of `!help tbateam`:
## Creating a config file
You will need to create a `config.json` file in this folder with secret keys and tokens for SpartaBot. See [config-example.json](config-example.json) for a template. To find Discord user and channel IDs, [turn on Developer Mode](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-) in Discord.
You will also need a `serviceAccountKey.json` for accessing your Firebase database. You can download one from your Firebase project > Settings > Service accounts > Firebase Admin SDK.
The keys in `config.json` are:
- `discord_token`: The Discord bot token you find in the [Discord Developer panel](https://discordapp.com/developers/applications/me).
- `tba_auth_key`: TheBlueAlliance API key that you find in your [TheBlueAlliance account page](https://www.thebluealliance.com/account).
- `firebase_db_url`: The URL for the Firebase database that contains the sign-in data.
- `hours_log_webhook_url`: The Discord webhook URL to send subtract hours log messages to.
- `github_repo`: The ending part of the GitHub url for your fork of this repository. For example: `twotau/DiscordSpartaBot`.
- `debug_channel_id`: The Discord channel ID for a debug channel as a string. If this is specified, SpartaBot will send some logging messages to this channel.
- `bot_creator`: The Discord user ID for the creator of the bot. This is used for eval permission and when determining whether a user has permissions to do something.
- `new_member_role`: The Discord role ID of the role SpartaBot will assign to members that join the server.
- `other_team_role`: The Discord role ID of the role given to those of other teams. Users with this role are restricted in some ways, such as not being able to use the togglerole or log commands.
- `admin_role`: The Discord role ID of the role given to those that can mass purge messages (if `options.restrict_purge_to_bot_creator` is false) and have access to members' full hour logs.
- `options`: An object containing the following properties:
- `prefix`: The characters that a message needs to start with for SpartaBot to recognize the message as a command. Common prefixes are `!` and `?`.
- `allow_eval_command`: A boolean for whether SpartaBot can respond to the eval command if sent by the bot's owner. This is very dangerous because it allows the bot's owner to execute any code.
- `enable_log_command`: A boolean for whether users can use the log command (should only be true for the build season).
- `restrict_purge_to_bot_creator`: A boolean for whether only the bot creator can use the purge command. If false, anyone with the `admin_role` can use purge.
- `automated_message`: An object containing values relevant to automated messages:
- `open_door_message`: The message to send when someone asks for the build room door to be opened.
- `toggleable_roles`: An object containing the name of the toggleable roles as the keys and the Discord role IDs (in string format) as the values.
- `events`: An object containing the short name of the events as the keys and objects (with the event name and ISO timestamp) as the values. For example:
- _short argument name_: An argument for the when command.
- `name`: The full name of the event.
- `timestamp` the ISO date time. For example: "2018-02-20T20:59:00.000".