reskit/README.md

25 lines
766 B
Markdown
Raw Normal View History

2021-02-12 03:56:54 +00:00
reskit
======
***INCOMPLETE***
2023-08-12 21:38:41 +00:00
Resource kit for the Sega Genesis/Megadrive. Converts tilesets and soundtracks for use in custom Sega Megadrive game engines.
2021-02-12 03:56:54 +00:00
2023-08-12 21:38:41 +00:00
# Tileset Tool
2021-02-12 03:56:54 +00:00
```
reskit tileset --input file.png --output file.bin --format bin
```
2023-08-12 21:38:41 +00:00
2021-02-12 03:56:54 +00:00
The file format will contain the palette required by the image, followed by the image.
## Caveats
* Image dimensions that are not a multiple of 8 will be rounded up to the nearest multiple of 8.
2023-08-12 21:38:41 +00:00
* Input images containing more than 15 colours will not be converted and will throw an error.
# Soundtrack Tool
```
reskit soundtrack --input song.dmf --output song.bin --format esf
```
The file format will contain the instrument definitions, followed by waveform samples, followed by an Echo Stream Format (ESF) stream.