mirror of https://github.com/doukutsu-rs/doukutsu-rs synced 2024-11-22 13:42:47 +00:00

Go to file

Alula 319289ca67 new android port		2021-02-24 09:28:47 +01:00
.cargo	Initial Android support and some ggez rewrite	2020-10-07 16:08:12 +02:00
.github/workflows	remove arm64 build since linking opengl is kinda broken	2020-11-25 15:12:33 +01:00
app	new android port	2021-02-24 09:28:47 +01:00
gradle/wrapper	new android port	2021-02-24 09:28:47 +01:00
src	new android port	2021-02-24 09:28:47 +01:00
.appveyor.yml	do not cache .rustup	2021-02-10 15:27:02 +01:00
.gitignore	ignore Profile.dat files	2020-09-22 21:09:51 +02:00
build.rs	new android port	2021-02-24 09:28:47 +01:00
Cargo.toml	new android port	2021-02-24 09:28:47 +01:00
gradlew	new android port	2021-02-24 09:28:47 +01:00
gradlew.bat	new android port	2021-02-24 09:28:47 +01:00
LICENSE	initial commit	2020-08-18 18:46:07 +02:00
README.md	move roadmap to a GH issue	2021-02-10 14:01:32 +01:00
rustfmt.toml	ogg playback and persistent settings	2021-02-12 11:05:28 +01:00

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+

PC release (Steam) - (Tested only with Steam version, both Windows and Linux builds) Copy data folder from installation directory (guide for Steam) to the runtime directory.
PC release (EGS) - (Untested, but the game is essentially the same as Steam release) Same thing as with Steam version.
Switch release - (Tested once, no guarantee to work) You need a hacked Switch and physical release. Google should help you.

Mandatory screenshots

Freeware data files:

Cave Story+ data files:

Credits

Studio Pixel/Nicalis for Cave Story
Cave Story Tribute Site - has lots of useful resources related to the game.
CSE2 - widescreen fixes, more readable reference for game logic, mutual help in various things.
LunarLambda for organism - which is being used by us as .org playback engine.