Skip to content

Commit

Permalink
Additions and changes to hardware cmd's (nh-server#1330)
Browse files Browse the repository at this point in the history
* Added and rewrote a few hardware cmd's

* Applied wurm's uppercase lookup bugfix

See: Wurmatron@2414bc9

* One cmd addition, other additions and small fixes (images, metadata)

* Minor markdown fixes & clarifications

* markdown fix

* Minor spelling mistake

* Replaced Imgur URLs with nintendohomebrew.com URLs

* Small changes to make text more concise. Also added a multimeter cmd
  • Loading branch information
Retroomer authored Jul 21, 2024
1 parent fb895f7 commit 4cfb404
Show file tree
Hide file tree
Showing 11 changed files with 149 additions and 40 deletions.
17 changes: 17 additions & 0 deletions cogs/assistance-cmds/hardware/battery.hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Battery replacements
help-desc: Notes on battery replacements
thumbnail-url: https://nintendohomebrew.com/assets/img/hardware/swollen-battery.png
aliases: batt,spicypillow
---

Has the battery life of your handheld drastically decreased\*? Or is your battery looking puffed up and swollen? It might be time to replace your battery. In the latter case of swelling, you MUST replace your battery and safely dispose of your old battery as soon as you can, as swollen batteries can pose a safety hazard and potentially explode.

Replacement batteries for Nintendo's handheld systems can be purchased from iFixit (https://ifixit.com) \*\*. These systems include the DS Lite, DSi, DS 2DS, 3DS, Switch (OLED), and variations. Do NOT purchase 3rd party replacement batteries from retailers such as Amazon, eBay, and AliExpress. These batteries almost always advertise fake capacities, have quality control issues, and break down after a few months.

When using a new DS/2DS/3DS battery, be sure to calibrate it first. As noted by iFixit:
"For optimal performance, calibrate your newly installed battery: Charge it to 100% and keep charging it for at least 2 more hours. Then use your device until it shuts off due to low battery. Finally, charge it uninterrupted to 100%". For calibrating Switch batteries, read more here: https://discord.com/channels/196618637950451712/467801334373023744/1256118057177186434.

\* A list of approximated battery durations can be found [here for the 3DS family systems](https://en-americas-support.nintendo.com/app/answers/detail/a_id/385/~/how-long-will-the-battery-remain-charged), and [here for the switch](https://www.nintendo.com/en-gb/Support/Nintendo-Switch/How-Long-Does-the-Battery-Charge-Last-1630015.html).

\*\* Unfortunately, some quality control issues have been reported with a few iFixit batteries, as a few batteries have broken down after a few months of use. Potentially cheaper, and more reliable batteries from another source are currently being tested by Wurmatron. However, as of now, iFixit is still the recommended option for replacement batteries. If you notice any issues with your iFixit battery, claim your 1-year warranty from iFixit and let us in #hardware know for logging purposes.
14 changes: 14 additions & 0 deletions cogs/assistance-cmds/hardware/buying.hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Buying consoles and parts
help-desc: Notes on buying consoles and parts
thumbnail-url: https://nintendohomebrew.com/assets/img/hardware/exclamation-mark.png
aliases: replacements,consoles
---

Are you planning on buying a console or replacement parts? Here are some pointers to keep in mind:
* Use eBay to buy consoles or OEM replacement parts. Even if something goes wrong with your purchase, eBay has a solid "Money Back Guarantee" policy.
* Use eBay, Amazon, or AliExpress for 3rd party replacement parts. AliExpress will most likely be your cheapest option, but also the slowest shipping-wise.
* Do NOT buy batteries from either Amazon or AliExpress, and do NOT buy any type of storage (i.e., SD cards) from AliExpress.
* There is a risk of buying a reshelled console without the seller properly disclosing this. Reshelled consoles might be difficult to identify in images. Compare images of the console you're interested in buying to images on [Consolevariations](https://consolevariations.com).

Read more here: https://discord.com/channels/196618637950451712/233002779717795850/447099239852670976
7 changes: 7 additions & 0 deletions cogs/assistance-cmds/hardware/glossary.hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Hardware glossary
help-desc: Hardware glossary from faq-hardware
aliases: terms
---

View a glossary of hardware terms here: https://discord.com/channels/196618637950451712/467801334373023744/1256117455659728987
8 changes: 4 additions & 4 deletions cogs/assistance-cmds/hardware/guides.hardware.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: IFixIt Repair Guides
help-desc: Links to ifixit guides
title: iFixit Repair Guides
help-desc: Links to iFixit guides
thumbnail-url: https://nintendohomebrew.com/assets/img/hardware/ifixit-logo.jpeg
aliases: guide
thumbnail-url: https://guide-images.cdn.ifixit.com/igi/nG1MvGbrC2wopi5H.full
---

https://www.ifixit.com/Guide
See a list of iFixit guides here: https://ifixit.com/guide
13 changes: 9 additions & 4 deletions cogs/assistance-cmds/hardware/ipa.hardware.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
---
title: Isopropyl Alcohol
help-desc: Explains what IPA is
thumbnail-url: https://i.imgur.com/Mfw1Se3.jpeg
aliases: Isopropyl, Iso, Isopropol
thumbnail-url: https://nintendohomebrew.com/assets/img/hardware/ipa.jpeg
aliases: isopropyl,iso,isopropanol
---

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.
Isopropyl Alcohol (IPA) is the recommended cleaning agent for electronics. It is safe to use on circuit boards when the percentage of IPA is above 90%, ideally around 99%.

\>90% IPA is NOT the same as ethanol (ethyl alcoho) or rubbing alcohol. Regular ethanol can contain water and minerals, and rubbing alcohol can be a concoction of multiple chemicals.

IPA is safe to use with the majority of plastics. However, it is noteworthy that IPA can potentially damage/dissolve LCD's, specific plastic coatings, paint, and glue.

Read more about IPA [here](https://www.ifixit.com/News/36877/ask-ifixit-everything-you-wanted-to-know-about-isopropyl-alcohol).
16 changes: 16 additions & 0 deletions cogs/assistance-cmds/hardware/modding.hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Modding and repairing consoles
help-desc: Notes on needed proficiency to mod and repair
thumbnail-url: https://nintendohomebrew.com/assets/img/hardware/broken-switch.jpeg
aliases: modders,repairers,trusted
---

Do you want to mod or repair your system by yourself? Before you start, consider the following:
* Are you proficient and familiar enough with electronic repairs to avoid damaging your system?
* Do you have the right tools available to you? (see https://discord.com/channels/196618637950451712/233002779717795850/1146584298191851582 for a list of tools).
* Do you have enough experience soldering (if applicable)?
* Do you have enough experience using power tools (if applicable)?

If you're interested in learning how to repair consoles or (micro)solder, keep in mind that tools cost money and building experience takes time. In most cases, sending your console in for repairs is usually cheaper and faster. You should NOT attempt (micro)soldering on devices you care about without prior experience.

Would you rather have a professional repair your console? Or are you looking to buy a pre-modded console? Search for repair shops near you, or alternatively, see [this list of trusted repairers and modders](https://pastebin.com/FAiczew4).
12 changes: 12 additions & 0 deletions cogs/assistance-cmds/hardware/multimeter.hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Multimeter guide
help-desc: Concise guide on multimeter use
thumbnail-url: https://nintendohomebrew.com/assets/img/hardware/multimeter.png
aliases: multi
---

A multimeter is an instrument that can measure various electrical properties, such as voltage, resistance, and current. Click on the thumbnail or [here](https://nintendohomebrew.com/assets/img/hardware/multimeter.png) to view a cheat sheet of multimeter functions made by [James Gatlin](https://www.youtube.com/@james_gatlin).

For basic troubleshooting, you will most likely use the continuity and voltage functions of a multimeter.

If you'd like to see how to use a multimeter, watch [this video](https://www.youtube.com/watch?v=0loXukB302Q).
12 changes: 12 additions & 0 deletions cogs/assistance-cmds/hardware/screws.hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Screw types and stripped screws
help-desc: Notes on screw types and stripped screws
thumbnail-url: https://nintendohomebrew.com/assets/img/hardware/stripped-screw.png
aliases: screw,stripped
---

Are you using the proper bit? Most Nintendo consoles use JIS screws, NOT Philips (PH) screws. While the sizes are interchangeable, using a PH bit for a JIS screw may strip it, causing irreversible damage. Read more here: https://discord.com/channels/196618637950451712/233002779717795850/1142584170183397426. If you ever feel like you're scraping metal away, STOP. Sometimes, using a bit one size larger than the screw will allow the screw to turn.

Is it too late, and have you stripped one or multiple screws? Learn how to remove stripped screws here: https://discord.com/channels/196618637950451712/233002779717795850/1142584247761256490

If your screws are stripped, and you're looking to replace them, be sure to buy a set of high-quality screws. Most sets of replacement screws (i.e., eXtremeRate screws) are soft and will strip easily.
14 changes: 14 additions & 0 deletions cogs/assistance-cmds/hardware/shell.hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Shell replacements
help-desc: Notes on shell replacements
thumbnail-url: https://nintendohomebrew.com/assets/img/hardware/wurm-shells.png
aliases: shells,reshell,reshells
---

Replacement shells for most systems can be found on AliExpress (cheap, slow shipping) and Amazon (more expensive, but faster shipping). It is noteworthy that most, if not all, third-party shells are of subpar quality compared to OEM shells. Therefore, it is recommended not to replace your OEM shell unless it is absolutely necessary.

For DS, 2DS, and 3DS handhelds, most third-party shell replacements are of similar quality. There is little difference between brands regarding plastic quality and quality control. Transparent shells tend to have a higher risk of cracking, as the mix of plastics used for transparency makes them more fragile than non-transparent colors.

For the Switch (OLED), eXtremeRate is the recommended brand for replacement shells. There are also unbranded aluminum shell parts available for various Switch systems, which seem to be of decent quality as well.

For the GB, GBC, GBA, and GBA SP, replacement parts (including shells) from [FunnyPlaying](https://funnyplaying.com) are recommended.
10 changes: 10 additions & 0 deletions cogs/assistance-cmds/hardware/soldering.hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Soldering tools and how to solder
help-desc: Notes on soldering
thumbnail-url: https://nintendohomebrew.com/assets/img/hardware/pinecil.png
aliases: solder,tools
---

Do you want to learn how to solder? Read https://discord.com/channels/196618637950451712/233002779717795850/1146584298191851582 for a list of budget soldering tools, and watch [EEVblog's Soldering Tutorial](https://www.youtube.com/watch?v=fYz5nIHH0iY) to learn basic soldering skills.

Be sure to never practice soldering on important or working electronics! Always practice on scrap electronics or soldering exercise kits first.
66 changes: 34 additions & 32 deletions cogs/assistancehardware.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

logger = logging.getLogger(__name__)

# Key must be lower case
consoles = {
# Microsoft
'xbox': 'https://www.ifixit.com/Device/Xbox',
Expand All @@ -26,50 +27,50 @@
'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',
'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',
'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',
'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',
'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',
'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',
'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',
'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',
'procontroller': 'https://www.ifixit.com/Device/Switch_Pro_Controller',
# Sega
'segaCD': 'https://www.ifixit.com/Device/Sega_CD',
'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',
'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',
Expand All @@ -85,43 +86,44 @@
'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',
'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',
'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',
'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',
}
# Key must be lower case
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",
"gba": "gameboyadvance",
"gbsp": "gameboyAdvancesp",
"sp": "gameboyadvancesp",
"gbc": "gameboycolor",
"color": "gameboycolor",
"gbm": "gameboymicro",
"micro": "gameboymicro",
"pocket": "gameboypocket",
"o2ds": "2ds",
"o3ds": "3ds",
"o3dsXL": "3dsXL",
"o3dsxl": "3dsxl",
"n3ds": "new3ds",
"n3dsxl": "new3dsXL",
"n3dsxl": "new3dsxl",
"n2dsxl": "new2dsxl",
"switchO": "switchOLED",
"lite": "switchLite",
"switcho": "switcholed",
"lite": "switchlite",
"gg": "gamegear",
"ms": "masterSystem",
"ps1": "playstation",
Expand Down

0 comments on commit 4cfb404

Please sign in to comment.