reskit/README.md

Reskit
======

The **R**etro **E**ntertainment **S**oftware Tool**kit** (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](https://git.ne0ndrag0n.com/ashley/reskit/wiki/?action=_pages) 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](https://git.ne0ndrag0n.com/user/sign_up) for an account on Temple of the Neon Dragon, then see the [Issues page](https://git.ne0ndrag0n.com/ashley/reskit/issues).

# Pull Requests/Contributing
Contributions are welcome! Request a repository slot in [this issue](https://git.ne0ndrag0n.com/ashley/reskit/issues/4) and I will allocate a repository for your account so that you may fork Reskit.
Update README.md 2023-08-26 23:19:26 +00:00			`Reskit`
Update README.md 2021-02-12 03:56:54 +00:00			`======`

Update README.md 2023-08-26 23:19:26 +00:00			`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.`
Update README.md 2021-02-12 03:56:54 +00:00
Update README.md 2023-08-26 23:19:26 +00:00			To get started, check out the [wiki](https://git.ne0ndrag0n.com/ashley/reskit/wiki/?action=_pages) or type `reskit --help` to view a list of supported tools and options.
Update README.md 2021-02-12 03:56:54 +00:00
License software to the public and update README.md 2023-09-02 18:46:55 +00:00			`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`

Update README.md 2023-08-26 23:19:26 +00:00			`# 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`.
Contributor information 2023-09-03 04:12:59 +00:00
			`# Reporting Issues`
			`First [register](https://git.ne0ndrag0n.com/user/sign_up) for an account on Temple of the Neon Dragon, then see the [Issues page](https://git.ne0ndrag0n.com/ashley/reskit/issues).`

			`# Pull Requests/Contributing`
			`Contributions are welcome! Request a repository slot in [this issue](https://git.ne0ndrag0n.com/ashley/reskit/issues/4) and I will allocate a repository for your account so that you may fork Reskit.`