Skip to content
This repository has been archived by the owner on Jul 8, 2023. It is now read-only.

Latest commit

 

History

History
39 lines (24 loc) · 2.04 KB

README.md

File metadata and controls

39 lines (24 loc) · 2.04 KB

Blasebot


A Discord bot for Blaseball.

Features

(this section is being rewritten)

Privacy

No personal data is stored in the database, only channel IDs, guild IDs, and the IDs of any blaseball teams are stored.

Forbidden Knowledge

Warning! This code contains some forbidden knowledge, which can demystify the game of blaseball. Look at the code at your own risk!

Invite Bot

You can invite Blasebot to your server using this link. This link is also shown by using the bot's /info command.

Running the bot

With Docker

To run the bot with docker, firstly you must copy sample.env to .env and fill in the relevant fields, docker will override dbUrl so you do not need to worry about that one! After that, you can simply run docker-compose up --build, this will start the container.

Without Docker

If you wish to run the bot without docker, you will need to use Node 14.5.0 minimum. To run the bot make sure to run npm install to install all packages. You can then configure a file named config.json at the top level of the directory. See sample.config.json for how to configure the bot. Once the config file has been created, run node command-json/updateCommands from the top directory to register the bot's slash commands with Discord. Blasebot uses a Mongoose database to store subscriptions – if you are running the bot locally, leave MongoDB (mongo) running in the background before starting up the bot.

Once everything is set up, you can run Blasebot with node bot/main from the top directory.

Contributing

When contributing, be aware of current versions. develop is for new features, main is live. all new features need to be tested before moving to main.

Semantic Versioning Guide: Small changes like minor bug fixes and new weather events: Patch New Features: Minor Rewrites: Major