mirror of https://github.com/doukutsu-rs/doukutsu-rs synced 2024-11-15 18:32:48 +00:00

Go to file

dawnDus af1f9f5d89 Loading counter		2022-01-21 23:23:57 +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	reformat	2022-01-05 04:15:19 +01: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	Loading counter	2022-01-21 23:23:57 +01:00
.appveyor.yml	re-add windows build	2021-08-13 04:45:27 +02:00
.gitignore	macOS tweaks / CI builds	2021-08-13 03:46:41 +02:00
build.rs	Merge branch 'master' of github.com:alula/doukutsu-rs	2021-08-16 19:12:09 +02:00
Cargo.toml	bump version to 0.99.0, add dawn to authors	2022-01-16 02:52:42 +01:00
LICENSE	initial commit	2020-08-18 18:46:07 +02:00
README.md	Update credits	2022-01-16 03:18:07 +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+ (no full support)

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)
- 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
- @uselesscalcium - Android port icon artwork
Daedily - banner / server icon artwork
ggez - parts of it are used in crate::framework, notably the VFS code.
@ClayHanson_ - for letting us use his .pxchar skin format from Cave Story Multiplayer mod.
Clownacy - widescreen camera code.
LunarLambda for organism - used as basis for our Organya playback engine.