- Added hardware cog section, Added .fix command for ifixit lookup (#…

…1313)

cogs/assistance-cmds/hardware/guides.hardware.md

@@ -0,0 +1,8 @@
+---
+title: IFixIt Repair Guides
+help-desc: Links to ifixit guides
+aliases: guide
+thumbnail-url: https://guide-images.cdn.ifixit.com/igi/nG1MvGbrC2wopi5H.full
+---
+
+https://www.ifixit.com/Guide

cogs/assistance-cmds/hardware/ipa.hardware.md

@@ -0,0 +1,9 @@
+---
+title: Isopropyl Alcohol
+help-desc: Explains what IPA is
+thumbnail-url: https://i.imgur.com/Mfw1Se3.jpeg
+aliases: Isopropyl, Iso, Isopropol
+---
+
+Isopropyl Alcohol or IPA is a good cleaning agent for use with electronics. It's safe to use on circuit boards. When using
+avoid any loose fluid / drops, by soaking a q-tip or microfiber cloth. It will damage LCD's and some plastic coatings.

cogs/assistancehardware.py

@@ -0,0 +1,180 @@
+from __future__ import annotations
+
+import logging
+from os.path import dirname, join
+from typing import TYPE_CHECKING
+
+import discord
+from discord.ext import commands
+
+from utils.mdcmd import add_md_files_as_commands
+from utils.utils import KurisuCooldown, simple_embed
+
+if TYPE_CHECKING:
+    from kurisu import Kurisu
+    from utils.context import KurisuContext
+
+logger = logging.getLogger(__name__)
+
+consoles = {
+    # Microsoft
+    'xbox': 'https://www.ifixit.com/Device/Xbox',
+    'xbox360': 'https://www.ifixit.com/Device/Xbox_360',
+    'xbox360s': 'https://www.ifixit.com/Device/Xbox_360_S',
+    'xbox360e': 'https://www.ifixit.com/Device/Xbox_360_E',
+    'xbox1': 'https://www.ifixit.com/Device/Xbox_One',
+    'xbox1s': 'https://www.ifixit.com/Device/Xbox_One_S',
+    'xbox1sdigital': 'https://www.ifixit.com/Device/Xbox_One_S_All_Digital_Edition',
+    'xbox1x': 'https://www.ifixit.com/Device/Xbox_One_X',
+    'xboxSeriesS': 'https://www.ifixit.com/Device/Xbox_Series_S',
+    'xboxSeriesX': 'https://www.ifixit.com/Device/Xbox_Series_X',
+    # Nintendo
+    'nes': 'https://www.ifixit.com/Device/Nintendo_Entertainment_System',
+    'snes': 'https://www.ifixit.com/Device/Super_Nintendo',
+    'xbox360s': 'https://www.ifixit.com/Device/Xbox_360_S',
+    'n64': 'https://www.ifixit.com/Device/Nintendo_64',
+    'gamecube': 'https://www.ifixit.com/Device/Nintendo_GameCube',
+    'famiconDisk': 'https://www.ifixit.com/Device/Nintendo_Famicom_Disk_System',
+    'famicon': 'https://www.ifixit.com/Device/Nintendo_Family_Computer_%28Famicom%29',
+    'wiifamily': 'https://www.ifixit.com/Device/Nintendo_Wii_2011',
+    'wiimini': 'https://www.ifixit.com/Device/Nintendo_Wii_mini',
+    'wiiu': 'https://www.ifixit.com/Device/Nintendo_Wii_U',
+    'gameboy': 'https://www.ifixit.com/Device/Game_Boy',
+    'gameboyAdvance': 'https://www.ifixit.com/Device/Game_Boy_Advance',
+    'gameboyAdvanceSP': 'https://www.ifixit.com/Device/Nintendo_Game_Boy_Advance_SP',
+    'gameboyColor': 'https://www.ifixit.com/Device/Game_Boy_Color',
+    'gameboyMicro': 'https://www.ifixit.com/Device/Game_Boy_Micro',
+    'gameboyPocket': 'https://www.ifixit.com/Device/Game_Boy_Pocket',
+    'ds': 'https://www.ifixit.com/Device/Nintendo_DS',
+    'dsLite': 'https://www.ifixit.com/Device/Nintendo_DS_Lite',
+    'dsi': 'https://www.ifixit.com/Device/Nintendo_DSi',
+    'dsiXL': 'https://www.ifixit.com/Device/Nintendo_DSi_XL',
+    '2ds': 'https://www.ifixit.com/Device/Nintendo_2DS',
+    '3ds': 'https://www.ifixit.com/Device/Nintendo_3DS',
+    '3dsXL': 'https://www.ifixit.com/Device/Nintendo_3DS_XL',
+    'new3ds': 'https://www.ifixit.com/Device/Nintendo_3DS_2015',
+    'new3dsXL': 'https://www.ifixit.com/Device/Nintendo_3DS_XL_2015',
+    'new2dsxl': 'https://www.ifixit.com/Device/New_Nintendo_2DS_XL',
+    'switch': 'https://www.ifixit.com/Device/Nintendo_Switch',
+    'switchOLED': 'https://www.ifixit.com/Device/Nintendo_Switch_OLED_Model',
+    'switchLite': 'https://www.ifixit.com/Device/Nintendo_Switch_Lite',
+    'joycons': 'https://www.ifixit.com/Device/Joy-Con',
+    'proController': 'https://www.ifixit.com/Device/Switch_Pro_Controller',
+    # Sega
+    'segaCD': 'https://www.ifixit.com/Device/Sega_CD',
+    'dreamcast': 'https://www.ifixit.com/Device/Sega_Dreamcast',
+    'gamegear': 'https://www.ifixit.com/Device/Sega_Game_Gear',
+    'genesis': 'https://www.ifixit.com/Device/Sega_Genesis',
+    'genesis2': 'https://www.ifixit.com/Device/Sega_Genesis_II',
+    'saturn': 'https://www.ifixit.com/Device/Sega_Saturn',
+    'genesis3': 'https://www.ifixit.com/Device/Sega_genesis_3',
+    'masterSystem': 'https://www.ifixit.com/Device/Sega_Master_System',
+    'masterSystem2': 'https://www.ifixit.com/Device/Sega_Master_System_II',
+    'nomad': 'https://www.ifixit.com/Device/Sega_Nomad',
+    #
+    'playstation': 'https://www.ifixit.com/Device/PlayStation',
+    'playstation2': 'https://www.ifixit.com/Device/PlayStation_2',
+    'playstation2slim': 'https://www.ifixit.com/Device/PlayStation_2_Slimline',
+    'playstation2slim75x': 'https://www.ifixit.com/Device/PlayStation_2_Slimline_SCPH-7500x',
+    'playstation2slime9x': 'https://www.ifixit.com/Device/PlayStation_2_Slimline_SCPH-9000X',
+    'playstation3': 'https://www.ifixit.com/Device/PlayStation_3',
+    'playstation3slim': 'https://www.ifixit.com/Device/PlayStation_3_Slim',
+    'playstation3superslim': 'https://www.ifixit.com/Device/PlayStation_3_Super_Slim',
+    'playstation4': 'https://www.ifixit.com/Device/PlayStation_4',
+    'playstation4slim': 'https://www.ifixit.com/Device/PlayStation_4_Slim',
+    'playstation4pro': 'https://www.ifixit.com/Device/PlayStation_4_Pro',
+    'playstation5': 'https://www.ifixit.com/Device/PlayStation_5',
+    'playstation5slim': 'https://www.ifixit.com/Device/PlayStation_5_Slim',
+    'playstationSlim': 'https://www.ifixit.com/Device/PlayStation_One',
+    'pspe': 'https://www.ifixit.com/Device/PSP_E1000',
+    'vita': 'https://www.ifixit.com/Device/PlayStation_Vita',
+    'psportal': 'https://www.ifixit.com/Device/PlayStation_Portal',
+    'vitaSlim': 'https://www.ifixit.com/Device/PS_Vita_Slim',
+    'psp1000': 'https://www.ifixit.com/Device/PSP_1000',
+    'psp2000': 'https://www.ifixit.com/Device/PSP_2000',
+    'psp3000': 'https://www.ifixit.com/Device/PSP_3000',
+    'pspgo': 'https://www.ifixit.com/Device/PSP_Go',
+    # Steam
+    'steamdeck': 'https://www.ifixit.com/Device/Steam_Deck',
+    'steamdeckOLED': 'https://www.ifixit.com/Device/Steam_Deck_OLED',
+    # Misc
+    'wonderswan': 'https://www.ifixit.com/Device/Bandai_WonderSwan',
+    'rog-ally': 'https://www.ifixit.com/Device/Asus_ROG_Ally',
+}
+alias = {
+    "xboxone": "xbox1",
+    "xbox1sd": "xbox1sdigital",
+    "wiifam": "wiifamily",
+    "gb": "gameboy",
+    "gba": "gameboyAdvance",
+    "gbsp": "gameboyAdvanceSP",
+    "sp": "gameboyAdvanceSP",
+    "gbc": "gameboyColor",
+    "color": "gameboyColor",
+    "gbm": "gameboyMicro",
+    "micro": "gameboyMicro",
+    "pocket": "gameboyPocket",
+    "o2ds": "2ds",
+    "o3ds": "3ds",
+    "o3dsXL": "3dsXL",
+    "n3ds": "new3ds",
+    "n3dsxl": "new3dsXL",
+    "n2dsxl": "new2dsxl",
+    "switchO": "switchOLED",
+    "lite": "switchLite",
+    "gg": "gamegear",
+    "ms": "masterSystem",
+    "ps1": "playstation",
+    "ps2": "playstation2",
+    "ps3": "playstation3",
+    "ps4": "playstation4",
+    "ps5": "playstation5",
+    "ps1slim": "playstationSlim",
+    "ps2slim": "playstation2slim",
+    "ps3slim": "playstation3slim",
+    "ps4slim": "playstation4slim",
+    "ps5slim": "playstation5slim",
+    "swan": "wonderswan",
+    "ally": "rog-ally",
+}
+
+
+class AssistanceHardware(commands.GroupCog):
+    """
+    General hardware commands that will mostly be used in the hardware but also other help channels.
+    """
+
+    data_dir = join(dirname(__file__), 'assistance-cmds')
+
+    def __init__(self, bot: Kurisu):
+        self.bot: Kurisu = bot
+
+    @commands.group(cooldown=None, invoke_without_command=True, case_insensitive=True)
+    async def hardware(self, ctx: KurisuContext):
+        """Links to one of multiple guides"""
+        if isinstance(ctx.channel, discord.DMChannel) or ctx.channel == self.bot.channels['bot-cmds']:
+            await ctx.send_help(ctx.command)
+        else:
+            await ctx.send(f'{ctx.author.mention}, if you wish to view the '
+                           f'complete list of tutorials, send `.help hardware` to me in a {self.bot.channels["bot-cmds"]}.',
+                           delete_after=10)
+
+    @commands.dynamic_cooldown(KurisuCooldown(1, 5), commands.BucketType.channel)
+    @commands.command()
+    async def fix(self, ctx: KurisuContext, console=''):
+        console = console.lower()
+        if console in consoles.keys():
+            await simple_embed(ctx, consoles[console], color=discord.Color.blue())
+        elif console in alias.keys():
+            await simple_embed(ctx, consoles[alias[console]], color=discord.Color.blue())
+        else:
+            await simple_embed(ctx, "Invalid console, see https://www.ifixit.com/Device/Game_Console",
+                               color=discord.Color.red())
+
+
+add_md_files_as_commands(AssistanceHardware, join(AssistanceHardware.data_dir, 'hardware'),
+                         namespace=AssistanceHardware.hardware)  # type: ignore
+
+
+async def setup(bot):
+    await bot.add_cog(AssistanceHardware(bot))

kurisu.py

@@ -35,6 +35,7 @@
     'cogs.assistancewiiu',
     'cogs.assistance3ds',
     'cogs.assistanceswitch',
+    'cogs.assistancehardware',
     'cogs.automod',
     'cogs.blah',
     'cogs.db3ds',

utils/mdcmd.py

@@ -14,7 +14,8 @@
     from cogs.assistancewiiu import AssistanceWiiU
     from cogs.assistance3ds import Assistance3DS
     from cogs.assistanceswitch import AssistanceSwitch
-    AssistanceCogs = Assistance | AssistanceWii | AssistanceWiiU | Assistance3DS | AssistanceSwitch
+    from cogs.assistancehardware import AssistanceHardware
+    AssistanceCogs = Assistance | AssistanceWii | AssistanceWiiU | Assistance3DS | AssistanceSwitch | AssistanceHardware
 
 systems_no_aliases = ('3ds', 'wiiu', 'vwii', 'switch', 'wii', 'dsi', 'gba')
 aliases = {
@@ -145,6 +146,7 @@ def md_file_to_embed(md_path: str) -> tuple[str, str, dict, discord.Embed]:
         'legacy': ConsoleColor.legacy(),
         'dsi': ConsoleColor.legacy(),
         'gba': None,
+        'hardware': None,
         'all': None  # default embed color
     }
 
@@ -246,7 +248,7 @@ async def simple_cmd(self, ctx: commands.Context):
         cooldowns[command] = (int(header['cooldown-rate']), int(header['cooldown-per']))
 
     # the tutorial subdirectory doesn't need console filtering
-    filter_cmds = "tutorial" not in md_dir
+    filter_cmds = "tutorial" not in md_dir and "hardware" not in md_dir
 
     for command, embed_dict in new_commands.items():
         if filter_cmds: