Skip to content

Input JSON format

Matt Greer edited this page Oct 7, 2023 · 1 revision

Sromcrom takes a JSON file as its input. This page documents the format of that JSON. If your JSON does not conform to this format, an error will be thrown.

JSON overview

The overall shape of the JSON is:

{
  "romPathRoot": <string>,
  "padCROMFilesxTo: [<number>],
  "palettes": [PaletteJsonSpec],
  "eyecatcher": [EyecatcherJsonSpec],
  "sromImages: [SromImagesJsonSpec],
  "tilesets": [TilesetJsonSpec],
  "cromImages": [CromImagesJsonSpec],
  "cromAnimations": [CromAnimationsSpec]
}

All entries are optional except romPathRoot.

  • romPathRoot, : Where to emit the binary ROM files too, relative to the location of the JSON file
  • padCROMFilesTo, []: The CROM files will be at least this big, in bytes, and padded with zeros if needed.

The rest are TODO. In the meantime, you can figure this out by looking at types.ts

Clone this wiki locally