doukutsu-rs/README.md

doukutsu-rs

Download latest Nightly builds (Requires being logged in to GitHub)

A re-implementation of Cave Story (Doukutsu Monogatari) engine written in Rust.

The project is still incomplete and not fully playable yet. Click here to see the current status of the project.

Join the Discord server

Data files

This repository does not contain any copyrighted files.

For better user experience, pre-built binaries are distributed with slightly modified freeware game files.

doukutsu-rs should work fine with pre-extracted and tweaked data files from this repository, NXEngine(-evo) extracted freeware data files and Cave Story+ data files.

Vanilla Cave Story does not work yet because some important data files have been embedded inside the executable. and we don't have a loader/extractor implemented yet.

Where to get them?

Freeware

• https://github.com/doukutsu-rs/game-data - Freeware game data distributed with CI builds, based on those two below.
• https://github.com/Clownacy/CSE2/archive/enhanced.zip - copy game_english/data from archive to the runtime directory (place you run the executable from, usually project root)
• https://github.com/nxengine/nxengine-evo/releases/download/v2.6.4/NXEngine-v2.6.4-Win32.zip - copy NXEngine-evo-2.6.4-xxx/data from the archive to runtime directory

Cave Story+

• SDL version (first released in 2011 on Steam)
  • PC release (Steam) - Copy data folder from installation directory (guide for Steam) to the runtime directory.
  • PC release (Epic Games Store) - Essentially the same thing as with Steam version.
  • PC release (Humble Bundle) - Essentially the same thing as with Steam version.
• KAGE version (first released in 2017 on Switch)
  • PC release - Sadly not there yet but Tyrone mentioned it's coming in 2021.
  • Switch release - (tested only with eShop version) Extract data directory from romfs. Requires a hacked console and a recent and legal copy of the game. If you don't know how, look in Google how to exactly do that because the methods really differ.

Mandatory screenshots

Freeware data files:

Cave Story+ data files:

Credits

• Studio Pixel/Nicalis for Cave Story
• ggez - we took few bits from it while moving away to SDL2.
• @ClayHanson_ - for letting us use his .pxchar skin format from Cave Story Multiplayer mod.
• Cave Story Tribute Site - has lots of useful resources related to the game.
• Clownacy - widescreen camera code.
• LunarLambda for organism - which is being used by us as .org playback engine.
• @uselesscalcium - Android port icon artwork