||1 week ago|
|.cargo||3 years ago|
|app||2 weeks ago|
|drsandroid||4 months ago|
|drshorizon||4 months ago|
|misc/json-schemas||1 year ago|
|res||2 months ago|
|src||1 week ago|
|.appveyor.yml||1 month ago|
|.gitignore||6 months ago|
|Cargo.toml||4 weeks ago|
|LICENSE||1 year ago|
|README.md||4 months ago|
|build.rs||4 months ago|
|rustfmt.toml||6 months ago|
A fully playable re-implementation of Cave Story (Doukutsu Monogatari) engine written in Rust.
Get nightly builds from AppVeyor (recommended for now, has latest fixes and improvements)
Permalinks to latest builds from
- Windows (64-bit)
- Windows (32-bit)
- macOS (Intel, 64-bit, 10.14+)
- macOS (Apple M1, 11.0+)
- Linux (64-bit)
macOS note: If you get a
"doukutsu-rs" can't be openedmessage, right-click doukutsu-rs.app and click open.
Get stable/beta builds from GitHub Releases (Includes Android builds)
In order to work doukutsu-rs needs to be paired with supported data files. This repository does not contain any data files.
doukutsu-rs works fine with freeware data files or NXEngine(-evo) or from a supported copy of Cave Story+.
Supported game editions and data file acquisition guides
doukutsu-rs works out of the box when it's placed in the same directory as the original Doukutsu.exe executable. On the initial
startup, doukutsu-rs will automatically extract the additional resources that are embedded in the vanilla game into the
directory. Until that is done, both doukutsu-rs and the vanilla executable have to exist in the directory.
doukutsu-rs can be used as drop-in replacement for
CaveStory+.exe. No modifications to game files are needed.
Original version (first released in 2011 on Steam) - expand for instructions
Steam release (Win/Mac/Linux)
data folder is in the same place across all platforms.
If you want to use doukutsu-rs as a substitute for Mac version of Cave Story+ (which at moment of writing doesn't work on 10.15+ anymore), do the following:
- Find the doukutsu-rs executable:
- In AppVeyor builds, it's in
- In your own builds, it's in
- In AppVeyor builds, it's in
- Open Steam Library, select
Cave Story+, press the
Managebutton (gear icon) and select
Local Filesand press
- Open the
Cave Story+.appbundle and navigate to
- Rename the
Cave Story+executable to something else or delete it.
- Copy the doukutsu-rs executable and rename it to
- Launch the game from Steam and enjoy!
The archive from Humble Bundle contains the necessary
data folder, in the same folder as
Remastered version (first released in 2017 on Switch)
Note that this version is incompatible with saves from the original version.
Interchanging the save files may result in spawning in wrong locations, softlocks, graphical glitches, or other issues.
data folder (contained in
romfs) from your console using tool such as nxdumptool.
- doukutsu-rs doesn't rely on the original ROM or executable, you just need the data files, go to
RomFS optionsmenu to just extract the files to SD card so you don't need to do any extra steps.
- Ensure you're dumping the files with update included (
Use update/DLCoption), as 1.0 isn't supported.
Nintendo Switch homebrew port specific info
If you're running the homebrew port (drshorizon.nro) on your Switch, you can avoid the dumping step, doukutsu-rs will
automatically detect and mount the data files if you run it over Cave Story+ in Title Override mode (hold
R while starting CS+ and launch d-rs from hbmenu).
You can put your own data files in
/switch/doukutsu-rs/data directory on SD Card, which will be overlayed over RomFS if
you run it in setup described above.
Same controls as the default for freeware and Cave Story+ keyboard.
To change, use the control customization menu or edit
doukutsu-rs\data\settings.json within your user directory.
|Inventory / Skip cutscene||
Alt + Enter- Toggle Fullscreen
F2(While paused) - Quick Restart
- Studio Pixel/Nicalis for Cave Story
- @Daedily - brand artwork (Icon / Banner / Server), screenshots for this guide.
- ggez - parts of it are used in
crate::framework, notably the VFS code.
- Clownacy - widescreen camera code.
- LunarLambda for organism - used as basis for our Organya playback engine.