Difference between revisions of "Game Boy Interface"

From GC-Forever Wiki
Jump to navigation Jump to search
(45 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
Line 8: Line 8:
 
| 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.}}
 
<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.
+
'''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]].
 
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]].
Line 20: Line 21:
  
 
== 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/Speedrunning Edition|speedrunning edition]] is ideal for impulse displays (CRT, 1ms MPRT 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/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 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]].
 +
 +
All editions can emulate the color and sound of the original handheld if desired.
 +
 +
==== TL;DR ====
 +
 +
: ''Open Source Scan Converter?'' → <code>[[Game Boy Interface/High-Fidelity Edition#Open Source Scan Converter|gbihf-ossc.dol+cli]]</code> or <code>gbihf.dol</code>
 +
: ''XRGB-mini Framemeister?'' → <code>[[Game Boy Interface/High-Fidelity Edition#XRGB-mini Framemeister|gbihf-xrgb.dol+cli]]</code> or <code>[[Game Boy Interface/Speedrunning Edition#XRGB-mini Framemeister|gbisr-xrgb.dol+cli]]</code>
 +
: ''Nintendo GameCube Component Video Cable?'' → <code>[[Game Boy Interface/High-Fidelity Edition#High-definition televisions|gbihf-cmpv.dol+cli]]</code>, <code>gbisr.dol</code> or <code>gbi.dol</code>
 +
: ''GCVideo-DVI/HDMI?'' → <code>[[Game Boy Interface/Speedrunning Edition#High-definition televisions|gbisr-gchd.dol+cli]]</code> or <code>gbi.dol</code>
 +
: ''Anything* else'' → <code>gbisr.dol</code> or <code>gbi.dol</code>
 +
 +
If you have something truly exotic, hopefully you don't need a tl;dr.
  
 
=== GBA-as-controller ===
 
=== GBA-as-controller ===
Line 31: Line 50:
 
* [[wikipedia:Slide Adventure MAGKID#Slide Controller|Nintendo DS Slide Controller]]
 
* [[wikipedia:Slide Adventure MAGKID#Slide Controller|Nintendo DS Slide Controller]]
 
* [[wikipedia:WarioWare: Twisted!|WarioWare: Twisted!]]
 
* [[wikipedia:WarioWare: Twisted!|WarioWare: Twisted!]]
 +
 +
[[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 ===
 +
 +
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 [[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 ===
 +
 +
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.
  
 
== Installation ==
 
== Installation ==
Line 36: Line 71:
 
{{Further|Booting Homebrew}}
 
{{Further|Booting Homebrew}}
  
=== SD Card ===
+
=== SDSC Card ===
  
# Purchase the [[Datel's SD Media Launcher|SD Media Launcher]].
+
# Obtain the [[Datel's SD Media Launcher|SD Media Launcher]].
# Format the SD Card as FAT.
+
# Format the SDSC Card as FAT(16).
# Extract the main package to the root directory of an SD Card.
+
# Extract the main package to the root directory of the SDSC Card.
# (Optional) Extract the extra package to the root directory of an SD Card.
+
# (Optional) Extract the extra package to the root directory of 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>.
+
# (Optional) Rename the desired <code>.dol</code> or <code>.dol+cli</code> file on the SDSC Card to <code>autoexec.dol</code>.
  
Important: Do not move the folders into a folder.
+
Important: Do not move the folders away from the root directory.
  
 
=== Memory Card + SD Card ===
 
=== Memory Card + SD Card ===
  
 
# Restore [//www.gc-forever.com/forums/viewtopic.php?f=39&t=3023 Home Bros.] to a Memory Card.
 
# Restore [//www.gc-forever.com/forums/viewtopic.php?f=39&t=3023 Home Bros.] to a Memory Card.
# Format the SD Card as FAT or FAT32.
+
# Obtain an [[SDGecko|SD Card Adapter]].
# Extract the main package to the root directory of an SD Card.
+
# Format the SD Card as FAT(16) or FAT32.
# (Optional) Extract the extra package to the root directory of an SD Card.
+
# 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.
 
# 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>.
  
Important: Do not move <code>boot.dol</code> or the folders into a folder.
+
Important: Do not move <code>boot.dol</code> or the folders away from the root directory.
  
 
=== Memory Card ===
 
=== Memory Card ===
  
# Restore a usable [[Booting Homebrew#Game Save Exploits|Game Save Exploit]] to a Memory Card.
+
# (Optional) Backup the Memory Card.
# Restore the desired <code>.gci</code> file from the main package to a 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 is required for data files. Some features won't be available.
 
Note: An SD Card is required for data files. Some features won't be available.
Line 65: Line 103:
 
=== IPL + SD Card ===
 
=== IPL + SD Card ===
  
# Install [https://github.com/redolution/iplboot/releases iplboot] to a supported [[IPL Replacement]].
+
# Install [https://github.com/redolution/iplboot/releases iplboot] to a supported [[IPL Replacement|IPL replacement]].
# Format the SD Card as FAT or FAT32.
+
# Obtain an [[SDGecko|SD Card Adapter]].
# Extract the main package to the root directory of an SD Card.
+
# Format the SD Card as FAT(16) or FAT32.
# (Optional) Extract the extra package to the root directory of an SD Card.
+
# 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.
 
# 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 into a folder.
+
Important: Do not move <code>ipl.dol</code> or the folders away from the root directory.
  
 
=== DVD + SD Card ===
 
=== DVD + SD Card ===
  
# Install an available [[Drivechip]].
+
# Install an available [[Drivechip|drive chip]].
# Format the SD Card as FAT or FAT32.
+
# Obtain an [[SDGecko|SD Card Adapter]].
# Extract the main package to the root directory of an SD Card.
+
# Format the SD Card as FAT(16) or FAT32.
# (Optional) Extract the extra package to the root directory of an SD Card.
+
# 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.
 
# 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 a DVD-R.
  
Important: Do not move <code>boot.dol</code> or the folders into a folder.
+
Important: Do not move <code>boot.dol</code> or the folders away from the root directory.
  
 
=== DVD + Memory Card ===
 
=== DVD + Memory Card ===
  
# Install an available [[Drivechip]].
+
# Install an available [[Drivechip|drive chip]].
 
# Restore the desired <code>.gci</code> file from the main package to a Memory Card.
 
# Restore the desired <code>.gci</code> file from the main package to a Memory Card.
 
# Burn <code>boot.gcm</code> from the extra package to a DVD-R.
 
# Burn <code>boot.gcm</code> from the extra package to a DVD-R.
Line 100: Line 140:
 
=== 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 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 108: Line 148:
 
=== Using wiiload ===
 
=== Using wiiload ===
  
Game Boy Interface can be reloaded using its internal <span class="plainlinks">[//wiibrew.org/wiki/Wiiload wiiload]</span> server with command-line arguments passed to the wiiload client.
+
Game Boy Interface can be reloaded using its built-in <span class="plainlinks">[//wiibrew.org/wiki/Wiiload wiiload]</span> server with command-line arguments passed on to the wiiload client.
  
New overlays can also be uploaded in this way.
+
New overlays can also be uploaded in this fashion.
  
 
=== Other ===
 
=== Other ===
  
 
The contents of a <code>.cli</code> file can be appended to a <code>.dol</code> file to form a <code>.dol+cli</code> file. The file must end with a blank line due to the hacky nature of this method.
 
The contents of a <code>.cli</code> file can be appended to a <code>.dol</code> file to form a <code>.dol+cli</code> file. The file must end with a blank line due to the hacky nature of this method.
 +
 +
When using a [[Booting Homebrew#Game Save Exploits|game save exploit]], the resulting <code>.dol+cli</code> file can be converted to a <code>.gci</code> file using <code>dol2gci.exe</code> from the extra package.
  
 
== Support ==
 
== Support ==
  
* [https://discord.gg/2dhfaHN Extrems' Corner.org Discord]
+
{{For|FAQs|Game Boy Interface/Standard Edition#FAQs{{!}}Standard|Game Boy Interface/Speedrunning Edition#FAQs{{!}}Speedrunning|Game Boy Interface/High-Fidelity Edition#FAQs{{!}}High-Fidelity}}
 +
 
 +
* [https://discord.extremscorner.org/ Extrems' Corner.org Discord]
 +
* [mailto:support@extremscorner.org Extrems' Corner.org Email]
 
* [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 125: Line 170:
  
 
<pre>
 
<pre>
Copyright (c) 2014-2018, Extrems' Corner.org
+
Copyright (c) 2014-2019, 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.

Revision as of 00:48, 12 October 2019

Game Boy Interface
Information
Author(s) Extrems
Type Utility
Version Rolling release
Licence Freeware
Links
Main download
Extra download
Website
Discussion
Source

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 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 of the original handheld if desired.

TL;DR

Open Source Scan Converter?gbihf-ossc.dol+cli or gbihf.dol
XRGB-mini Framemeister?gbihf-xrgb.dol+cli or gbisr-xrgb.dol+cli
Nintendo GameCube Component Video Cable?gbihf-cmpv.dol+cli, gbisr.dol or gbi.dol
GCVideo-DVI/HDMI?gbisr-gchd.dol+cli or gbi.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.

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. An SD Card and SD Card Adapter is required.

Installation

SDSC Card

  1. Obtain the SD Media Launcher.
  2. Format the SDSC Card as FAT(16).
  3. Extract the main package to the root directory of the SDSC Card.
  4. (Optional) Extract the extra package to the root directory of the SDSC Card.
  5. (Optional) Rename the desired .dol or .dol+cli file on the SDSC Card to autoexec.dol.

Important: Do not move the folders away from the root directory.

Memory Card + SD Card

  1. Restore Home Bros. to a Memory Card.
  2. Obtain an SD Card Adapter.
  3. Format the SD Card as FAT(16) or FAT32.
  4. Extract the main package to the root directory of the SD Card.
  5. (Optional) Extract the extra package to the root directory of the SD Card.
  6. Rename the desired .dol or .dol+cli file on the SD Card to boot.dol.

Important: Do not move boot.dol or the folders away from the root directory.

Memory Card

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

Note: An SD Card is required for data files. Some features won't be available.

IPL + SD Card

  1. Install iplboot to a supported IPL replacement.
  2. Obtain an SD Card Adapter.
  3. Format the SD Card as FAT(16) or FAT32.
  4. Extract the main package to the root directory of the SD Card.
  5. (Optional) Extract the extra package to the root directory of the SD Card.
  6. Rename the desired .dol or .dol+cli file on the SD Card to ipl.dol.

Important: Do not move ipl.dol or the folders away from the root directory.

DVD + SD Card

  1. Install an available drive chip.
  2. Obtain an SD Card Adapter.
  3. Format the SD Card as FAT(16) or FAT32.
  4. Extract the main package to the root directory of the SD Card.
  5. (Optional) Extract the extra package to the root directory of 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 a DVD-R.

Important: Do not move boot.dol or the folders away from the root directory.

DVD + Memory Card

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

Note: An SD Card is required for data files. Some features won't be available.

DVD

This method is unsupported at this time.

Configuration

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-2019, Extrems' Corner.org
All rights reserved. You may not sell or redistribute this software.
All trademarks used are properties of their respective owners.