reskit/README.md

1.5 KiB

Reskit

The Retro Entertainment Software Toolkit (reskit) is a suite containing a variety of tools useful for creating 8-bit and 16-bit console homebrew software. Reskit allows you to easily generate tilemaps and convert soundtracks for import into your homebrew game projects.

To get started, check out the wiki or type reskit --help to view a list of supported tools and options.

Reskit is beta software! Please read important disclaimers for each tool.

Available Tools

  • tileset - Convert an image to a series of tiles for a given console.
    • Supported consoles: Sega Mega Drive VDP (tile and sprite order)
  • soundtrack - Convert a music sequence to an on-console format/sound driver
    • Supported input formats: DMF (Deflemask) Version 27 (1.1.8)
    • Supported export formats: Echo Sound Engine (ESF) for Sega Mega Drive

Build

Reskit is developed in Rust and provided as a cargo crate. Simply type cargo build to build the project. Output should be in target/debug/reskit.

Reporting Issues

First register for an account on Temple of the Neon Dragon, then see the Issues page.

Pull Requests/Contributing

Contributions are welcome! Request a repository slot in this issue and I will allocate a repository for your account so that you may fork Reskit.