Game Boy Interface

From GC-Forever Wiki
Revision as of 13:05, 23 June 2021 by Extrems (talk | contribs) (TL;DR)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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
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). 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, 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.

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

Open Source Scan Converter?gbihf-ossc.dol+cli, gbihf-carby+ossc.dol+cli or gbihf.dol
RetroTINK-5X Pro?gbihf-ossc.dol+cli or gbi-carby+rt5x.dol+cli
XRGB-mini Framemeister?gbihf-xrgb.dol+cli
GCVideo-DVI v3.0 and later?gbihf-gcdv-v3.dol+cli or gbi.dol
Nintendo GameCube Component Video Cable?gbihf-cmpv.dol+cli or gbihf.dol
GCVideo-DVI v2.4d and earlier?gbisr-gcdv.dol+cli or gbi.dol
RetroTINK-2X?gbisr.dol
Anything* elsegbisr.dol or gbi.dol

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

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.

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.

Important: GBI/, MCBACKUP/ and AUTOEXEC.DOL must reside in the root directory.

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.

Important: GBI/, MCBACKUP/ and AUTOEXEC.DOL must reside in the root directory.

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.

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.

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 read/write. Some features won't be available.

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.

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.

Important: GBI/, MCBACKUP/ and boot.iso must reside in the root directory.

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.
  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.

Important: GBI/, MCBACKUP/ and boot.iso must reside in the root directory.
Note: An SD Card Adapter is required for writing. Some features won't be available. exFAT is not supported.

IPL + SD Card Adapter

  1. Install iplboot 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.

IPL + SD Card Adapter with Swiss

  1. Install iplboot 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.

Important: GBI/, MCBACKUP/ and ipl.dol must reside in the root directory.

DVD + 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.

DVD + 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. Burn boot.gcm from the extra package to the blank DVD±R.

Important: GBI/, MCBACKUP/ and boot.dol must reside in the root directory.

DVD + 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 read/write. Some features won't be available.

DVD

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

Licence

Copyright (c) 2014-2021, Extrems' Corner.org
All rights reserved. You may not sell or redistribute this software.
All trademarks used are properties of their respective owners.