Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
carts:nintendo:virtualboy [2021/09/30 20:47] – [Virtual Boy] hiccup | carts:nintendo:virtualboy [2023/03/05 22:25] (current) – cartridge_hermit | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Virtual Boy ====== | + | ====== Virtual Boy (WIP) ====== |
+ | {{wst> | ||
**//[copied from Google Doc - needs polishing]// | **//[copied from Google Doc - needs polishing]// | ||
- | ===== Introduction ===== | ||
- | Short description, | + | {{wst> |
- | + | ||
- | Dumping System X carts is fairly easy, and if you already have Hardware X, there are only a few small modification you need to do. | + | |
- | + | ||
- | or | + | |
- | + | ||
- | Dumping System Y discs is quite involved, and requires specialized hardware and software. | + | |
+ | ===== Introduction ===== | ||
+ | {{wst> | ||
===== Methods ===== | ===== Methods ===== | ||
- | - Numbered list of methods, with the top one being the most preferred/ | + | - [[#Virtual Boy Cart Programmer by RetroOnyx]] |
- | - With in-page links to each method | + | ==== Virtual Boy Cart Programmer by RetroOnyx==== |
- | + | ||
- | ==== Method 1 ==== | + | |
Required materials | Required materials | ||
- | * [[https:// | + | * [[https:// |
- | | + | * MicroSD Card (FAT32 formatted) |
- | | + | * USB-A male to USB-B male cable (Easy to find. Usually used with printers.) (Note: another serial cable with one end being USB-B male may work, but that is not documented in this guide.) (Additional note: if the USB port and/or cable cannot send enough voltage or current to power the device, the device can be modified to accept power from an external source. Some more details can be found [[https:// |
- | * [[https:// | + | * [[https:// |
- | | + | * This guide will show how to dump Virtual Boy Carts with Windows tools, if you are using another OS and would like to add your setup to the guide please |
Notes before starting | Notes before starting | ||
- | * This guide is for firmware version 1.9. As firmware updates happen, the instructions in this guide may need slight alteration for different firmware versions. You can check your firmware version at the top of the startup text, accessed via the < | + | * This guide is for firmware version 1.9. As firmware updates happen, the instructions in this guide may need slight alteration for different firmware versions. You can check your firmware version at the top of the startup text, accessed via the < |
- | * The “Mellot Programmer” GUI program by thunderstruck does not currently work with this method. That may change in the future, but this Method of the guide will only focus on use of an alternate | + | * The “Mellot Programmer” GUI program by thunderstruck does not currently work with this method. That may change in the future, but this guide will only focus on use of an alternate |
- | * The MicroSD card must have enough storage space for the given Virtual Boy ROM file. (This is kind of a given but worth mentioning I think.) | + | |
* It is much preferred but not required to have a way to directly connect to the MicroSD card, via a PC or other device able to access the filesystem. (There are functions in the Programmer that seem to allow copying files from the SD card to PC over Serial, but that will not be detailed in this guide.) | * It is much preferred but not required to have a way to directly connect to the MicroSD card, via a PC or other device able to access the filesystem. (There are functions in the Programmer that seem to allow copying files from the SD card to PC over Serial, but that will not be detailed in this guide.) | ||
* Please remember to take basic safety precautions. Things like working with dry hands and not reaching into the ports while the device is powered will suffice 99% of the time. Use this device and guide at your own risk. | * Please remember to take basic safety precautions. Things like working with dry hands and not reaching into the ports while the device is powered will suffice 99% of the time. Use this device and guide at your own risk. | ||
- | ==== Step 1: Safely plugging in the device ==== | + | ==== Section |
Before you plug in the USB cable for power, plug in the Virtual Boy cartridge and MicroSD card to avoid potentially damaging any of the hardware if power was sent down a wrong pin on a connector. | Before you plug in the USB cable for power, plug in the Virtual Boy cartridge and MicroSD card to avoid potentially damaging any of the hardware if power was sent down a wrong pin on a connector. | ||
Line 42: | Line 35: | ||
This safe plugging and unplugging practice is strongly recommended even when dumping multiple cartridges in one sitting. | This safe plugging and unplugging practice is strongly recommended even when dumping multiple cartridges in one sitting. | ||
- | < | + | {{: |
+ | {{: | ||
- | ^ The MicroSD slot is located on the back of the dumper of the basic design, or on the side opposite the USB-B port on the VB-based design. In the basic design, the MicroSD card faces outwards. | + | The MicroSD slot is located on the back of the dumper of the basic design, or on the side opposite |
- | < | + | {{: |
+ | {{: | ||
+ | {{: | ||
- | ^ The cartridge slot is located on the front of the dumper of the basic design, or on the bottom for the VB-based design. Note that, at least for the basic design, the cartridge slot is “keyed” so the cartridge can’t possibly fit facing the wrong direction. In the basic design, the cartridge faces inward (while looking at the display, you see the back of the cartridge). In the VB-based design, the cartridge faces up. | + | The cartridge slot is located on the front of the dumper of the basic design, or on the bottom for the VB-based design. Note that, at least for the basic design, the cartridge slot is “keyed” so the cartridge can’t possibly fit facing the wrong direction. In the basic design, the cartridge faces inward (while looking at the display, you see the back of the cartridge). In the VB-based design, the cartridge faces up. |
Make sure that the cartridge is firmly inserted so the pins all have solid connections. | Make sure that the cartridge is firmly inserted so the pins all have solid connections. | ||
- | Additionally, | + | Additionally, |
- | < | + | {{: |
+ | {{: | ||
- | ^ The USB-B port is located on the left side of the basic design, and on the side opposite to the MicroSD slot on the VB-based design. | + | The USB-B port is located on the left side of the basic design, and on the side opposite to the MicroSD slot on the VB-based design. |
Remember that the device receives power as soon as it is plugged into the PC. | Remember that the device receives power as soon as it is plugged into the PC. | ||
+ | After the Programmer is plugged in, and the USB-A side of the cable is plugged into the PC, it’s time for Section 2. | ||
- | + | ==== Section | |
- | After the Programmer is plugged in, and the USB-A side of the cable is plugged into the PC, it’s time for Step 2. | + | |
- | + | ||
- | ==== Step 2: Dumping the ROM ==== | + | |
After the device is plugged in, launch the RealTerm software. | After the device is plugged in, launch the RealTerm software. | ||
+ | * Under the " | ||
+ | {{: | ||
- | Basically… | + | * **(Don' |
- | - (Not necessary, personal preference) Under the “Display” tab, enable “Half Duplex” to see outgoing text. You may also enable “Scrollback” and set it to something like 200. | + | {{:carts: |
- | < | + | |
- | - Under the “Port” tab, set “Baud” to 500000 (yes, 500,000). Set “Parity” to none, “Data Bits” to 8, “Stop Bits” to 1, and “Hardware Flow Control” to none. | + | |
- | < | + | |
- | - Set the “Port” drop-down box to whichever COM port is to be used. To do this… click on the entry that says “(double click to scan ports)”. Then, click on the drop-down box again. Select the port which applies to you. My port is “3=\USBSER000” or just “3”. | + | |
- | < | + | |
- | - After setting these values, click “Change” to apply changes. | + | |
- | < | + | |
- | - Click “Open”, so now the button is depressed. This means communication is open. Switch to the “Send” tab. | + | |
- | < | + | |
- | - At this point, you can start receiving data! To send commands, click on the top left input-box (still under the “Send” tab), type the command, then click the button to the right of it that says “Send ASCII”. (Note: IIRC this is correct, but if not then try the “Send Numbers” button.) | + | |
- | - You may start receiving data from the Programmer. Also before now, the display on the Programmer may have turned on already. If either of these is not the case, send a < | + | |
- | - Either earlier or just now, the display should play a short animation, then stop and say “VB Cartridge Programmer”. | + | |
- | < | + | |
- | - And on the PC, it should tell you a bit about the hardware info. (You may have to resize the window!) This info includes the message “VB Programmer lives!” along with the device' | + | |
- | - If the cartridge info says “Unknown flashrom”, | + | |
- | < | + | |
- | To verify that the commands used in this guide are available to you, send the <PM> command | + | * Under the “Port” tab, set “Baud” |
- | < | + | * Click the drop-down box next to the word " |
- | - First, it is required | + | |
- | - In case you don’t know the ROM size of your cartridge, and/or your game isn’t in the list shown in this guide, you can set it to the maximum(?) size using the command < | + | {{: |
+ | {{: | ||
+ | {{:carts: | ||
- | - Note: if the size is set incorrectly, undocumented behavior can occur. If the size is too small, it will cut off the ROM data too early. If the size is too large, the data will start repeating. If you don’t know the correct size (as in the preceding bullet point a), and you set it to the wrong ROM size, you will just have to have the Overdump trimmed. This can be done in a hex editor like HxD, or with the help of a community member. | + | * After setting these values, click “Change” to apply changes. |
+ | * Click “Open”, so now the button appears pressed-in. This means communication | ||
- | - Note 2: If you happen to be dumping the ROM from a RetroOnyx / Mellott flash cartridge for which the Programmer was able to auto-detect the flash ROM size, part 11 is not necessary. This case will be quite rare. If you don’t know, then don’t worry about this note. | + | {{:carts: |
+ | {{: | ||
- | |**Game**|**ROM Size Command**|**ROM Size (bytes)**| | + | |
- | | | | | | + | |
- | | | | | | + | |
- | | | | | | + | |
+ | | ||
+ | {{: | ||
+ | {{: | ||
- | - The PC should ask you to enter a number, either 0 or 1, and press Enter. At this point, our method of input will change. Click the bottom of the black area, below the yellow text. Make a choice: either 0 or 1. Choice 0 is to automatically name the file, based on text characters fetched from the cartridge/ | + | * Optionally, to verify that the commands used in this guide are available to you, send the <PM> command to see the Programmer Menu. If it doesn’t display properly, make sure the window |
+ | * Note that your list of commands may not perfectly match the list shown in this image. Namely it may be missing commands RDR, RGH, RSD, RST, SC, and SSN_XXX. Those four commands are not required for dumping | ||
- | - If you chose 0 and it gave an error, please try again from 12 and select 1. If option 0 worked, you can skip to step 15. | + | {{: |
- | - Also, the Programmer display will say “Reading” as it waits for your input. | + | * First, it is required to set the size of the ROM. Find the game on the [[https:// |
+ | * If you don't know or can't determine the ROM size of a cartridge, | ||
+ | * Note: if the size is set incorrectly, | ||
+ | * Note 2: If you happen to be dumping the ROM from a RetroOnyx / Mellott flash cartridge of which the Programmer was able to auto-detect the Flash ROM size, the < | ||
- | <image> | + | <code> |
+ | |**Command**|**Size (Bytes)**|**MB**|**Mbit**| **bits**|**Notes** | ||
+ | | < | ||
+ | | < | ||
+ | | < | ||
+ | | < | ||
+ | | < | ||
+ | | < | ||
+ | | < | ||
+ | </code> | ||
+ | // | ||
+ | (Editor' | ||
- | - If you chose 1, you must now “Enter a short file name and press Enter.” You can type in a filename in the black area, then press Enter. The filename doesn’t matter, but certain characters may cause errors. So choose something simple like “dump.vb”. File extension also does not matter. | + | After the correct ROM size is set, the device is ready to dump the ROM. |
- | - If you enabled “Half Duplex” back in part 1, you should see both a red and a yellow text character for whatever you type. Don’t worry, it’s only doubled-up because of the way it displays. If “Half Duplex” is disabled, those inputted text characters should just be yellow. | + | |
- | < | + | |
- | (Note! This is the part that the aforementioned GUI program by thunderstruck gets stuck on. I don’t know the solution.) | + | * Send the command < |
- | - Now, after you hit Enter the ROM should begin dumping. It will take a few minutes. The terminal window will display dots to show it is still connected and receiving data, and the Programmer display will show a % completion bar. When it is finished, the Programmer | + | * The PC should ask you to enter a number: either 0 or 1. At this point, our method of input will change. Click the bottom of the black area, below the yellow text. Now make a choice, either 0 or 1, then press Enter. |
- | < | + | * If you chose Option 0 and it gave an error, please try again, send the <RDF> command, and select Option 1. If Option 0 worked, you can skip down a few steps. |
- | < | + | * The Programmer display |
- | < | + | |
- | - You can now unplug the USB cable from both the PC and the Programmer and safely remove both the Virtual Boy cartridge and the MicroSD card. Plug the MicroSD card into your PC, and the ROM file should be located in a folder titled “ROM_READ”.< | + | {{: |
+ | {{: | ||
- | Step 3: Dumping | + | * If you chose Option 1, you must now “Enter a short file name and press Enter.” You can type in a filename in the black area, then press Enter. The filename doesn’t matter, something simple like “dump.vb” works fine. File extension also does not matter, and can optionally be left off. (Note: the software used, both the Serial program and the Windows operating system for file management, might run into errors if the filename contains an invalid and/or non-ASCII text character.) |
+ | * If, for debugging purposes, at the beginning you enabled “Half Duplex” in the Display tab, you will see both a red and a yellow text character for whatever you type. Don’t worry, it’s only doubled-up because of this option. If “Half Duplex” is disabled, those inputted text characters will appear yellow and not doubled. | ||
- | Not documented yet. | + | {{: |
+ | {{: | ||
- | When dumping more than one cartridge... | + | // |
- | * Remember that the safe plugging and unplugging practice detailed in Step 1 and at the end of Steps 2 and 3 is still strongly recommended when dumping multiple cartridges in one sitting. | + | * After you hit Enter, |
- | * Additionally, if the RealTerm software is already active when plugging in the Programmer, glitchy undocumented behavior can occur. This probably won’t affect regular use, but if something seems broken then try restarting the software as well as replugging | + | |
- | External Links | + | {{: |
+ | {{: | ||
- | - Virtual Boy Cart Programmer order page. [[https:// | + | {{:carts:nintendo:virtualboy:vb_guide_25_lcd_reading_in_progress.jpg?480}} |
- | - VB Cart Programmer Quick Start Guide. [[https:// | + | {{:carts:nintendo:virtualboy:vb_guide_26_lcd_read_to_sd_complete.jpg?480}} |
- | - VB Cart Programmer Build (DIY Build Guide including firmware and 3D print design files). [[https:// | + | |
- | - No-Intro DAT-o-MATIC list of dumped Virtual Boy cartridges. [[https:// | + | |
+ | * You can now unplug the USB cable from both the PC and the Programmer, and safely remove both the Virtual Boy cartridge and the MicroSD card. Plug the MicroSD card into your PC, and the ROM file should be located in a folder on the root titled " | ||
- | ==== Method 2 ==== | + | When dumping more than one cartridge... |
- | Description, | + | * Remember that the safe plugging and unplugging practice detailed in Section 1 and at the end of Section 2 is still strongly recommended when dumping multiple cartridges in one sitting. |
+ | * Additionally, if the RealTerm software is already active (and communication Open) when plugging in the Programmer, glitchy undocumented behavior can occur. This probably won’t affect regular use, but if something unexpectedly doesn' | ||
- | ===== Verification | + | ==== External Links ==== |
- | + | ||
- | Description of how to verify that is a dump is correct. | + | |
- | + | ||
- | ===== Gathering Dump Info ===== | + | |
- | + | ||
- | <code -> | + | |
- | Dumping tool: | + | |
- | Dumper: | + | |
- | Affiliation: | + | |
- | Dump creation date: | + | |
- | Dump release date: | + | |
- | + | ||
- | Title: | + | |
- | Region: | + | |
- | Edition: | + | |
- | Languages: | + | |
- | Language Select: | + | |
- | WikiData ID: | + | |
- | + | ||
- | Size: | + | |
- | CRC32: | + | |
- | MD5: | + | |
- | SHA-1: | + | |
- | SHA-256: | + | |
- | </ | + | |
- | * General Note: If you are submitting this info to a person/group in order for them to add it to a database, you can skip the transcription of some things, | + | * Virtual Boy Cart Programmer order page. [[https:// |
+ | * VB Cart Programmer Quick Start Guide. [[https:// | ||
+ | * VB Cart Programmer Build (DIY Build Guide including firmware | ||
+ | * No-Intro DAT-o-MATIC list of dumped Virtual Boy cartridges. [[https:// | ||
- | ===== Submitting Dump Info ===== | + | ===== Gathering and Submitting Dump Info ===== |
- | {{wst>submitting_dump_info_nointro}} | + | {{wst>see_submission_page}} |