mirror of https://github.com/doukutsu-rs/doukutsu-rs synced 2024-11-10 16:24:40 +00:00

Go to file

Alula 39171cc9a9 prevent zero division if 0 as wait is passed to <FON/<FOM		2022-02-25 06:06:30 +01:00
.cargo	Initial Android support and some ggez rewrite	2020-10-07 16:08:12 +02:00
.github/workflows	try to fix linux builds	2022-01-08 05:54:57 +01:00
app	New Android app icon by Daedliy	2022-02-15 17:22:07 -05:00
drsandroid	fix android build	2022-01-16 02:57:12 +01:00
misc/json-schemas	various tweaks, dskinmeta format	2021-06-21 13:12:58 +02:00
src	prevent zero division if 0 as wait is passed to <FON/<FOM	2022-02-25 06:06:30 +01:00
.appveyor.yml	change version to 0.99.0 in appveyor builds	2022-01-23 18:17:01 +01:00
.gitignore	macOS tweaks / CI builds	2021-08-13 03:46:41 +02:00
build.rs	macOS fixes	2022-02-25 06:03:05 +01:00
Cargo.toml	Parse mod names and string table	2022-02-13 14:39:28 -05:00
LICENSE	initial commit	2020-08-18 18:46:07 +02:00
README.md	remove clay hanson from credits and .pxchar support	2022-02-17 04:45:21 +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 fully playable re-implementation of Cave Story (Doukutsu Monogatari) engine written in Rust.

Join the Discord server

Data files

This repository does not contain any copyrighted files.

For better user experience, AppVeyor builds 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/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+ (not fully supported)

Original 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.
- PC release (GOG) - Essentially the same thing as with Steam version.
Remastered version (first released in 2017 on Switch)
- 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
@Daedily - brand artwork (Icon / Banner / Server)
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.