Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Features

  • Native macOS 🎉
  • Quick transfer speeds 🚀
  • Copy ROMs from your physical cartridges 📦
  • Write ROMs to your own flash carts ⚡️
  • Backup / Restore / Erase game save files 👾

CartBoy

CartKit

CartKit is a companion framework, used by CartBoy, that defines general device support and functionality.

SerialDevice<GBxCart>

The SerialDevice<GBxCart> is the cart reader device from insidgeGadgetsController that is capable of the following:

  • Reading the cartridge header; and,
  • copying the cartridge ROM; and,
  • backing up save data (if supported); and,
  • restoring save data (if supported); and,
  • deleting save data (if supported); and,
  • flashing new ROMs to compatible cartridges; and,
  • erasing existing ROMs from compatrible cartridges.

A SerialDevice<GBxCart> cannot be instantiated directly; instead use open on GBxCart and you'll receive an isntance.

Read cartridge header

Simply open a SerialDeviceSession, then read the header (checking the Result):

GBxCart.open { serialDevice in
  switch serialDevice.header(forPlatform: GameboyClassic.self) {
  case .success(let header) :print(header)
  case .failure(let error)  :print(error)
  } 
}
Copy a cartridge's ROM

Some functions let you get updates on the progress of an operation (such as when copying a cartridge to your Mac). In these cases you must call the operation from queue other than the main one.

If you omit providing a progress callback, the operation blocks the main thread; this maybe useful for a number of scenarios (such as unit tests).

GBxCart.open { serialDevice in
  switch serialDevice.readClassicCartridge(progress: { print($0) }) {
  case .success(let cartridge) :print(cartridge.header)
  case .failure(let error)     :print(error)
  }
}

Acknowledgements

Special thanks to:

  • armadsen
  • insideGadgets

License

Copyright (c) 2019 Kevin J. Vitale

Permission is hereby granted, free of charge, to any person obtaining a copy 
of this software and associated documentation files (the "Software"), to deal 
in the Software without restriction, including without limitation the rights 
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 
of the Software, and to permit persons to whom the Software is furnished to do so, 
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Native macOS client for Gameboy cartridge readers & writers

Topics

Resources

Packages

No packages published