abheekd
/
awesomescibo
mirror of https://github.com/ADawesomeguy/AwesomeSciBo
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
41 Commits
6 Branches
34 Tags
2.4 MiB
 
 
 
Tree: 9bfd15fecc
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '9bfd15fecc'
${ noResults }
Abheek 9bfd15fecc
Center shields and title 		4 years ago
.github/workflows Update Dockerfile with environment variables and add Docker CI 4 years ago
bot Update package.json for npm publish 4 years ago
images Add LICENSE, README, and cleanup files 4 years ago
.gitignore Initial commit 4 years ago
Dockerfile Update Dockerfile with environment variables and add Docker CI 4 years ago
LICENSE Add LICENSE, README, and cleanup files 4 years ago
README.md Center shields and title 4 years ago

README.md

AwesomeSciBo

A simple Discord bot that automatically generates Science Bowl rounds using the ScibowlDB API!

Deployment

Deploying this bot to your Discord server is relatively simple: you can add it to your own server by using this link.

Contributing

If you want to make a contribution to this bot, please make a Pull Request with as much detail as you can. I'll take a look in my free time and see if it's worth adding. If not, I'll let you know what to do to make it worth adding!

Installation

There are three ways to install this on your own server: using npm, cloning this repository, or using Docker.

Note: make sure you have node installed on your system (unless you plan to use Docker). This varies from computer to computer, but make sure you have the right version installed. Generally, versions older than 12.X don't work properly.

RECOMMENDED

Option 1: NPM

Steps

  1. Install the package with npm
sudo npm i -g awscibo
  1. Run the command (learn how to get your token here)
awscibo [your token here]

Option 2: Clone repository

Steps

  1. Clone repo:
git clone https://github.com/ADawesomeguy/AwesomeSciBo.git
  1. Enter repo and install dependencies
cd AwesomeSciBo/bot && npm i
  1. Run your bot:
node awesomescibo.mjs

Option 3: Dockerfile

Steps

  1. Clone repo
git clone https://github.com/ADawesomeguy/AwesomeSciBo.git
  1. Enter repo, build, and run Docker image
cd AwesomeSciBo
docker build -t awscibo .
docker run -e BOT_TOKEN=[your bot token here] --name awscibo -d awscibo

Usage

To get started, run the command do be helping to get a list of commands. The more helpful commands will be the ones that generate packets, which are do be roundgen pdf/html and do be roundgen pdf/html dm.

Note: if you plan to use PDF files, you must have gotenberg installed and running at localhost:3136 (or change the awesomescibo.mjs script to point to a different location). You can find more info about that here.

Notes

Creating a Discord Application/Bot

To create your own application and bot using the Discord Developer Portal, go to the previous link and sign in. Then create a new application, and click bots on the left. Configure it to your liking, and then copy the token.

That's the most important part of your bot and don't share it with anyone.

Credit

The bot was made by @ADawesomeguy. However, the API was made by @CQCumbers. Go give his API a star, he totally deserves it!