A bot for Conaticus' Discord server. A document of the development process has been made here: https://www.youtube.com/watch?v=xq2jR3_msmk.
- Clone/Fork the repository
- Run
cd boolean
In order to setup the bot, you must create a .env
in the parent directory as you can see in the example, .env.example.
In this file you must declare the bot's TOKEN
- this is the token from the Discord Developer Portal.
Syntax:
TOKEN="your bot's TOKEN"
This will automatically be ignored from the .gitignore. So don't worry about this data being public.
For Docker users, simply run docker-compose up
after configuring the
env file.
To update your install of Boolean run docker-compose down
to bring
Boolean down and build again using docker-compose up --build
. Make sure
to pull down latest changes from git using git pull origin master
or use
the built-in script scripts/update.sh
.
- Run
npm i
In order to start the bot, you must run npm run dev
to run the TypeScript developer environment. Don't worry about the other package.json
scripts, they are for production.
Due to many of the values being hardcoded, in order to run your instance you will need to change some values - such as the guildId
in config.ts
as it is used for deploying slash commands.
General: "#5E81AC"
Success: "#A3BE8C"
Error: "#BF616A"
Configuration can be performed via the /config
command to set special roles
and channels that the bot identifies and utilizes.
- 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("")
-Embed : logger.channel(<EMBED>, <CHANNEL>)
Look at CONTRIBUTING.md to find out how you can help contribute to the development of this bot.
If you like cool coding projects like this, subscribe to me at https://www.youtube.com/channel/UCRLHJ-7b4pjDpBBHAUXEvjQ Help the community with a simple ⭐