thies/gameboy-camera-image-extractor

This is a PHP library for extracting Game Boy Camera photos from a save ram (.sav) file and writing them in various image formats.

Maintainers

Details

github.com/thies4321/gameboy-camera-image-extractor

Source

Issues

Installs: 3

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

1.1.1 2025-01-09 16:56 UTC

Requires

  • php: ^8.4
  • ext-gd: *

Requires (Dev)

MIT 2fa7db9ac567e9cd32dd690044560a6f6f629fe4

  • Thies Verhave

This package is auto-updated.

Last update: 2025-04-09 17:37:05 UTC

README

This is a PHP library for extracting Game Boy Camera photos from a save ram (.sav) file and writing them in various image formats.

The library requires the GD php extension to work.

To see it in action go to https://gbcamera.net

Basic usage

To just extract the images and store them on disk use the image writer:

$imageWriter = new \GameboyCameraImageExtractor\ImageWriter();
$imageWriter->extractAndStoreToDisk('/path/to/file.sav', '/output/directory');

By default, it outputs the images in PNG format. There are multiple adapter available for different image formats. For example, if you want to output the images in webp format you can use the Webp adapter:

$webpAdapter = new \GameboyCameraImageExtractor\Writer\Webp();
$imageWriter = new \GameboyCameraImageExtractor\ImageWriter($webpAdapter);
$imageWriter->extractAndStoreToDisk('/path/to/file.sav', '/output/directory');

It will output the images in webp format. You can also extend \GameboyCameraImageExtractor\Writer\Writer and write you own implementation for your specific needs.

If you want to get the images without writing them to disk you can use the image extractor:

$imageExtractor = new \GameboyCameraImageExtractor\ImageExtractor();
$imageExtractor->extractFromFile('/path/to/file.sav');

This will return an array of \GdImage objects.

Palettes

You can also use palletes to give the image a bit more color.

Basic usage:

$palette = new \GameboyCameraImageExtractor\Entity\Palette('#ffffff', '#cccccc', '#666666', '#000000');
$imageWriter = new \GameboyCameraImageExtractor\ImageWriter();
$imageWriter->extractAndStoreToDisk('/path/to/file.sav', '/output/directory', $palette);

There are some presets, I might add some more at a later time.

$preset = \GameboyCameraImageExtractor\Enum\PalettePreset::GameboyPlayer;
$palette = \GameboyCameraImageExtractor\Entity\Palette::createForPreset($preset);

Credits

I could not have made this without the works of raphnet: https://github.com/raphnet/gbcam2png