RPMTW-Discord-Bot-python

Index

• RPMTW-Discord-Bot-python
  • Index
  • Pre requirements
  • Basic setup
  • Deploy
  • Development
  • Features

Pre requirements

• Python version >= 3.11.x (stable)
  • Unix user can use pyenv
  • Windows user can use pyenv-win or download from here
• Poetry (Package Manager)

Basic setup

1. Clone Repo

   Clone repo to your local machine.

2. Install Dependencies

   poetry install
   

   If you want to have a better development experience, it is recommended to use the following commands instead.

   poetry install --with dev
   

3. Update .env file

   Insert your discord bot token and universe chat token into ./.env. Sample file can be found at here.

Then you can launch bot with following command:

poetry shell
python main.py

Deploy

If you want let bot run on production mode, you can add '-P' (which means production) to cli args.

poetry shell
python main.py -P

• This will result in the following changes
  • Keep the log level at WARNING
  • Disable debug extra init (won't automatically add Development cog)

Features

• General
  • hello - say Hello to user
  • info - show bot's information
• Chef
  • chef user - chef someone
  • chef rank - show chef rank
• FAQ
  • faq <question> - show the faq
• Dynamic Voice Channel
• Universe Chat
  • Sync message between universe chat and Discord