Skip to content

HerrZatacke/gb-printer-web

Repository files navigation

Basic usage

Supported formats

  • This Project is mainly built around the serial output of the original GBP Emulator
  • Cart .SAV files are also supported. The previously selected frame will be applied as well. If you're importing from a JP-Cartridge (Pocket Camera), you may want to change the "Frames when importing Cartridge dumps" option in the settings page

Frames

In a recent change (Version 1.7.0) the pre-compiled frames have been removed from this application.
The application now however gives you the opportunity to add all frames you like by yourself and also share them with others.
Maybe you have designed some frames by yourself, or you have aquired some previously unknown frames.

Uploading your own frames

You can upload your own frames by dragging any image into this app.
Dimensions of 160x144 are highly recommended, otherwise the image will be automatically scaled to size.
A lossles filetype is also recommended (e.g .png or .webp) After dragging your image into the app, you will be asked on how to import the frame.

Exporting/Importing your frames

In the import tab you can find an "Export frames" button. The resulting .json file can be shared and will contain all of your frames.
This .json file can be dragged into the application and will add all frames from that export to your application.

Development usage

The following ptions apply if you plan on contributong to this app:

Optional deployment config with config.json

Add a deploy section in config.json to automatically copy the created files to another location (e.g your arduino project).
If you set the option gzip to true, each file will be separately compressed. Useful for servers capable serving pre-zipped files. This saves ~1kB storage space.

{
  "ports": [...], 
  "deploy": {
    "dir": "/copy/all/files/to/that/folder",
    "gzip": true
  }
}

Local Setup

  • Install node.js if you haven't already.
  • Check out/clone/download this repository
  • Run npm i in the root directory via your commandline
  • Add a config.json in the root dir (see above)
  • Run npm start via your commandline
  • Open localhost:3000

Links and research

Research