padbot-cogs

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

Code should be PEP 8 formatted with a 120 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.

Note: If you are developing a cog that is in the misc-cogs repo, you may need to complete some steps for both pad-cogs AND misc-cogs.

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/padbot-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

You may want to perform the next step, "Installing dependencies," partway through the RED installation. The ideal time is immediately after you have created your venv, but before doing anything else.

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/padbot-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.  Replace ^ with your prefix.

Telling your bot where to find your cogs

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 path/to/repo/root

Note: you may have to do this for both pad-cogs and misc-cogs.

Loading cogs

• Some cogs will have cross dependencies on each other.  Use ^traceback 1 if you encounter any errors to see your traceback.
• Common dependencies include:
• dbcog
• padinfo

Emoji

• If you are doing in-depth development of the ^id command, you may need your bot invited to the emoji servers. River has access to these, talk to her.
• You will use ^padinfo emojiserver add with the IDs she gives you.

Cog list

Most cogs here relate to the mobile game 'Puzzle & Dragons'.

GitHub - TsubakiBotPad/pad-cogs: Cogs for a Discord bot related to the mobile game Puzzle & Dragons

Cogs for a Discord bot related to the mobile game Puzzle & Dragons - GitHub - TsubakiBotPad/pad-cogs: Cogs for a Discord bot related to the mobile game Puzzle & Dragons

GitHubTsubakiBotPad