Difference between revisions of "GBxCart RW Manual"

Revision as of 02:28, 15 March 2020

1 Quick How to Use
- 1.1 For Windows
- 1.2 For Linux/Mac
2 Troubleshooting
3 GUI Interface - Backup ROM, Backup save and Restore save
4 Console Interface - Backup ROM, Backup save and Restore save
5 Gameboy Camera Saver
6 GUI Flasher - Write ROMs to Flash Carts
7 Console Flasher - Write ROMs to Flash Carts
8 Nintendo Power Cart – Backup Full ROM/Hidden Sector, Backup Saves, Restore Saves, Flasher

Quick How to Use

For Windows

1. Download and Install Microsoft Visual C++ Redistributable Packages (x86 and x64) for Visual Studio 2015 – https://www.microsoft.com/en-us/download/details.aspx?id=53840

2. Extract the software zip file (found in Downloads) and plug in GBxCart RW. Windows will look for the CH340G driver. If the device isn’t automatically detected, you will need to open up Device manager, find the “USB 2.0 Serial” device and update the driver using the files in the Drivers folder.

3. Open up the GUI from Interface_Programs\GBxCart_RW_vx.x_GUI_Interface\GBxCart_RW_vx.x.exe. You can move this folder anywhere you like.

4. Unplug GBxCart RW

5. For v1.3 boards: You select the correct voltage via the software – the GB or GBA selection box in the GUI For v1.2 boards: Select the correct voltage for your cartridge using the switch (GB/GBC uses 5V while GBA uses 3.3V).

6. Insert your cartridge and then plug in GBxCart RW. Click the Connect button and the little USB icon should turn from grey to green.

7. You should now click “Read Cart Info” to read some basic information from the cartridge. Make sure you only continue if Logo Check is Ok. You can now backup the ROM, backup your save game to your PC and restore your save game to the cartridge.

For Linux/Mac

You may need to install this CH340G driver – https://github.com/adrianmihalko/ch340g-ch34g-ch34x-mac-os-x-driver

1. Extract the software zip file (found in Downloads) and plug in GBxCart RW.

2. Open a terminal window and change directory to the Console Interface (Interface_Programs\GBxCart_RW_vx.x_Console_Interface).

3. You will need to compile the application by typing in “sudo make”.

4. You can then run the application by typing in “sudo ./gbxcart_rw_console_v1.20” for example.

If it has trouble connecting to the serial port, try running “ls /dev” and see if you can find a device similar to tty.chusbserial630.

If you find one similar, you will need to edit the rs232/rs232.c file, just replace one of the existing entries in the variable below: char *comports[RS232_PORTNR]={“/dev/ttyS0?,”/dev/ttyS1?,”/dev/ttyS2”,

And then re-compile.

Please send us a quick email about the port you find so we can provide an official update.

Troubleshooting

If no lights are showing when plugging in the device or the device isn’t being detected

• Try using a different USB cable (preferably a non-phone type USB cable). This Startech cable is know to work.

• Try using a non-USB 3.0 port if you are using one.

• Try to unplug all other USB devices except your keyboard and mouse.

• Uninstall the device from Device Manager and choose to delete the driver files as well, then try to re-install the drivers and ensure the device shows as CH340.

• If it’s timing out when performing any of the functions:

• Try using a different USB cable (preferably a non-phone type USB cable).

• Check to see that you have no other software which monitors COM ports such as the Arduino IDE running in the background.

• Try using the Console Interface

If the GUI won’t connect

Make sure the COM port in device manager for CH340 is under COM20

Check the config.ini file is similar to the below. The first number is the com port number which can be different and the second number is the serial port speed which should be fixed at 1000000.

16

1000000

0

If the GUI times out / stalls when writing to a flash cart

• Use the dedicated flasher program instead of the GUI, it's easier to use too.

If game save backups don't work on an emulator

• Make sure it's not a clone / repo flash cart as sometimes they store the save in the flash chip itself.

• For GBA games, check that the save type and size information matches the game listed here: https://raw.githubusercontent.com/mamedev/mame/master/hash/gba.xml. If it doesn't match, change the save type and size from Cart > Specify Cart Info and try again.

If you’ve tried all the above steps but are still experiencing issues, please jump on our Discord server.

If game saves aren't being restored to a cartridge

• Make sure the cartridge contacts are clean, you can use isopropyl or the pencil eraser method. On rare cases, you may need to re-seat the cart.

• The battery may be too low. Check you can save on the cart itself by saving, powering off for 5-10 minutes, powering back on and checking the save is still there.

• If that works, try using GBxCart to restore the save file, then back it up to another file and use a hex editor like HxD to compare the files. If they match, then it is likely something with the cartridge.

• Make sure it's not a clone / repo flash cart as sometimes they store the save in the flash chip itself.

• For GBA games, check that the save type and size information matches the game listed here: https://raw.githubusercontent.com/mamedev/mame/master/hash/gba.xml. If it doesn't match, change the save type and size from Cart > Specify Cart Info and try again.

If you’ve tried all the above steps but are still experiencing issues, please jump on our Discord server.

After writing a game to a flash cart, it doesn't work properly

Make sure the cartridge contacts are clean, you can use isopropyl or the pencil eraser method. On rare cases, you may need to re-seat the cart.

If you have a GBA game, one problem could be the flash cart save type/size doesn't match what the game uses, have a look at this section: https://flashcartdb.com/index.php/Clone_and_Repo_Cart_Problems

Try backing up the flash cart and using HxD to compare with the ROM file you wrote. You can do this by opening up both files in HxD, pressing Ctrl+K and then pressing F6 to continue checking.

In the above example, the byte at 0x01 doesn't match. Try to re-write to the flash cart. It could be that the flash cart doesn't have enough space and when writing the cart, it loops back and overwrites the existing contents. Another reason could be that nothing actually wrote to the flash cart and what you are seeing is the original flash cart contents. Try flashing a non-related ROM file such as a .sav file or any other file on your PC.

In the above example, the flash cart has 0xFF which means a blank area of the flash memory. This could mean the wrong flash cart option was used or the writing processes ended early.

In the above example, the flash cart has 0xFF right at the start. Likely the wrong flash cart option was used as it erased the wrong sector or didn't write at all.

GUI Interface - Backup ROM, Backup save and Restore save

Setup

1. Download and Install Microsoft Visual C++ Redistributable Packages (x86 and x64) for Visual Studio 2015 - https://www.microsoft.com/en-us/download/details.aspx?id=53840

2. Open \Interface_Programs\GBxCart_RW_vx.x_GUI_Interface\GBxCart_RW_vx.x.exe and click the Connect button button. It should automatically detect the device and the little USB icon should turn from grey to green. For the v1.3 board - You should choose which mode you would like to select. For the 1.2 board and below - You will see the mode currently selected by the switch.

(If the little USB icon doesn’t turn green, please check that your system is detecting the CH340 device in the Device Manager)

Inserting/Removing Cartridges

1. Before inserting the cartridge, select the correct voltage for your cartridge using the switch (GB/GBC use 5V while GBA uses 3.3V). If you have the v1.3 board, this is controlled by software – in the GUI you choose GB or GBA mode and press connect. Connect the USB cable to ensure the correct voltage LED lights up.

2. Unplug the device from your computer. Insert your cartridge to the device (make sure the cartridge sticker is facing up and that you can see the pins on the bottom of the cartridge), connect the device again and click Open Port as before.

3. You can now read the cart info, read the ROM, etc.

4. When removing cartridges, always unplug the USB cable from the device first before removing the cartridge.

Reading the Cartridge Information

Press the Read Cart Info button and the cartridge information should show up (GBA carts can take 4 seconds as tests are being performed to determine the ROM and SRAM/Flash/EEPROM sizes). Note: You don’t need to read the cart info for Flash Carts.

Make sure that the “Logo check” comes back as OK otherwise the cartridge may not be read correctly and you will have to disconnect the device, remove and re-insert the cartridge.

If the cartridge information doesn’t match what you know to be correct, you can select “Cart” from the top menu and select “Specify Cart Info” button to change the ROM size and RAM size/type.

Read the ROM

You can now press the “Read ROM” button to download the ROM from the cartridge to your PC, it will be saved as <Gametitle>.gb or <Gametitle>.gba.

For GBA games as there is no header information to report the game size, GBxCart RW will try to calculate it. Occasionally it can be wrong, especially for flash carts.

We recommended verifying your Gameboy/Gameboy Advance ROMs and Saves by using emulators such as BGB for Gameboy and VisualBoyAdvance for Gameboy Advance.

Backup save from Cartridge to PC

You can download the save game from your cartridge to your PC by pressing the “Backup Save” button, it will be saved as <Gametitle>.sav. If a save file exists on your PC, you will be asked to confirm you wish to overwrite the save file or save the file with the date/time added to it.

For Gameboy Advance cartridges, GBxCart tries to automatically detect the save type so every now and then it can get the save type wrong. You can go into Cart Info to adjust the save type settings.

If you are backing up a game regularly as you progress through it, it’s best to turn on the Option > “Always add date/time to backed up Save Game files” to Yes. This will add the date/time to your save file so you can have multiple save files on your PC.

We recommended verifying your Gameboy/Gameboy Advance ROMs and Saves by using emulators such as BGB for Gameboy and VisualBoyAdvance for Gameboy Advance.

Restore save from PC to Cartridge

You can upload the save game from your PC to your cartridge by pressing the “Restore Save” button, it will load the save file <Gametitle>.sav. You will always be asked to confirm you wish to overwrite the save game on the cartridge.

Erase save from cartridge

You can erase the save game from the cartridge by pressing the “Cart” menu item and selecting “Erase Save”. You will always be asked to confirm. This is useful if you wish to wipe the cartridge and insert it back to the Gameboy/Gameboy Advance to start a new save.

Change the directory to save to and load from

You can change the directory where ROMs are saved to and where save games are saved to and loaded from. This might be useful if you have multiple saves for the same game.

When you click “Directory” in the menu it will advise you the folder where you opened the software from. You can then click the folder listed and it will let you change the folder location.

To always remember the location, make sure “Remember” is set to Yes.

Add date/time to Save File and Prompt for Save Game file when restoring

The “Always add date/time to backed up Save Game files” option is useful if you are backing up a game regularly as you progress through it. This will add the date/time to your save file so you won’t overwrite your existing save file, for example, F1RACE_2018.02.25-15.33.12.sav.

The “Always prompt for Save Game file when restoring” option will allow you to choose your save file to restore, this is useful if you use the option above.

Console Interface - Backup ROM, Backup save and Restore save

Windows Setup

1. Open \Interface_Programs\GBxCart_RW_vx.x_Console_Interface\GBxCart_RW_Console_vx.x.exe and the options menu should appear.

2. If the device couldn’t be autoamatically detected, open the \Interface_Programs\GBxCart_RW_vx.x_Console_Interface\config.ini file and change the first number to your COM port, e.g. 9 = COM9 and change the second number to the baud rate, default is 1Mbit (1000000) which should work fine. Your COM port can be found in device manager.

Linux/Mac Setup

1. Extract the software zip file (found in Downloads) and plug in GBxCart RW.

2. Open a terminal window and change directory to the Console Interface (Interface_Programs\GBxCart_RW_vx.x_Console_Interface)

3. You will need to compile the application by typing in "sudo make".

4. You can then run the application by typing in "sudo ./gbxcart_rw_console_v1.20" for example.

If it has trouble connecting to the serial port, try running “ls /dev” and see if you can find a device similar to tty.chusbserial630.

If you find one similar, you will need to edit the rs232/rs232.c file, just replace one of the existing entries in the variable below: char *comports[RS232_PORTNR]={“/dev/ttyS0?,”/dev/ttyS1?,”/dev/ttyS2?,”/dev/ttyS3?,”/dev/ttyS4?,

And then re-compile and try running the application again.

Please send us a quick email about the port you find so we can provide an official update.