TsubakiBotPad · RheingoldRiver · Sep 23, 2021 · Sep 24, 2021 · Sep 24, 2021 · Sep 24, 2021
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: tsubaki_bot
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: []
diff --git a/.gitignore b/.gitignore
@@ -136,3 +136,7 @@ bot_data/
 
 # 3way Merge
 .orig
+
+.DS_Store
+.vscode
+__pycache__
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 TsubakiBotPad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,236 +1,144 @@
-# miru-v3cogs
+# pad-cogs
 
-Red v3 Cogs developed for Miru Bot.
+**Important: You must use Python 3.8 for the setup!!** If you use an earlier or later version, things WILL break. It's not just convenient to be on the same version as us, it's mandatory.
 
-Code should be pep8 formatted with a 100 character line limit.
+# Setting up your own Tsubaki instance
 
-# Cog status
+## Prerequisites / Tools
 
-### Completed and tested
+- Install Git
+- Install Python 3.8
+- Familiarize yourself with how to use a command prompt and Git Bash (if you can't do this you will have a bad time)
 
-```
+[Red's Installation Guide](https://docs.discord.red/en/stable/install_guides/index.html) is a useful resource if you're a first timer.
 
-```
+I suggest using [PyCharm Community](https://www.jetbrains.com/pycharm/download) for development. Change into the
+`PycharmProjects` directory and clone your fork of the repo:
 
-### First pass completed
+## Check out the repo
 
-```
-automod2
-azurelane
-baduser
-calculator
-channelmod
-chronomagia
-dadguide
-damagecalc
-donations
-fancysay
-memes
-modnotes
-padboard
-padbuilds
-padevents
-padglobal
-padguidedb
-padinfo
-padmonitor
-padrem
-padsearch
-padvision
-profile
-rpadutils
-schoolidol
-seniority
-sqlactivitylog
-stickers
-streamcopy
-timecog
-translate
-trutils
-voicerole
-```
+Fork this repo (you are probably already on the page, but if not [go here](https://github.com/TsubakiBotPad/pad-cogs)).
 
-```
-# annoying
-speech
-```
+> Note: If you are developing a cog that is in the [misc-cogs repo](https://github.com/TsubakiBotPad/misc-cogs), 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.
 
+Git clone your forked repository.
 
+## Create a Discord Bot
 
+If you don't have one already, follow the instructions to create a bot in Red's official documentation:
 
+[Creating a bot account](https://docs.discord.red/en/stable/bot_application_guide.html#creating-a-bot-account)
 
-# Setting up your own Miru instance for contributing code
+Keep the bot `token` that you get from Discord at the end of the instructions handy - you will need it to set up the bot later.
 
-## Installing Tools
+## Installation
 
-* 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)
+1. Clone this repo (fork if you're contributing)
+1. Create a python 3 venv. `virtualenv -p python3 <envname>`
+1. Activate the venv.
+1. `pip install -r requirements.txt`
 
+The above steps install Red automatically. You can now follow the Red instructions to startup the bot:
 
-## Check out the repo
+[Setting Up and Running Red (macOS)](https://docs.discord.red/en/stable/install_guides/mac.html#setting-up-and-running-red)
 
-Fork this repo (you are probably already on the page, but if not [go here](https://github.com/nachoapps/miru-v3cogs). 
-You will need a GitHub account to do this. Click the button that says "Fork" in the upper-right-hand corner of the page.
+In command line:
 
-I suggest using [PyCharm Community](https://www.jetbrains.com/pycharm/download) for development. Change into the
-`PycharmProjects` directory and clone your fork of the repo:
+- `redbot-setup`
+- `redbot <bot_name>`
 
-```shell script
-# Clone your repo, not this one.
-git clone https://github.com/nachoapps/miru-v3cogs.git
+## Configure Your Bot
 
-# If you're just setting up a production bot, no need to do this. But you should create a directory and do:
-wget https://raw.githubusercontent.com/nachoapps/miru-v3cogs/master/requirements.txt
-```
+The rest of the guide takes place from inside Discord. Replace `^` with your prefix to talk to your bot.
 
-## Set up a virtualenv
+### Tell your bot where to find the code
 
-One way to install python 3.8:
+Once the bot is launched, set it to use your repo directory as a cog path. Type this in Discord where the bot is:
 
-```shell script
-sudo add-apt-repository ppa:deadsnakes/ppa
-sudo apt update
-sudo apt install python3.8
 ```
-
-Then set up your 3.8 venv:
-
-```shell script
-# Get inside your cloned repo.
-cd miru-v3cogs
-
-# Set up the venv.
-virtualenv --python=/usr/bin/python3.8 venv
-
-# Atlernatively, install python3.8-venv (possibly python3.8-distutils) and do:
-python3.8 -m venv venv
-
-# Activate your venv
-source venv/bin/activate
-
-# Install python deps, including Red.
-pip install -r requirements.txt
+^addpath path/to/repo/root
 ```
 
-## Set up Red Bot
+e.g
 
 ```
-# You will use the output from pwd in the next steps, so copy it
-pwd
-
-# Initial setup of bot
-redbot-setup
-
-# Use whatever you like below, this is my example
-bot name> miru_bot_test 
+^addpath /Users/Tsubaki/src/pad-cogs
+```
 
-# Replace current_dir with output from pwd
-data location> (current_dir)/bot_data
+> Note: you may have to do this for `pad-cogs`, `core-cogs`, and `misc-cogs`. If you have forked and cloned core & misc cogs, this process is the same! However, if you are only developing in `pad-cogs`, and installing `core-cogs` & `misc-cogs` from remote repos then:
+> 
+> 1. `^load downloader` (this cog is always installed by default)
+> 2. `^repo install misc https://github.com/TsubakiBotPad/misc-cogs`
+> 3. `^repo install core https://github.com/TsubakiBotPad/core-cogs`
+> 4. Now you can install, for example, the `menulistener` cog with `^repo install core menulistener`. The `menulistener` cog is what makes the `^id` menus interactive instead of single-panel static screens with unusable emoji below them.
 
-# Pick json for now
-storage backend> 1
+### Load cogs
 
-# Now start the bot, replace the bot name below
-redbot miru_bot_test
+Load relevant cogs (whichever cogs you are developing, `dbcog`, and `padinfo`) using the `^load` command.
 
-# Follow the directions to get your bot token
-# If copying from a v2 bot, the token is in data/red/settings.json
-bot token>  MjQxdzM53TE3MAM2NzA3NTg2.Xc4VVA.RIcv2Ndkxb<truncated>
+> Node: We suggest you load `dbcog` and `padinfo` so that you will have something to test that your bot installation correctly installed; however, if your development does not involve dbcog as a dependency, you may want to keep it unloaded (`^unload dbcog`, get it back with `^load dbcog` at any time), simply because it is very slow for the bot to initialize dbcog on startup, and you will be restarting your bot a lot during development.
 
-# Pick whatever you want but consider not overlapping with miru which uses ^
-prefix> !
 ```
+Syntax: ^load <cog 1> ... <cog n>
 
-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 (pwd output)
+e.g
+^load dbcog padinfo
 ```
 
+You can see which cogs you have loaded using the `^cogs` command.
 
+### Test a simple command
 
+You should now be able to run basic commands like `^id`
 
+```
+^id tsubaki
+```
 
+Should return something like:
 
+<img width="597" alt="image" src="https://user-images.githubusercontent.com/880610/173267597-3cbee890-8411-4ac4-b99e-200b273f63ec.png" />
 
+Happy developing!
 
+## Appendix
 
-## TODOs
-
-fork romkan and fix this so people don't keep having to do this
-
-* For Romanji/Kana conversion you will use Romkan. This is a bit tricky to install so we'll go over it first.
-    * If you want to skip this, you can locally comment out all calls to it, but this might be annoying when syncing your code if you're editing files that import it, so you should probably just do it. But if figuring this out is a barrier to entry to start actually coding, feel free to skip at least at the start.
-    * git clone [this repo](https://github.com/soimort/python-romkan) into any folder you want.
-    * Open setup.py in the text editor or IDE of your choice. Make the following replacement (basically add `encoding='utf8'` in 3 places):
-    ```python
-    here = os.path.abspath(os.path.dirname(__file__))
-    proj_info = json.loads(open(os.path.join(here, PROJ_METADATA), encoding='utf8').read())
-    README = open(os.path.join(here, 'README.rst'), encoding='utf8').read()
-    CHANGELOG = open(os.path.join(here, 'CHANGELOG.rst'), encoding='utf8').read()
-    VERSION = imp.load_source('version', os.path.join(here, 'src/%s/version.py' % PACKAGE_NAME)).__version__
-    ```
-    * Open a command line in this same directory and run `py setup.py install`
-
-## Setting up the bot
-
-* Some cogs will have cross dependencies on each other. Check the command prompt that Miru is running from 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!
+### Debugging
 
-## Other
+- Use `^traceback 1` if you encounter any errors to display them in discord.
 
 ### Emoji
-* If you want emojis in `^id` commands, and you are setting this up for DEV PURPOSES ONLY, you can talk to tactical_retreat about getting your bot invited to the emoji servers. If you want to make your own separate Miru instance though, you're on your own for that.
-* Give t_r your bot's invite link & ask him for the server IDs
-* Then use `^padinfo setemojiservers` with the IDs he gives you. The main Miru server is one of them, you can get that ID yourself.
-
-# Puzzle and Dragons
-
-Most cogs here relate to the mobile game 'Puzzle and Dragons'. Data is sourced from the
-DadGuide mobile app.
-
-| Cog        | Purpose                                                         |
-| ---        | ---                                                             |
-| damagecalc | Simple attack damage calculator                                 |
-| padboard   | Converts board images to dawnglare board/solved board links     |
-| padglobal  | Global PAD info commands                                        |
-| dadguide   | Utility classes relating to DadGuide data                       |
-| padinfo    | Monster lookup and info display                                 |
-| padrem     | Rare Egg Machine simulation                                     |
-| padvision  | Utilities relating to PAD image scanning                        |
-| profile    | Global user PAD profile storage and lookup                      |
-
-
-# Admin/util cogs
-
-Cogs that make server administration easier, do miscellaneous useful things, or
-contain utility libraries.
-
-| Cog            | Purpose                                                     |
-| ---            | ---                                                         |
-| baduser        | Tracks misbehaving users, other misc user tracking          |   
-| calculator     | Replacement for the calculator cog that doesnt suck         |  
-| fancysay       | Make the bot say special things                             |
-| memes          | CustomCommands except role-limited                          |    
-| rpadutils      | Utility library shared by many other libraries              |    
-| sqlactivitylog | Archives messages in sqlite, allows for lookup              |    
-| timecog        | Convert/print time in different timezones                   | 
-| trutils        | Misc utilities intended for my usage only                   |
-| twitter2       | Mirrors a twitter feed to a channel                         |
-
-
-# Other/deprecated cogs
-
-Cogs not intended for normal use, or superceded.
-
-| Cog            | Purpose                                                     |
-| ---            | ---                                                         |
-| donations      | Tracks users who have donated for hosting fees              |
 
+You may have noticed that emojis are replaced with placeholders in some commands. This is because the bot does not have access to the specific emojis.
+
+- If you are doing in-depth development of the `^id` command, your bot will need to be invited to the emoji servers. Talk to River to get access to these servers.
+
+- Once you and your bot have joined the servers, use `^padinfo emojiserver add <server_id_1> ... <server_id_n> ` with the IDs she gives you.
+
+### Cog list
+
+Most cogs here relate to the mobile game 'Puzzle & Dragons'.
+
+| Cog           | Purpose                                                         |
+| ------------- | --------------------------------------------------------------- |
+| azurlane      | Azur Lane card lookup                                           |
+| crowddata     | Crowdsourced data collection                                    |
+| crud          | Database editor. Not useful for bots other than prod Tsubaki    |
+| dbcog         | Central cog to host all PAD data                                |
+| dungeoncog    | A cog to search and get info for dungeons                       |
+| damagecalc    | Simple attack damage calculator                                 |
+| feedback      | A specialized feedback cog for Tsubaki specifically             |
+| monidlistener | A listener to give info for monster ids                         |
+| padboard      | Converts board images to dawnglare board/solved board links     |
+| padbuildimg   | Creates images of PAD teams via a special query language        |
+| padbuilds     | See user-made builds for dungeons i think??? (nobody uses this) |
+| padevents     | A scheduler cog to help players see upcoming daily GH dungeons. |
+| padglobal     | Global PAD info commands                                        |
+| padle         | A wordle-inspired monster guessing game                         |
+| padinfo       | Monster lookup and info display                                 |
+| padmonitor    | Keeps an eye out for PAD updates                                |
+| pipelineui    | Interface for running the pipeline (Tsubaki-only)               |
+| pricecheck    | Lumon's thing. Something about stamina trade equivalence        |
+| profile       | Global user PAD profile storage and lookup                      |
diff --git a/__init__.py b/__init__.py
diff --git a/api/__init__.py b/api/__init__.py
@@ -0,0 +1,13 @@
+import json
+from pathlib import Path
+
+from api.apicog import APICog
+
+with open(Path(__file__).parent / "info.json") as file:
+    __red_end_user_data_statement__ = json.load(file)['end_user_data_statement']
+
+
+async def setup(bot):
+    n = APICog(bot)
+    bot.add_cog(n) if not __import__('asyncio').iscoroutinefunction(bot.add_cog) else await bot.add_cog(n)
+    n.bot.loop.create_task(n.entrypoint())