misc-cogs

Red v3 Cogs developed originally for Miru Bot, now for Tsubaki Bot.

Code should be pep8 formatted with a 100 character line limit.

Setting up your own Tsubaki instance for contributing code

Installing Tools

• Install Git (see the Red install link below if you need help doing this, or read any tutorial)
• Install Python 3.8 (see the Red install link below if you need help doing this, or read any tutorial)
• Familiarize yourself with how to use a command prompt and Git Bash (if you can't do this you will have a bad time)

Check out the repo

Fork this repo (you are probably already on the page, but if not go here. You will need a GitHub account to do this. Click the button that says "Fork" in the upper-right-hand corner of the page.

I suggest using PyCharm Community for development. Change into the PycharmProjects directory and clone your fork of the repo:

# Clone your repo, not this one!!!!!!!! You will want to load your own changes!!!!
git clone https://github.com/TsubakiBotPad/misc-cogs.git

Set up your bot

The installation instructions in Red's official documentation are pretty good. You will need to be prepared to do the following:

• Create a venv
• Install the Red library
• Create a Discord API key, make a bot, and associate it to your installation

Installation instruction links:

• Windows install instructions
• Linux/Mac install instructions

If you are running on a cloud server for the first time and aren't sure what Linux distro to pick, please, please, please, please, please pick Ubuntu. Their docs aren't well-tested on other distros.

Installing dependencies

First download requirements.txt so that you can run it from your Red venv. In Linux this is done by running the following from the directory holding the folder name-of-bot that you created during the Red setup process:

wget https://raw.githubusercontent.com/TsubakiBotPad/misc-cogs/master/requirements.txt

Then run:

source name-of-bot/bin/activate
pip install -r requirements.txt
deactivate

The rest of the guide takes place from inside Discord.

Configuring development version

Once the bot is launched, set it to use your repo directory as a cog path. Type this in Discord where the bot is:

!addpath $pathToYourRepoThatYouClonedBefore

Loading cogs

• Some cogs will have cross dependencies on each other. Check the command prompt that Tsubaki is running from or type ^traceback 1 if you encounter any errors.
• Common dependencies include:
  • rpadutils
  • dadguide
  • padinfo
• Note that when you edit cogs with dependencies, you might need to do multiple reloads. For example, if updating dadguide, you will need to reload padinfo as well.
• After you have done all of this, restart the bot again. Hopefully by now ^id should work!

Emoji

• You probably don't actually need emoji to be working in order to do development for Tsubaki.
• There are three emoji servers: the main Tsubaki support server, miru_extra_emoji, and miru_monsters_1. River has access to these, talk to her if you think you need access to them. HOSTING YOUR OWN TSUBAKI/MIRU CLONE IS NOT REASON TO GET ACCESS TO THEM. In-depth development of the ^id command may be reason to get access to them.
• You will use use ^padinfo setemojiservers with the IDs she gives you.