PokéBlob

You are currently on the post-event branch of PokéBlob. It is being primarily maintained and developed by Gorialis. It is: Incomplete Unstable Subject to change at any time Schema and internal changes may be made without prior warning or instruction. Any data collected or stored by the bot as it is on this branch may be irrecoverably destroyed or inaccessible by even a single commit. Only run the bot to debug its features or commands. In addition: Do not push directly to this branch. Unauthorized direct pushes will be rebased out. Only PR to this branch if you have seeked guidance regarding implementation and design beforehand. Do not rely on the branch history to remain linear. Rebases may require you to reset any clones you have of this branch.

PokéBlob is the bot created by the Blob Emoji team for the 1 year server anniversary. It requires Node >=9.4 and the discord.js library.

It is not recommended to run an instance of this bot yourself. The code is here primarily for reference and bug fixing.

Prerequisites

This project has a number of requirements for deployment:

• git and npm, for installing dependencies
• A PostgreSQL >=9.6 server to store data
• Docker and docker-compose (Optional)

Running the Bot

Launch with Node

First, install all dependencies.

npm install

After all the dependencies install, copy the config.example.yml included in the root directory. Rename it to config.yml and substitute information in as necessary.

And the bot will launch.

Launching with docker-compose

First, copy the config as above. Once your config is ready, just run

docker-compose up

This will build and start the bot. If you need to rebuild the bot, just use:

docker-compose down
docker-compose rm -f
docker-compose build --no-cache
docker-compose up

Common Errors

If you get an error saying the bot cannot find a package, you simply need to run the following, replacing package name with the name of the package.

npm install <package name>

License

PokéBlob is released under the MIT License.