fizzify / boolean

Boolean

About

Boolean is a Discord bot for the Conaticus' Discord server. Boolean contains a collection of useful modules for your server, like a mod mailing system, a custom role menu, etc. Want to see how Boolean was made? Watch the development process here

Setup and configuration guide

Requirements

- Postgres Server
- Node v16x or above

Installation with Docker

If you don't have a server, you can use Docker to host the bot. You can simply use the docker-compose up command to start the bot.

If you need to update the bot, you can use the docker-compose down command to stop the bot, and then use the docker-compose up --build command to start it again or make sure to pull down latest changes from git using git pull origin master or use the built-in script scripts/update.sh.

Installation

If you have all the requirements for hosting the bot, please follow the next step carefully!

1. Clone this repository to your computer, or to your vps.

git clone https://github.com/conaticusgrp/boolean

2. Copy the contents of the .env.example file to the .env file and fill in the values. (Make sure you have declared the bots token in the .env file!)
3. Create a new database with your MYSQL server, and make sure you have the correct credentials in the .env file.
4. Run the following command to install the dependencies:

npm install

5. Run the following command to start the bot:

npm run dev

Configuration

Configuration can be performed via the /config command to set special roles and channels that the bot identifies and utilizes.

Logging

Console levels and their references

• Fatal : logger.console.fatal("")
• Error : logger.console.error("")
• Warn : logger.console.warn("")
• Info : logger.console.info("")
• Debug : logger.console.debug("")
• Trace : logger.console.trace("")
• Silent : logger.console.silent("")

Channel logging

-Embed : logger.channel(<EMBED>, <CHANNEL>)

Contributing

Look at the CONTRIBUTING to find out how you can help contribute to the development of this bot.

Support

If you have any questions, please join the Discord or open an issue here on GitHub.

Youtube

If you like cool coding projects like this, subscribe to Conaticus