Difference between revisions of "Game Boy Interface"

From GC-Forever Wiki
Jump to navigation Jump to search
 
(99 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Infobox/homebrew
 
{{Infobox/homebrew
 
| title      = <includeonly>[[</includeonly>Game Boy Interface<includeonly>]]</includeonly>
 
| title      = <includeonly>[[</includeonly>Game Boy Interface<includeonly>]]</includeonly>
−
| author      = [[User:Extrems|Extrems]]
+
| author      = <span class="plainlinks">[https://www.patreon.com/Extrems Extrems]</span>
 
| type        = Utility
 
| type        = Utility
 
| version    = Rolling release
 
| version    = Rolling release
−
| licence    = [[Game Boy Interface#Licence|Freeware]]
+
| licence    = [[Game Boy Interface#Licence|All rights reserved]]
−
| downloadraw = [https://files.extremscorner.org/gamecube/apps/gbi/latest Main download] <br /> [https://files.extremscorner.org/gamecube/apps/gbi/latest-extra Extra download]
+
| downloadraw = [https://files.extremscorner.org/gamecube/apps/gbi/latest Download main package] <br /> [https://files.extremscorner.org/gamecube/apps/gbi/latest-extra Download extra package]
 
| website    = https://www.extremscorner.org/
 
| website    = https://www.extremscorner.org/
 
| discussion  = https://www.gc-forever.com/forums/viewtopic.php?f=37&t=2782
 
| discussion  = https://www.gc-forever.com/forums/viewtopic.php?f=37&t=2782
 
| source      = https://github.com/extremscorner
 
| source      = https://github.com/extremscorner
 
}}
 
}}
 +
{{Notice|header=This software must not be sold, neither alone nor as part of a bundle.|textstyle=text-align: center|text=If you paid for this software or received it as part of a bundle following payment, you have been scammed and should demand your money back immediately.}}
 +
{{Notice|header=Firmware update notice for GCVideo products.|textstyle=text-align: center|text=It is strongly recommended to update to GCVideo-DVI v3.0 or later before using this software. GCVideo Lite products are not recommended under any circumstances.}}
 
<noinclude>
 
<noinclude>
−
'''Game Boy Interface''' is an alternative to the Game Boy Player Start-up Disc software. It still requires the [[wikipedia:Game Boy Player|Game Boy Player]] hardware.
+
[[File:GBI.png|thumb|[[Game Boy Interface/Standard Edition|Game Boy Interface Standard Edition]] (960x720i)]]
 +
[[File:Game Boy Player Start-up Disc.png|thumb|Game Boy Player Start-up Disc (480p)]]
  
−
Game Boy Interface is currently available in three different editions: [[Game Boy Interface/Standard Edition|Standard]], [[Game Boy Interface/Speedrunning Edition|Speedrunning]] and [[Game Boy Interface/High-Fidelity Edition|High-Fidelity]].
+
'''Game Boy Interface''' is a free alternative to the Game Boy Player Start-up Disc software. It still requires the [[wikipedia:Game Boy Player|Game Boy Player]] hardware.
 +
 
 +
Game Boy Interface is currently available in three different editions: '''[[Game Boy Interface/Standard Edition|Standard]]''', '''[[Game Boy Interface/Speedrunning Edition|Speedrunning]]''' and '''[[Game Boy Interface/High-Fidelity Edition|High-Fidelity]]'''.
  
 
<div class="toclimit-2">
 
<div class="toclimit-2">
Line 21: Line 26:
 
== Overview ==
 
== Overview ==
  
−
The [[Game Boy Interface/Standard Edition|standard edition]] is ideal for sample-and-hold displays (LCD, OLED). By default, it emulates some aspects of the color and sound of the original handheld. With a [[Broadband Adapter]] and [[USBGecko|USB Gecko]] in hand, it can be used as a small Game Boy Advance [[wikipedia:Game development kit|development kit]].
+
The [[Game Boy Interface/Standard Edition|standard edition]] is ideal for sample-and-hold displays (LCD, OLED). By default, it emulates some aspects of the color and sound reproduction of the original handheld. With a [[Broadband Adapter]] and [[USBGecko|USB Gecko]] in hand, it can be used as a small Game Boy Advance [[wikipedia:Game development kit|development kit]].
  
−
The [[Game Boy Interface/Speedrunning Edition|speedrunning edition]] is ideal for strobed or scanning displays (CRT, ULMB LCD, Plasma). It attempts to be a non-controversial improvement for [[wikipedia:Speedrun|speedrunners]]. To ease transition, it can be configured to [[Game Boy Interface/Speedrunning Edition#Game Boy Player Start-up Disc (60Hz)|closely mimic]] the Game Boy Player Start-up Disc.
+
The [[Game Boy Interface/Speedrunning Edition|speedrunning edition]] is ideal for impulse displays (CRT, 1ms MPRT LCD, Plasma) or use with the <span class="plainlinks">[https://junkerhq.net/xrgb/index.php?title=RetroTINK2X RetroTINK-2X]</span>. It attempts to be a non-controversial improvement for [[wikipedia:Speedrun|speedrunners]]. To ease transition, it can be configured to [[Game Boy Interface/Speedrunning Edition#Game Boy Player Start-up Disc (60Hz)|closely mimic]] the Game Boy Player Start-up Disc.
  
−
The [[Game Boy Interface/High-Fidelity Edition|high-fidelity edition]] is ideal for use with the <span class="plainlinks">[http://junkerhq.net/xrgb/index.php?title=OSSC Open Source Scan Converter]</span>, <span class="plainlinks">[http://junkerhq.net/xrgb/index.php?title=XRGB-mini_FRAMEMEISTER XRGB-mini Framemeister]</span>, or using solely a video capture device and software processing. Given the right setup, it can provide audiovisual quality comparable to emulation on newer platforms. It is less than suitable for direct display connection.
+
The [[Game Boy Interface/High-Fidelity Edition|high-fidelity edition]] is ideal for use with the <span class="plainlinks">[https://junkerhq.net/xrgb/index.php?title=OSSC Open Source Scan Converter]</span>, RetroTINK-4K, <span class="plainlinks">[https://consolemods.org/wiki/AV:RetroTINK-5X_Pro RetroTINK-5X Pro]</span>, <span class="plainlinks">[https://junkerhq.net/xrgb/index.php?title=XRGB-mini_FRAMEMEISTER XRGB-mini Framemeister]</span>, or using solely a video capture device and software processing. Given the right setup, it can offer audiovisual quality comparable to emulation on newer platforms. It is less than suitable for direct display connection, with [[Game Boy Interface/High-Fidelity Edition#High-definition televisions|some exceptions]]. Any non-mentioned use is unintended.
  
−
All editions can emulate the color and sound of the original handheld if desired.
+
All editions can emulate the color and sound reproduction of the original handheld if desired.
 +
 
 +
Its original mission was to solve the temporal judder present with the Game Boy Player Start-up Disc through temporal interpolation. This feature remain exclusive to the standard edition.
 +
 
 +
==== TL;DR ====
 +
 
 +
: ''Datapath VisionAV or VisionRGB?'' → <code>[[Game Boy Interface/High-Fidelity Edition#Datapath VisionAV & VisionRGB|gbihf-vision.dol+cli]]</code> or <code>[[Game Boy Interface/Speedrunning Edition#Datapath VisionAV & VisionRGB|gbisr-vision.dol+cli]]</code>
 +
: ''RetroTINK-4K?'' → <code>[[Game Boy Interface/High-Fidelity Edition#GCVideo-DVI v3.0 and later 2|gbihf-rt4k-hdmi.dol+cli]]</code> or <code>[[Game Boy Interface/Speedrunning Edition#RetroTINK-4K|gbisr-vision.dol+cli]]</code>
 +
: ''Morph 4K or Open Source Scan Converter (Pro)?'' → <code>[[Game Boy Interface/High-Fidelity Edition#Open Source Scan Converter|gbihf-ossc.dol+cli]]</code> or <code>[[Game Boy Interface/High-Fidelity Edition#Insurrection Industries Carby Component Cable|gbihf-ossc+carby.dol+cli]]</code>
 +
: ''RetroTINK-5X Pro?'' → <code>[[Game Boy Interface/High-Fidelity Edition#RetroTINK-5X Pro 2|gbihf-ossc.dol+cli]]</code> or <code>[[Game Boy Interface/Standard Edition#Insurrection Industries Carby Component Cable|gbi-rt5x+carby.dol+cli]]</code>
 +
: ''XRGB-mini Framemeister?'' → <code>[[Game Boy Interface/High-Fidelity Edition#XRGB-mini Framemeister|gbihf-xrgb.dol+cli]]</code>
 +
: ''Cathode-ray tube computer monitor?''  → <code>[[Game Boy Interface/High-Fidelity Edition#Computer monitors (Cathode-ray tube)|gbihf-direct-vga.dol+cli]]</code> or <code>gbisr.dol</code> with default settings
 +
: ''Nintendo GameCube Component Video Cable?'' → <code>[[Game Boy Interface/High-Fidelity Edition#High-definition televisions|gbihf-direct-ypbpr.dol+cli]]</code> or <code>gbihf.dol</code> with default settings
 +
: ''GCVideo-DVI v3.0 and later?'' → <code>[[Game Boy Interface/High-Fidelity Edition#GCVideo-DVI v3.0 and later 3|gbihf-direct-hdmi.dol+cli]]</code> or <code>gbi.dol</code> with default settings
 +
: ''GCVideo-DVI v2.4d and earlier?'' → <code>[[Game Boy Interface/Speedrunning Edition#GCVideo-DVI|gbisr-direct-hdmi.dol+cli]]</code> or <code>gbi.dol</code> with default settings
 +
: ''RetroTINK-2X?'' → <code>gbisr.dol</code> with default settings
 +
: ''Anything* else'' → <code>gbisr.dol</code> or <code>gbi.dol</code> with default settings
 +
 
 +
If you have something truly exotic, hopefully you don't need a tl;dr.
  
 
=== GBA-as-controller ===
 
=== GBA-as-controller ===
  
−
Turn your Game Boy Advance into a Nintendo 64 or Nintendo GameCube Controller using the [[wikipedia:GameCube – Game Boy Advance link cable|Game Boy Advance Cable]].
+
Turn your Game Boy Advance into a Nintendo 64 or Nintendo GameCube Controller using the [[wikipedia:GameCube – Game Boy Advance link cable|Game Boy Advance Cable]], compatible with any hardware supporting such controllers.
  
 
Rumble is supported using the following Game or Option Paks:
 
Rumble is supported using the following Game or Option Paks:
Line 41: Line 64:
  
 
[[wikipedia:Nintendo e-Reader|e-Reader]] dot codes and multi-bootable ROMs are provided in the extra package for untethered use from Game Boy Interface.
 
[[wikipedia:Nintendo e-Reader|e-Reader]] dot codes and multi-bootable ROMs are provided in the extra package for untethered use from Game Boy Interface.
 +
 +
It also prolongs battery life over the Game Boy Player Start-up Disc with power saving trickery, while maximizing performance.
  
 
=== GBA dumper ===
 
=== GBA dumper ===
  
−
Holding Start + Select while the Game Boy logo is visible will grant you access to a dumping utility. From there, you can dump your GBA BIOS, ROM, or save data.
+
Holding Start + Select in the Game Boy Player while the Game Boy logo is visible will grant you access to a dumping utility. From there, you can dump your GBA BIOS, ROM, or save data.
  
−
This feature is disabled by default in the [[Game Boy Interface/Speedrunning Edition#Options|speedrunning edition]] to prevent spurious communication during gameplay. An SD Card and [[SDGecko|SD Card Adapter]] is required.
+
An SD Card and [[SDGecko|SD Card Adapter]] is required. In the [[Game Boy Interface/Speedrunning Edition#How do I verify my Game Boy Advance ROM?|speedrunning edition]], this is substituted by a built-in GBA ROM checksumming utility.
  
 
=== TAS playback ===
 
=== TAS playback ===
Line 52: Line 77:
 
Game Boy Interface has a built-in movie playback feature, allowing for the console verification of GBC-on-GBA and GBA [[wikipedia:Tool-assisted_speedrun|tool-assisted speedruns]], all without hardware modification.
 
Game Boy Interface has a built-in movie playback feature, allowing for the console verification of GBC-on-GBA and GBA [[wikipedia:Tool-assisted_speedrun|tool-assisted speedruns]], all without hardware modification.
  
−
A few console-verified movies are included in the extra package. An SD Card and [[SDGecko|SD Card Adapter]] is required.
+
A few console-verified movies are included in the extra package (<code>*.txt.gz</code>), and more can be found at [https://runs.tas.bot/ Runs.TAS.Bot]. An SD Card and [[SDGecko|SD Card Adapter]] is required.
  
 
== Installation ==
 
== Installation ==
 +
 +
[[File:GBI Windows Explorer.png|thumb|Extracting with Windows Explorer]]
 +
[[File:GBI 7-Zip.png|thumb|Extracting with [https://www.7-zip.org/ 7-Zip]]]
  
 
{{Further|Booting Homebrew}}
 
{{Further|Booting Homebrew}}
  
−
=== SD Card ===
+
=== SD Media Launcher ===
 +
 
 +
# Obtain the [[Datel's SD Media Launcher|SD Media Launcher]] and an SDSC Card (≤2 GB).
 +
# Format the SDSC Card as FAT(16).
 +
# Extract the main package to the root directory of the SDSC Card. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
 +
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SDSC Card.
 +
# (Optional) Rename the desired <code>.dol</code> or <code>.dol+cli</code> file on the SDSC Card to <code>AUTOEXEC.DOL</code>.
 +
 
 +
Important: <code>GBI/</code>, <code>MCBACKUP/</code> and <code>AUTOEXEC.DOL</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
 +
 
 +
=== SD Media Launcher with Swiss ===
  
−
# Obtain the [[Datel's SD Media Launcher|SD Media Launcher]].
+
# Obtain the [[Datel's SD Media Launcher|SD Media Launcher]] and an SDSC Card (≤2 GB).
−
# Format the SD Card as FAT.
+
# Format the SDSC Card as FAT(16).
−
# Extract the main package to the root directory of the SD Card.
+
# Extract the main package to the root directory of the SDSC Card. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
−
# (Optional) Extract the extra package to the root directory of the SD Card.
+
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SDSC Card.
−
# (Optional) Rename the desired <code>.dol</code> or <code>.dol+cli</code> file on the SD Card to <code>autoexec.dol</code>.
+
# Copy <code>ActionReplay/AUTOEXEC.DOL</code> from the [[Swiss]] release to the root directory of the SDSC Card.
 +
# (Optional) Set the [[wikipedia:File attribute#DOS and Windows|hidden file attribute]] on <code>AUTOEXEC.DOL</code>.
  
−
Important: Do not move the folders away from the root directory.
+
Important: <code>GBI/</code>, <code>MCBACKUP/</code> and <code>AUTOEXEC.DOL</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
  
−
=== Memory Card + SD Card ===
+
=== SD Media Launcher + SD2SP2 with Swiss ===
  
−
# Restore [//www.gc-forever.com/forums/viewtopic.php?f=39&t=3023 Home Bros.] to a Memory Card.
+
# Obtain the [[Datel's SD Media Launcher|SD Media Launcher]], an SDSC Card (≤2 GB), an [https://github.com/citrus3000psi/SD2SP2 SD2SP2] and a microSD Card.
−
# Obtain an [[SDGecko|SD Card Adapter]].
+
# Format the microSD Card for the SD2SP2 as FAT(16) or FAT32.
−
# Format the SD Card as FAT or FAT32.
+
# Extract the main package to the root directory of the microSD Card for the SD2SP2. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
−
# Extract the main package to the root directory of the SD Card.
+
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the microSD Card for the SD2SP2.
−
# (Optional) Extract the extra package to the root directory of the SD Card.
+
# Format the SDSC Card for the SD Media Launcher as FAT(16).
 +
# Copy <code>ActionReplay/AUTOEXEC.DOL</code> from the [[Swiss]] release to the root directory of the SDSC Card for the SD Media Launcher.
 +
# (Optional) Set the [[wikipedia:File attribute#DOS and Windows|hidden file attribute]] on <code>AUTOEXEC.DOL</code>.
 +
 
 +
Important: <code>GBI/</code>, <code>MCBACKUP/</code> and <code>AUTOEXEC.DOL</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
 +
 
 +
=== Memory Card + SD Card Adapter ===
 +
 
 +
# Obtain a Super Smash Bros. Melee Game Disc, a Memory Card, an [[SDGecko|SD Card Adapter]] and an SD Card.
 +
# Format the SD Card as FAT(16) or FAT32.
 +
# Extract the main package to the root directory of the SD Card. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
 +
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SD Card.
 
# Rename the desired <code>.dol</code> or <code>.dol+cli</code> file on the SD Card to <code>boot.dol</code>.
 
# Rename the desired <code>.dol</code> or <code>.dol+cli</code> file on the SD Card to <code>boot.dol</code>.
 +
# (Optional) Backup the Memory Card.
 +
# Format the Memory Card on a system of the same region.
 +
# Restore [//www.gc-forever.com/forums/viewtopic.php?f=39&t=3023 Home Bros.] to the Memory Card.
  
−
Important: Do not move <code>boot.dol</code> or the folders away from the root directory.
+
Important: <code>GBI/</code>, <code>MCBACKUP/</code> and <code>boot.dol</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
 +
 
 +
=== Memory Card + SD Card Adapter with Swiss ===
 +
 
 +
# Obtain a vulnerable Game Disc, a Memory Card (≥251 blocks), an [[SDGecko|SD Card Adapter]] or [https://github.com/citrus3000psi/SD2SP2 SD2SP2] and an SD Card.
 +
# Format the SD Card as FAT(16) or FAT32.
 +
# Extract the main package to the root directory of the SD Card. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
 +
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SD Card.
 +
# (Optional) Backup the Memory Card.
 +
# Format the Memory Card on a system of the same region.
 +
# Restore a usable [[Booting Homebrew#Game Save Exploits|game save exploit]] to the Memory Card.
 +
# Restore <code>GCI/boot.gci</code> from the [[Swiss]] release to the Memory Card.
 +
 
 +
Important: <code>GBI/</code> and <code>MCBACKUP/</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
  
 
=== Memory Card ===
 
=== Memory Card ===
  
−
# Restore a usable [[Booting Homebrew#Game Save Exploits|game save exploit]] to a Memory Card.
+
# Obtain a vulnerable Game Disc and a Memory Card.
−
# Restore the desired <code>.gci</code> file from the main package to a Memory Card.
+
# (Optional) Backup the Memory Card.
 +
# Format the Memory Card on a system of the same region.
 +
# Restore a usable [[Booting Homebrew#Game Save Exploits|game save exploit]] to the Memory Card.
 +
# Restore the desired <code>.gci</code> file from the main package to the Memory Card.
 +
 
 +
Note: An SD Card Adapter is required for reading/writing data. Certain functionality will be lost.
  
−
Note: An SD Card is required for data files. Some features won't be available.
+
=== GC Loader + SD Card Adapter ===
  
−
=== IPL + SD Card ===
+
# Install the [[GCLoader|GC Loader]].
 +
# Obtain an [[SDGecko|SD Card Adapter]] or [https://github.com/citrus3000psi/SD2SP2 SD2SP2] and two SD Cards.
 +
# Format the SD Card for the SD Card Adapter as FAT(16) or FAT32.
 +
# Extract the main package to the root directory of the SD Card for the SD Card Adapter. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
 +
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SD Card for the SD Card Adapter.
 +
# Rename the desired <code>.dol</code> or <code>.dol+cli</code> file on the SD Card for the SD Card Adapter to <code>boot.dol</code>.
 +
# Format the SDHC/SDXC Card for the GC Loader as FAT32.
 +
# Copy <code>boot.iso</code> from the extra package to the root directory of the SDHC/SDXC Card for the GC Loader.
  
−
# Install [https://github.com/redolution/iplboot/releases iplboot] to a supported [[IPL Replacement|IPL replacement]].
+
Important: <code>GBI/</code>, <code>MCBACKUP/</code>, <code>boot.dol</code> and <code>boot.iso</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
−
# Obtain an [[SDGecko|SD Card Adapter]].
+
 
−
# Format the SD Card as FAT or FAT32.
+
=== GC Loader + SD Card Adapter with Swiss ===
−
# Extract the main package to the root directory of the SD Card.
+
 
−
# (Optional) Extract the extra package to the root directory of the SD Card.
+
# Install the [[GCLoader|GC Loader]].
 +
# Obtain an [[SDGecko|SD Card Adapter]] or [https://github.com/citrus3000psi/SD2SP2 SD2SP2] and two SD Cards.
 +
# Format the SD Card for the SD Card Adapter as FAT(16) or FAT32.
 +
# Extract the main package to the root directory of the SD Card for the SD Card Adapter. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
 +
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SD Card for the SD Card Adapter.
 +
# Format the SDHC/SDXC Card for the GC Loader as FAT32.
 +
# Copy <code>GCLoader/boot.iso</code> from the [[Swiss]] release to the root directory of the SDHC/SDXC Card for the GC Loader.
 +
# (Optional) Set the [[wikipedia:File attribute#DOS and Windows|hidden file attribute]] on <code>boot.iso</code>.
 +
 
 +
Important: <code>GBI/</code>, <code>MCBACKUP/</code> and <code>boot.iso</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
 +
<!--
 +
=== GC Loader ===
 +
 
 +
# Install the [[GCLoader|GC Loader]].
 +
# Obtain an SDHC/SDXC Card (≥4 GB).
 +
# Format the SDHC/SDXC Card as FAT32. '''exFAT is not supported.'''
 +
# Extract the main package to the root directory of the SDHC/SDXC Card. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
 +
# Copy <code>boot.iso</code> from the extra package to the root directory of the SDHC/SDXC Card.
 +
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SDHC/SDXC Card.
 +
# Rename the desired <code>.dol</code> or <code>.dol+cli</code> file on the SDHC/SDXC Card to <code>boot.dol</code>.
 +
 
 +
Important: <code>GBI/</code>, <code>MCBACKUP/</code>, <code>boot.dol</code> and <code>boot.iso</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
 +
-->
 +
=== GC Loader with Swiss ===
 +
 
 +
# Install the [[GCLoader|GC Loader]].
 +
# Obtain an SDHC/SDXC Card (≥4 GB).
 +
# Format the SDHC/SDXC Card as FAT32. '''exFAT is not supported.'''
 +
# Extract the main package to the root directory of the SDHC/SDXC Card. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
 +
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SDHC/SDXC Card.
 +
# Copy <code>GCLoader/boot.iso</code> from the [[Swiss]] release to the root directory of the SDHC/SDXC Card.
 +
# (Optional) Set the [[wikipedia:File attribute#DOS and Windows|hidden file attribute]] on <code>boot.iso</code>.
 +
# Upgrade the GC Loader firmware to [https://github.com/danielkraak/GC-Loader/tree/master/Firmware%20Updates 2.0.0.BETA or later].
 +
 
 +
Important: <code>GBI/</code>, <code>MCBACKUP/</code> and <code>boot.iso</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
 +
 
 +
=== IPL (PicoBoot) + SD Card Adapter ===
 +
 
 +
# Install [https://github.com/redolution/gekkoboot/releases gekkoboot] to a supported [[IPL Replacement|IPL replacement]].
 +
# Obtain an [[SDGecko|SD Card Adapter]] and an SD Card.
 +
# Format the SD Card as FAT(16) or FAT32.
 +
# Extract the main package to the root directory of the SD Card. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
 +
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SD Card.
 
# Rename the desired <code>.dol</code> or <code>.dol+cli</code> file on the SD Card to <code>ipl.dol</code>.
 
# Rename the desired <code>.dol</code> or <code>.dol+cli</code> file on the SD Card to <code>ipl.dol</code>.
  
−
Important: Do not move <code>ipl.dol</code> or the folders away from the root directory.
+
Important: <code>GBI/</code>, <code>MCBACKUP/</code> and <code>ipl.dol</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
  
−
=== DVD + SD Card ===
+
=== IPL (PicoBoot) + SD Card Adapter with Swiss ===
 +
 
 +
# Install [https://github.com/redolution/gekkoboot/releases gekkoboot] to a supported [[IPL Replacement|IPL replacement]].
 +
# Obtain an [[SDGecko|SD Card Adapter]] and an SD Card.
 +
# Format the SD Card as FAT(16) or FAT32.
 +
# Extract the main package to the root directory of the SD Card. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
 +
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SD Card.
 +
# Copy <code>DOL/swiss_rXXXX-compressed.dol</code> from the [[Swiss]] release to the root directory of the SD Card.
 +
# Rename <code>swiss_rXXXX-compressed.dol</code> on the SD Card to <code>ipl.dol</code>.
 +
# (Optional) Set the [[wikipedia:File attribute#DOS and Windows|hidden file attribute]] on <code>ipl.dol</code>.
 +
 
 +
Important: <code>GBI/</code>, <code>MCBACKUP/</code> and <code>ipl.dol</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
 +
 
 +
=== DVD (XenoGC) + SD Card Adapter ===
  
 
# Install an available [[Drivechip|drive chip]].
 
# Install an available [[Drivechip|drive chip]].
−
# Obtain an [[SDGecko|SD Card Adapter]].
+
# Obtain a blank DVD±R, an [[SDGecko|SD Card Adapter]] or [https://github.com/citrus3000psi/SD2SP2 SD2SP2] and an SD Card.
−
# Format the SD Card as FAT or FAT32.
+
# Format the SD Card as FAT(16) or FAT32.
−
# Extract the main package to the root directory of the SD Card.
+
# Extract the main package to the root directory of the SD Card. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
−
# (Optional) Extract the extra package to the root directory of the SD Card.
+
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SD Card.
 
# Rename the desired <code>.dol</code> or <code>.dol+cli</code> file on the SD Card to <code>boot.dol</code>.
 
# Rename the desired <code>.dol</code> or <code>.dol+cli</code> file on the SD Card to <code>boot.dol</code>.
−
# Burn <code>boot.gcm</code> from the extra package to a DVD-R.
+
# Burn <code>boot.gcm</code> from the extra package to the blank DVD±R.
 +
 
 +
Important: <code>GBI/</code>, <code>MCBACKUP/</code> and <code>boot.dol</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
 +
 
 +
=== DVD (XenoGC) + SD Card Adapter with Swiss ===
 +
 
 +
# Install an available [[Drivechip|drive chip]].
 +
# Obtain a blank DVD±R, an [[SDGecko|SD Card Adapter]] or [https://github.com/citrus3000psi/SD2SP2 SD2SP2] and an SD Card.
 +
# Format the SD Card as FAT(16) or FAT32.
 +
# Extract the main package to the root directory of the SD Card. '''Do not extract to <code>gbi-YYYYMMDD</code>.'''
 +
# (Optional) Merge <code>GBI/</code> from the extra package with <code>GBI/</code> on the SD Card.
 +
# Copy <code>DOL/swiss_rXXXX-compressed.dol</code> from the [[Swiss]] release to the root directory of the SD Card.
 +
# Rename <code>swiss_rXXXX-compressed.dol</code> on the SD Card to <code>boot.dol</code>.
 +
# (Optional) Set the [[wikipedia:File attribute#DOS and Windows|hidden file attribute]] on <code>boot.dol</code>.
 +
# Burn <code>boot.gcm</code> from the extra package to the blank DVD±R.
  
−
Important: Do not move <code>boot.dol</code> or the folders away from the root directory.
+
Important: <code>GBI/</code>, <code>MCBACKUP/</code> and <code>boot.dol</code> must reside in the root directory. Extracting files selectively may result in loss of functionality.
  
−
=== DVD + Memory Card ===
+
=== DVD (XenoGC) + Memory Card ===
  
 
# Install an available [[Drivechip|drive chip]].
 
# Install an available [[Drivechip|drive chip]].
−
# Restore the desired <code>.gci</code> file from the main package to a Memory Card.
+
# Obtain a blank DVD±R and a Memory Card.
−
# Burn <code>boot.gcm</code> from the extra package to a DVD-R.
+
# Restore the desired <code>.gci</code> file from the main package to the Memory Card.
 +
# Burn <code>boot.gcm</code> from the extra package to the blank DVD±R.
  
−
Note: An SD Card is required for data files. Some features won't be available.
+
Note: An SD Card Adapter is required for reading/writing data. Certain functionality will be lost.
  
−
=== DVD ===
+
=== DVD (XenoGC) ===
  
 
This method is unsupported at this time.
 
This method is unsupported at this time.
  
 
== Configuration ==
 
== Configuration ==
 +
 +
As Game Boy Interface still lack configuration files or a full user interface, this is done through [[wikipedia:Command-line interface#Arguments|command-line arguments]].
  
 
=== Using Swiss ===
 
=== Using Swiss ===
  
−
When loading a <code>.dol</code> file, [[Swiss]] first look for a <code>.dcp</code> file. This file contain a limited set of options that can be interactively changed before starting Game Boy Interface. This set of options can be expanded upon, but is limited to 16 options with 8 choices of 31 characters.
+
When loading a <code>.dol</code> file, [[Swiss]] first look for a <code>.dcp</code> file. This file contain a limited set of options that can be interactively changed before starting Game Boy Interface. This set of options can be expanded upon, but prior to Swiss v0.6r1424, is limited to 16 options with 8 choices of 31 characters. Note that the default shown positions don't represent the default settings.
  
 
For a more permanent or advanced configuration, a <code>.cli</code> file can be used. This file contain command-line arguments on separate lines.
 
For a more permanent or advanced configuration, a <code>.cli</code> file can be used. This file contain command-line arguments on separate lines.
Line 145: Line 295:
 
== Support ==
 
== Support ==
  
−
* [https://discord.gg/2dhfaHN Extrems' Corner.org Discord]
+
{{For|FAQs|Game Boy Interface/Standard Edition#FAQs{{!}}Standard Edition § FAQs|Game Boy Interface/Speedrunning Edition#FAQs{{!}}Speedrunning Edition § FAQs|Game Boy Interface/High-Fidelity Edition#FAQs{{!}}High-Fidelity Edition § FAQs}}
 +
 
 +
* [https://discord.extremscorner.org/ Extrems' Corner.org Discord]
 +
* [mailto:support@extremscorner.org Extrems' Corner.org Email]
 +
* [https://twitter.com/Extrems Extrems' Twitter]
 
* [irc://irc.efnet.org/gc-forever GC-Forever IRC]
 
* [irc://irc.efnet.org/gc-forever GC-Forever IRC]
 
* [//www.gc-forever.com/forums/viewtopic.php?f=37&t=2782 GC-Forever Forums]
 
* [//www.gc-forever.com/forums/viewtopic.php?f=37&t=2782 GC-Forever Forums]
Line 152: Line 306:
  
 
<pre>
 
<pre>
−
Copyright (c) 2014-2019, Extrems' Corner.org
+
Copyright (c) 2014-2024, Extrems' Corner.org
 
All rights reserved. You may not sell or redistribute this software.
 
All rights reserved. You may not sell or redistribute this software.
 
All trademarks used are properties of their respective owners.
 
All trademarks used are properties of their respective owners.

Latest revision as of 21:23, 24 March 2024

Game Boy Interface
Information
Author(s) Extrems
Type Utility
Version Rolling release
Licence All rights reserved
Links
Download main package
Download extra package
Website
Discussion
Source
This software must not be sold, neither alone nor as part of a bundle.
If you paid for this software or received it as part of a bundle following payment, you have been scammed and should demand your money back immediately.
Firmware update notice for GCVideo products.
It is strongly recommended to update to GCVideo-DVI v3.0 or later before using this software. GCVideo Lite products are not recommended under any circumstances.
Game Boy Interface Standard Edition (960x720i)
Game Boy Player Start-up Disc (480p)

Game Boy Interface is a free alternative to the Game Boy Player Start-up Disc software. It still requires the Game Boy Player hardware.

Game Boy Interface is currently available in three different editions: Standard, Speedrunning and High-Fidelity.

Overview

The standard edition is ideal for sample-and-hold displays (LCD, OLED). By default, it emulates some aspects of the color and sound reproduction of the original handheld. With a Broadband Adapter and USB Gecko in hand, it can be used as a small Game Boy Advance development kit.

The speedrunning edition is ideal for impulse displays (CRT, 1ms MPRT LCD, Plasma) or use with the RetroTINK-2X. It attempts to be a non-controversial improvement for speedrunners. To ease transition, it can be configured to closely mimic the Game Boy Player Start-up Disc.

The high-fidelity edition is ideal for use with the Open Source Scan Converter, RetroTINK-4K, RetroTINK-5X Pro, XRGB-mini Framemeister, or using solely a video capture device and software processing. Given the right setup, it can offer audiovisual quality comparable to emulation on newer platforms. It is less than suitable for direct display connection, with some exceptions. Any non-mentioned use is unintended.

All editions can emulate the color and sound reproduction of the original handheld if desired.

Its original mission was to solve the temporal judder present with the Game Boy Player Start-up Disc through temporal interpolation. This feature remain exclusive to the standard edition.

TL;DR

Datapath VisionAV or VisionRGB? → gbihf-vision.dol+cli or gbisr-vision.dol+cli
RetroTINK-4K? → gbihf-rt4k-hdmi.dol+cli or gbisr-vision.dol+cli
Morph 4K or Open Source Scan Converter (Pro)? → gbihf-ossc.dol+cli or gbihf-ossc+carby.dol+cli
RetroTINK-5X Pro? → gbihf-ossc.dol+cli or gbi-rt5x+carby.dol+cli
XRGB-mini Framemeister? → gbihf-xrgb.dol+cli
Cathode-ray tube computer monitor? → gbihf-direct-vga.dol+cli or gbisr.dol with default settings
Nintendo GameCube Component Video Cable? → gbihf-direct-ypbpr.dol+cli or gbihf.dol with default settings
GCVideo-DVI v3.0 and later? → gbihf-direct-hdmi.dol+cli or gbi.dol with default settings
GCVideo-DVI v2.4d and earlier? → gbisr-direct-hdmi.dol+cli or gbi.dol with default settings
RetroTINK-2X? → gbisr.dol with default settings
Anything* else → gbisr.dol or gbi.dol with default settings

If you have something truly exotic, hopefully you don't need a tl;dr.

GBA-as-controller

Turn your Game Boy Advance into a Nintendo 64 or Nintendo GameCube Controller using the Game Boy Advance Cable, compatible with any hardware supporting such controllers.

Rumble is supported using the following Game or Option Paks:

e-Reader dot codes and multi-bootable ROMs are provided in the extra package for untethered use from Game Boy Interface.

It also prolongs battery life over the Game Boy Player Start-up Disc with power saving trickery, while maximizing performance.

GBA dumper

Holding Start + Select in the Game Boy Player while the Game Boy logo is visible will grant you access to a dumping utility. From there, you can dump your GBA BIOS, ROM, or save data.

An SD Card and SD Card Adapter is required. In the speedrunning edition, this is substituted by a built-in GBA ROM checksumming utility.

TAS playback

Game Boy Interface has a built-in movie playback feature, allowing for the console verification of GBC-on-GBA and GBA tool-assisted speedruns, all without hardware modification.

A few console-verified movies are included in the extra package (*.txt.gz), and more can be found at Runs.TAS.Bot. An SD Card and SD Card Adapter is required.

Installation

Extracting with Windows Explorer
Extracting with 7-Zip
Further information: Booting Homebrew

SD Media Launcher

  1. Obtain the SD Media Launcher and an SDSC Card (≤2 GB).
  2. Format the SDSC Card as FAT(16).
  3. Extract the main package to the root directory of the SDSC Card. Do not extract to gbi-YYYYMMDD.
  4. (Optional) Merge GBI/ from the extra package with GBI/ on the SDSC Card.
  5. (Optional) Rename the desired .dol or .dol+cli file on the SDSC Card to AUTOEXEC.DOL.

Important: GBI/, MCBACKUP/ and AUTOEXEC.DOL must reside in the root directory. Extracting files selectively may result in loss of functionality.

SD Media Launcher with Swiss

  1. Obtain the SD Media Launcher and an SDSC Card (≤2 GB).
  2. Format the SDSC Card as FAT(16).
  3. Extract the main package to the root directory of the SDSC Card. Do not extract to gbi-YYYYMMDD.
  4. (Optional) Merge GBI/ from the extra package with GBI/ on the SDSC Card.
  5. Copy ActionReplay/AUTOEXEC.DOL from the Swiss release to the root directory of the SDSC Card.
  6. (Optional) Set the hidden file attribute on AUTOEXEC.DOL.

Important: GBI/, MCBACKUP/ and AUTOEXEC.DOL must reside in the root directory. Extracting files selectively may result in loss of functionality.

SD Media Launcher + SD2SP2 with Swiss

  1. Obtain the SD Media Launcher, an SDSC Card (≤2 GB), an SD2SP2 and a microSD Card.
  2. Format the microSD Card for the SD2SP2 as FAT(16) or FAT32.
  3. Extract the main package to the root directory of the microSD Card for the SD2SP2. Do not extract to gbi-YYYYMMDD.
  4. (Optional) Merge GBI/ from the extra package with GBI/ on the microSD Card for the SD2SP2.
  5. Format the SDSC Card for the SD Media Launcher as FAT(16).
  6. Copy ActionReplay/AUTOEXEC.DOL from the Swiss release to the root directory of the SDSC Card for the SD Media Launcher.
  7. (Optional) Set the hidden file attribute on AUTOEXEC.DOL.

Important: GBI/, MCBACKUP/ and AUTOEXEC.DOL must reside in the root directory. Extracting files selectively may result in loss of functionality.

Memory Card + SD Card Adapter

  1. Obtain a Super Smash Bros. Melee Game Disc, a Memory Card, an SD Card Adapter and an SD Card.
  2. Format the SD Card as FAT(16) or FAT32.
  3. Extract the main package to the root directory of the SD Card. Do not extract to gbi-YYYYMMDD.
  4. (Optional) Merge GBI/ from the extra package with GBI/ on the SD Card.
  5. Rename the desired .dol or .dol+cli file on the SD Card to boot.dol.
  6. (Optional) Backup the Memory Card.
  7. Format the Memory Card on a system of the same region.
  8. Restore Home Bros. to the Memory Card.

Important: GBI/, MCBACKUP/ and boot.dol must reside in the root directory. Extracting files selectively may result in loss of functionality.

Memory Card + SD Card Adapter with Swiss

  1. Obtain a vulnerable Game Disc, a Memory Card (≥251 blocks), an SD Card Adapter or SD2SP2 and an SD Card.
  2. Format the SD Card as FAT(16) or FAT32.
  3. Extract the main package to the root directory of the SD Card. Do not extract to gbi-YYYYMMDD.
  4. (Optional) Merge GBI/ from the extra package with GBI/ on the SD Card.
  5. (Optional) Backup the Memory Card.
  6. Format the Memory Card on a system of the same region.
  7. Restore a usable game save exploit to the Memory Card.
  8. Restore GCI/boot.gci from the Swiss release to the Memory Card.

Important: GBI/ and MCBACKUP/ must reside in the root directory. Extracting files selectively may result in loss of functionality.

Memory Card

  1. Obtain a vulnerable Game Disc and a Memory Card.
  2. (Optional) Backup the Memory Card.
  3. Format the Memory Card on a system of the same region.
  4. Restore a usable game save exploit to the Memory Card.
  5. Restore the desired .gci file from the main package to the Memory Card.

Note: An SD Card Adapter is required for reading/writing data. Certain functionality will be lost.

GC Loader + SD Card Adapter

  1. Install the GC Loader.
  2. Obtain an SD Card Adapter or SD2SP2 and two SD Cards.
  3. Format the SD Card for the SD Card Adapter as FAT(16) or FAT32.
  4. Extract the main package to the root directory of the SD Card for the SD Card Adapter. Do not extract to gbi-YYYYMMDD.
  5. (Optional) Merge GBI/ from the extra package with GBI/ on the SD Card for the SD Card Adapter.
  6. Rename the desired .dol or .dol+cli file on the SD Card for the SD Card Adapter to boot.dol.
  7. Format the SDHC/SDXC Card for the GC Loader as FAT32.
  8. Copy boot.iso from the extra package to the root directory of the SDHC/SDXC Card for the GC Loader.

Important: GBI/, MCBACKUP/, boot.dol and boot.iso must reside in the root directory. Extracting files selectively may result in loss of functionality.

GC Loader + SD Card Adapter with Swiss

  1. Install the GC Loader.
  2. Obtain an SD Card Adapter or SD2SP2 and two SD Cards.
  3. Format the SD Card for the SD Card Adapter as FAT(16) or FAT32.
  4. Extract the main package to the root directory of the SD Card for the SD Card Adapter. Do not extract to gbi-YYYYMMDD.
  5. (Optional) Merge GBI/ from the extra package with GBI/ on the SD Card for the SD Card Adapter.
  6. Format the SDHC/SDXC Card for the GC Loader as FAT32.
  7. Copy GCLoader/boot.iso from the Swiss release to the root directory of the SDHC/SDXC Card for the GC Loader.
  8. (Optional) Set the hidden file attribute on boot.iso.

Important: GBI/, MCBACKUP/ and boot.iso must reside in the root directory. Extracting files selectively may result in loss of functionality.

GC Loader with Swiss

  1. Install the GC Loader.
  2. Obtain an SDHC/SDXC Card (≥4 GB).
  3. Format the SDHC/SDXC Card as FAT32. exFAT is not supported.
  4. Extract the main package to the root directory of the SDHC/SDXC Card. Do not extract to gbi-YYYYMMDD.
  5. (Optional) Merge GBI/ from the extra package with GBI/ on the SDHC/SDXC Card.
  6. Copy GCLoader/boot.iso from the Swiss release to the root directory of the SDHC/SDXC Card.
  7. (Optional) Set the hidden file attribute on boot.iso.
  8. Upgrade the GC Loader firmware to 2.0.0.BETA or later.

Important: GBI/, MCBACKUP/ and boot.iso must reside in the root directory. Extracting files selectively may result in loss of functionality.

IPL (PicoBoot) + SD Card Adapter

  1. Install gekkoboot to a supported IPL replacement.
  2. Obtain an SD Card Adapter and an SD Card.
  3. Format the SD Card as FAT(16) or FAT32.
  4. Extract the main package to the root directory of the SD Card. Do not extract to gbi-YYYYMMDD.
  5. (Optional) Merge GBI/ from the extra package with GBI/ on the SD Card.
  6. Rename the desired .dol or .dol+cli file on the SD Card to ipl.dol.

Important: GBI/, MCBACKUP/ and ipl.dol must reside in the root directory. Extracting files selectively may result in loss of functionality.

IPL (PicoBoot) + SD Card Adapter with Swiss

  1. Install gekkoboot to a supported IPL replacement.
  2. Obtain an SD Card Adapter and an SD Card.
  3. Format the SD Card as FAT(16) or FAT32.
  4. Extract the main package to the root directory of the SD Card. Do not extract to gbi-YYYYMMDD.
  5. (Optional) Merge GBI/ from the extra package with GBI/ on the SD Card.
  6. Copy DOL/swiss_rXXXX-compressed.dol from the Swiss release to the root directory of the SD Card.
  7. Rename swiss_rXXXX-compressed.dol on the SD Card to ipl.dol.
  8. (Optional) Set the hidden file attribute on ipl.dol.

Important: GBI/, MCBACKUP/ and ipl.dol must reside in the root directory. Extracting files selectively may result in loss of functionality.

DVD (XenoGC) + SD Card Adapter

  1. Install an available drive chip.
  2. Obtain a blank DVD±R, an SD Card Adapter or SD2SP2 and an SD Card.
  3. Format the SD Card as FAT(16) or FAT32.
  4. Extract the main package to the root directory of the SD Card. Do not extract to gbi-YYYYMMDD.
  5. (Optional) Merge GBI/ from the extra package with GBI/ on the SD Card.
  6. Rename the desired .dol or .dol+cli file on the SD Card to boot.dol.
  7. Burn boot.gcm from the extra package to the blank DVD±R.

Important: GBI/, MCBACKUP/ and boot.dol must reside in the root directory. Extracting files selectively may result in loss of functionality.

DVD (XenoGC) + SD Card Adapter with Swiss

  1. Install an available drive chip.
  2. Obtain a blank DVD±R, an SD Card Adapter or SD2SP2 and an SD Card.
  3. Format the SD Card as FAT(16) or FAT32.
  4. Extract the main package to the root directory of the SD Card. Do not extract to gbi-YYYYMMDD.
  5. (Optional) Merge GBI/ from the extra package with GBI/ on the SD Card.
  6. Copy DOL/swiss_rXXXX-compressed.dol from the Swiss release to the root directory of the SD Card.
  7. Rename swiss_rXXXX-compressed.dol on the SD Card to boot.dol.
  8. (Optional) Set the hidden file attribute on boot.dol.
  9. Burn boot.gcm from the extra package to the blank DVD±R.

Important: GBI/, MCBACKUP/ and boot.dol must reside in the root directory. Extracting files selectively may result in loss of functionality.

DVD (XenoGC) + Memory Card

  1. Install an available drive chip.
  2. Obtain a blank DVD±R and a Memory Card.
  3. Restore the desired .gci file from the main package to the Memory Card.
  4. Burn boot.gcm from the extra package to the blank DVD±R.

Note: An SD Card Adapter is required for reading/writing data. Certain functionality will be lost.

DVD (XenoGC)

This method is unsupported at this time.

Configuration

As Game Boy Interface still lack configuration files or a full user interface, this is done through command-line arguments.

Using Swiss

When loading a .dol file, Swiss first look for a .dcp file. This file contain a limited set of options that can be interactively changed before starting Game Boy Interface. This set of options can be expanded upon, but prior to Swiss v0.6r1424, is limited to 16 options with 8 choices of 31 characters. Note that the default shown positions don't represent the default settings.

For a more permanent or advanced configuration, a .cli file can be used. This file contain command-line arguments on separate lines.

A list of options and example configurations can be found in the subpage for each edition.

Using wiiload

Game Boy Interface can be reloaded using its built-in wiiload server with command-line arguments passed on to the wiiload client.

New overlays can also be uploaded in this fashion.

Other

The contents of a .cli file can be appended to a .dol file to form a .dol+cli file. The file must end with a blank line due to the hacky nature of this method.

When using a game save exploit, the resulting .dol+cli file can be converted to a .gci file using dol2gci.exe from the extra package.

Support

For FAQs, see Standard Edition § FAQs, Speedrunning Edition § FAQs, and High-Fidelity Edition § FAQs.

Licence

Copyright (c) 2014-2024, Extrems' Corner.org
All rights reserved. You may not sell or redistribute this software.
All trademarks used are properties of their respective owners.
Retrieved from "http://www.gc-forever.com/wiki/index.php?title=Game_Boy_Interface&oldid=7936"