From 1ae417af5c59232f1de85eee89e30b3780e6a847 Mon Sep 17 00:00:00 2001 From: ashley Date: Thu, 19 Oct 2023 22:28:08 -0400 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++--------------------- 1 file changed, 8 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 8acbf62..873f8b7 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,11 @@ -Reskit +Reskit (stinkhead7ds edition) ====== -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. +This is an internal branch used by Rivethead Interactive for the development of _Stinkhead & The Seven Deadly Sins._ No issues, pull requests, or support of any kind will be taken for `level`, `easing`, and other tools exclusive to this branch. -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. \ No newline at end of file +## Internal Tools +* `level` - Generate a stinkhead7ds level from a Tiled editor module. +* `easing` - _Coming soon!_ Generate a cubic bezier easing curve for a given timespan e.g. for stylistic camera motion. + * Output will be in format: + * 2 bytes: Length of the curve, in 1/60 s increments. + * For each 1/60 increment: the value on the curve at the given 1/60 s increment. \ No newline at end of file