ashley
/
reskit
1
0
Fork 0
Code Issues 4 Pull Requests Packages Projects Releases Wiki Activity

Update README.md

master
Ashley N. 2023-08-12 17:38:41 -04:00
parent 81326d32df
commit 30b55eb8e0
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -3,14 +3,22 @@ reskit
***INCOMPLETE*** ***INCOMPLETE***
Resource kit for the Sega Genesis/Megadrive. Resource kit for the Sega Genesis/Megadrive. Converts tilesets and soundtracks for use in custom Sega Megadrive game engines.
# Convert PNG to tile + palette set # Tileset Tool
``` ```
reskit tileset --input file.png --output file.bin --format bin reskit tileset --input file.png --output file.bin --format bin
``` ```
The file format will contain the palette required by the image, followed by the image. The file format will contain the palette required by the image, followed by the image.
## Caveats ## Caveats
* Image dimensions that are not a multiple of 8 will be rounded up to the nearest multiple of 8. * Image dimensions that are not a multiple of 8 will be rounded up to the nearest multiple of 8.
* Input images containing more than 15 colours will not be converted and will throw an error. * 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.