doukutsu-rs/README.md

# doukutsu-rs

![Release](https://github.com/doukutsu-rs/doukutsu-rs/workflows/Release/badge.svg)

[Download latest Nightly builds](https://github.com/doukutsu-rs/doukutsu-rs/actions) (Requires being logged in to GitHub)

A re-implementation of Cave Story (Doukutsu Monogatari) engine written in [Rust](https://www.rust-lang.org/).

**The project is still incomplete and not fully playable yet.** [Click here to see the current status of the project](https://github.com/doukutsu-rs/doukutsu-rs/issues/10).

[Join the Discord server](https://discord.gg/fbRsNNB)

#### 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](https://github.com/doukutsu-rs/game-data), [NXEngine(-evo)](https://github.com/nxengine/nxengine-evo) extracted freeware data files and [Cave Story+](https://www.nicalis.com/games/cavestory+) 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](https://steamcommunity.com/sharedfiles/filedetails/?id=760447682)) 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:**

![Japanese Freeware](https://i.imgur.com/eZ0V5rK.png)

**Cave Story+ data files:**

![CS+ with enhanced graphics](https://i.imgur.com/YaPAs70.png)

#### Credits

- Studio Pixel/Nicalis for Cave Story 
- [ggez](https://github.com/ggez/ggez) - we took few bits from it while moving away to SDL2.
- [@ClayHanson_](https://twitter.com/ClayHanson_) - for letting us use his .pxchar skin format from Cave Story Multiplayer mod. 
- [Cave Story Tribute Site](https://cavestory.org) - has lots of useful resources related to the game. 
- [CSE2](https://github.com/Clownacy/CSE2) - widescreen fixes, mutual help in various things.
- [LunarLambda for organism](https://gitdab.com/LunarLambda/organism) - which is being used by us as `.org` playback engine.
- [@uselesscalcium](https://twitter.com/uselesscalcium) - Android port icon artwork
initial commit 2020-08-18 16:46:07 +00:00			`# doukutsu-rs`

add links 2020-09-23 19:44:10 +00:00			`![Release](https://github.com/doukutsu-rs/doukutsu-rs/workflows/Release/badge.svg)`

			`[Download latest Nightly builds](https://github.com/doukutsu-rs/doukutsu-rs/actions) (Requires being logged in to GitHub)`

update the readme a bit 2020-10-30 02:03:41 +00:00			`A re-implementation of Cave Story (Doukutsu Monogatari) engine written in [Rust](https://www.rust-lang.org/).`
document/implement cs+ switch opcodes 2020-09-25 22:28:37 +00:00
move roadmap to a GH issue 2021-02-10 13:01:32 +00:00			`The project is still incomplete and not fully playable yet. [Click here to see the current status of the project](https://github.com/doukutsu-rs/doukutsu-rs/issues/10).`
initial commit 2020-08-18 16:46:07 +00:00
CaveStory+ data files fixes 2020-08-19 00:55:21 +00:00			`[Join the Discord server](https://discord.gg/fbRsNNB)`
Discord link 2020-08-18 16:52:28 +00:00
initial commit 2020-08-18 16:46:07 +00:00			`#### Data files`

update the readme a bit 2020-10-30 02:03:41 +00:00			`This repository does not contain any copyrighted files.`

Lua time 2021-01-01 01:46:01 +00:00			`For better user experience, pre-built binaries are distributed with slightly modified freeware game files.`
initial commit 2020-08-18 16:46:07 +00:00
Lua time 2021-01-01 01:46:01 +00:00			`doukutsu-rs should work fine with pre-extracted and tweaked data files from [this repository](https://github.com/doukutsu-rs/game-data), [NXEngine(-evo)](https://github.com/nxengine/nxengine-evo) extracted freeware data files and [Cave Story+](https://www.nicalis.com/games/cavestory+) data files.`
initial commit 2020-08-18 16:46:07 +00:00
update the readme a bit 2020-10-30 02:03:41 +00:00			`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.`
add data files guide to readme 2020-08-28 20:16:27 +00:00
			`##### Where to get them?`

			`Freeware`

releases setup attempt 2020-09-22 20:21:04 +00:00			`- https://github.com/doukutsu-rs/game-data - Freeware game data distributed with CI builds, based on those two below.`
Lua time 2021-01-01 01:46:01 +00:00			- ~~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)~~
add data files guide to readme 2020-08-28 20:16:27 +00:00			- 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+`

Lua time 2021-01-01 01:46:01 +00:00			- PC release (Steam) - (Tested only with Steam version, both Windows and Linux builds) Copy `data` folder from installation directory ([guide for Steam](https://steamcommunity.com/sharedfiles/filedetails/?id=760447682)) 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.`
add data files guide to readme 2020-08-28 20:16:27 +00:00
add a cs+ screenshot, because why not 2020-08-26 01:25:52 +00:00			`#### Mandatory screenshots`
mandatory screenshot 2020-08-26 01:21:46 +00:00
add a cs+ screenshot, because why not 2020-08-26 01:25:52 +00:00			`Freeware data files:`

update the readme a bit 2020-10-30 02:03:41 +00:00			`![Japanese Freeware](https://i.imgur.com/eZ0V5rK.png)`
add a cs+ screenshot, because why not 2020-08-26 01:25:52 +00:00
			`Cave Story+ data files:`

update the readme a bit 2020-10-30 02:03:41 +00:00			`![CS+ with enhanced graphics](https://i.imgur.com/YaPAs70.png)`
mandatory screenshot 2020-08-26 01:21:46 +00:00
initial commit 2020-08-18 16:46:07 +00:00			`#### Credits`

death effect, minor tweaks 2020-11-14 01:24:32 +00:00			`- Studio Pixel/Nicalis for Cave Story`
credit more people 2021-03-23 14:25:40 +00:00			`- [ggez](https://github.com/ggez/ggez) - we took few bits from it while moving away to SDL2.`
			`- [@ClayHanson_](https://twitter.com/ClayHanson_) - for letting us use his .pxchar skin format from Cave Story Multiplayer mod.`
death effect, minor tweaks 2020-11-14 01:24:32 +00:00			`- [Cave Story Tribute Site](https://cavestory.org) - has lots of useful resources related to the game.`
credit eli 2021-02-24 08:31:21 +00:00			`- [CSE2](https://github.com/Clownacy/CSE2) - widescreen fixes, mutual help in various things.`
shrug 2020-09-10 11:44:46 +00:00			- [LunarLambda for organism](https://gitdab.com/LunarLambda/organism) - which is being used by us as `.org` playback engine.
credit eli 2021-02-24 08:31:21 +00:00			`- [@uselesscalcium](https://twitter.com/uselesscalcium) - Android port icon artwork`