4fun open-source Cave Story reimplementation written in Rust

Last update: Jan 1, 2023

Overview

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, mutual help in various things.
LunarLambda for organism - which is being used by us as .org playback engine.
@uselesscalcium - Android port icon artwork

Comments

Project relicensing proposal

I've been considering relicensing the project under modified MIT license with one additional clause that explicitly prevents it from being used... in one specific way that could bring Nicalis' attention in a bad way.

MIT/doukutsu-rs License

Copyright 2020-2022 doukutsu-rs contributors.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
The Software cannot be redistributed bundled with data files taken from any commercial port released by Nicalis Inc. without their explicit permission.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Since this requires approval of every past contributor, please let me know what you think and whether you approve this proposal.

[x] @dawndus
[x] @khang06
[x] @JakeVanV
[x] @Daedliy
[x] @yoroshikun
[x] @jozsefsallai
[x] @vrmiguel
[x] @tranzystorek-io

opened by alula 10

Incorrect DualShock 4 D-pad icons

When I used a DualShock 4 controller (I was using a V1 variant in this case), in the Options menu the D-pad icons seems to be reversed for Up, Down, Left, and Right which does not match with the design of the D-pad on the controller itself.

bug wontfix rendering

opened by ViperAcidZX 8
Problems with controller remapping settings and some suggestions
I was trying to remap my controls but when I tried to changing Shoot from B button to X on my Xbox controller, it screws up Jump on A button and it suddenly changes to X when I didn't want it to, and when I tried to change it back, it doesn't want to change unless I go back to the default controls. I was running into these problems with the latest AppVeyor build that just came out.

[x] fix jump/shoot swap bug

Could it be possible to make the default face button configuration to this?

Xbox, PlayStation, Nintendo A / ✕ / B - Jump/Confirm B / 〇 / A - Cancel X / □ / Y - Shoot Y / △ / X - Inventory/Skip

[x] update default gamepad controls

Also could it be possible to add the ability to rebind the menu controls? For example, if one is playing the with a Switch Pro Controller, they could change the Confirm button to A (East) or someone prefers to change it to B (South) on the same controller.

[x] add menu ok/back as remappable controls

bug
opened by ViperAcidZX 7
some bugs in windows d-rs
doukutsu-rs.x86_64 with gog data folder challenges are missed up #they are named easyMod/mod/...etc #curly story but qoute is showed insted #time trial some aria art is missing in the first map only #boss mod same map issue and qoute start near monster x #kaze/mod also map art missing

Nemesis here when qoute take booster 2.0 it works along side with 0.8 the tow work at same time (must open menu and acuire it manly to fix it) here is the link https://youtu.be/hktqHKEJcOM

-fazz core doent wait for qoute invencebilty (it hit him towice in row)

nemesis doesnt directly levelup when taking one xp

the second ghost cat is insaid the top up blocks

and with switch data qoute start challenges a little bit to the left
invalid
opened by dancrime 7
Add Extras menu

Includes the fix from https://github.com/doukutsu-rs/doukutsu-rs/pull/161 The ??? option changes the more_rust setting but ~~I can't find out why~~ it dosen't actually effect anything since it's linked to the debug menu. Also, turning debug mode off won't remove the debug menu if it's still open.

opened by Awesomegamer6566 6
issues in muiltyplayer mode

first of all I'd like to thank you guys for the update i always wanted to TAS cs muiltyplayer i am using this version the red water (water with mimga blood) in final cave still cause blue drops the current here should be where quote is standing the last issue is when playing muiltyplayer after given the booster to sue mother it will only take the first player's booster but it's fixed when restarting from a save
invalid

opened by dananothername 5
On screen Controller Mapping

It's more a request, in my phone the controls are at the middle of the screen, it's not bad but it makes difficult on boss battles since they are in a strange position. It would be great if I could change the positions and stuff. Thanks
enhancement android

opened by Caco-o-sapo 4
Can't continue the game in the last scene after defeating the doctor and mad-core

Please give the continue button or whatever so that the game can continue, so that we can get the v.2.0 booster, new polar star, and can beat the new cave story boss

opened by HaidarAhmad23 3
issues in android beta 4
npc does effects to water but should not make splash sound

buttons should be like this -dobble puppy https://user-images.githubusercontent.com/101902085/167345891-eb15f991-fdda-4e0f-9e36-c9ac6a9174ab.mp4 -criture jump the open thier fan istead of only jumping

https://user-images.githubusercontent.com/101902085/167345986-c57760f2-a730-4f2d-971a-801a566468af.mp4 -jake box is not responding also esc button not working while replay challenge
invalid
opened by dananothername 3
Alt menus appearing based on challenge time

Using Epic Games data files, after completing Machine Gun Challenge with a time of 2'00'07, the menu player sprite changed to Sue (and with Safety as it would if Hell was beaten under 3 minutes. I don't have a save file with Hell beaten in d-rs.
bug question Cave Story+

opened by abzium 3
This hazard in Egg Corridor don't work as intended

For some reason this hazard does not hurt the player at all when normally it's supposed to do enough damage to install kill the player but it just phases through the player like nothing in this build of doukutsu-rs.

opened by ViperAcidZX 3
Incorrect Looping Flags For Famitrack, New, & Ridiculon OSTs

The jingles/music that are set to not loop after playing (Like the victory, item, and health jingles) don't function correctly in 3 of the soundtracks.

This happens on every data source.

Example: https://user-images.githubusercontent.com/107987492/209277692-fcd20839-1063-4419-ba74-019d213566f8.mp4

opened by Clock-Dial-Project 0
Implementing Song Override Rules Script for Soundtracks
Self explanatory; add a script that's replace current song with other song in the Soundtrack folder its currently using.

For example, added a flags of certain stage to play different music entirely:

{ "curly": [{"use": "plantation", "if": "stageId == 56"}], "lastcave": [{"use": "lastcave2", "if": "stageId == 67"}], "lastbt3": [{"use": "lastbt3ballos", "if": "stageId == 87"}] }

Not only that; you could also put a complete expression evaluator there, that way you could let people make quite advanced matching rules. like flags[491] && flags[stageId + 100] || skipFlags[0]

For something extra, maybe also add ability to add credits to the author of the Soundtrack as well, example:

{ "name": "Famitracks", "author": "RushJet1" }
opened by Trimint123 0
Randomizer Inventory Limit/Only hold limited ites

I was doing a randomizer on this and after like 10 items item icons were blank while having names and descriptions and after i reloaded a save after dying those blank items were gone from my inventory

opened by Retroboiiii 0
Title logo bug

When the setting for the original graphics has been set to on, the Title logo will change to the Original but is glitched.

2x graphics:

Original graphics:

Build: 0.99.0518 master Native M1 branch Specs: M1 ARM APU, 8 GB Ram
bug rendering CS+Switch

opened by KaitheFoox 0

Releases(0.99.0-horizon-prev1)

0.99.0-horizon-prev1(Dec 20, 2022)

Refer to README for setup.
Source code(tar.gz)
Source code(zip)
drshorizon.nro(6.19 MB)
0.99.0-beta4(May 3, 2022)
Android Note: If coming from beta2 or earlier you must install beta3 first in order to retain data.

Re-allow CS+ data on Android

Add cutscene skip to Android

Full Changelog: https://github.com/doukutsu-rs/doukutsu-rs/compare/0.99.0-beta3...0.99.0-beta4
Source code(tar.gz)
Source code(zip)
doukutsu-rs_0.99.0_beta4_android.apk(9.31 MB)
doukutsu-rs_0.99.0_beta4_linux.zip(2.90 MB)
doukutsu-rs_0.99.0_beta4_mac-intel.zip(3.22 MB)
doukutsu-rs_0.99.0_beta4_mac-m1.zip(3.00 MB)
doukutsu-rs_0.99.0_beta4_win64.zip(2.69 MB)
0.99.0-beta3(Apr 24, 2022)
Android Note: Since the signing key has changed in this version you must install it before installing any future update as they may not include key migration information.

Improved water rendering

Added CS+ difficulties

Added save slots for challenges

Added Jukebox for Switch CS+

Added a CI build for Linux

Wind Fortress NPCs (NPC 361-369)

Cutscene P2 Quote (NPC 370)

Challenge replay + unlock criteria

Improved soundtrack handling

Dog stacking effect

Game and menu localization support

Apple M1 builds

Windows icon

Fullscreen (toggle with Alt+Enter)

V-Sync options

RNG Changes

Too many accuracy and bug fixes to list

Full Changelog: https://github.com/doukutsu-rs/doukutsu-rs/compare/0.99.0-beta2...0.99.0-beta3
Source code(tar.gz)
Source code(zip)
doukutsu-rs_0.99.0_beta3_android.apk(9.18 MB)
doukutsu-rs_0.99.0_beta3_linux.zip(2.90 MB)
doukutsu-rs_0.99.0_beta3_mac-intel.zip(3.22 MB)
doukutsu-rs_0.99.0_beta3_mac-m1.zip(3.00 MB)
doukutsu-rs_0.99.0_beta3_win64.zip(2.69 MB)
0.99.0-beta2(Feb 11, 2022)
Added pause menu

Fixed waterway noise

Fixed our BMFont renderer

Added map system

Adjusted menu spacing to make it look better with default textbox decorations

Added support for GOG version

Fixed minor bugs in Core boss fight

Fixed hissing in case when system sample rate doesn't match the sample rate of .ogg file

Persistent damage numbers

Waterway push tiles animated

Pause menu confirm dialog

Switch boss fixes

All remaining carets (Empty!/bubbler/droplet)

Main menu music+cursor

FPS counter

Tons of bugfixes

Added support for Switch version animated facepics

Added support for CS+ Challenges

Added multiple saves

Fixed CS+ Switch original graphics preset

Full Changelog: https://github.com/doukutsu-rs/doukutsu-rs/compare/0.99.0-beta1...0.99.0-beta2
Source code(tar.gz)
Source code(zip)
app-release.apk(10.69 MB)
doukutsu-rs.x86_64(5.63 MB)
doukutsu-rs.x86_64.exe(4.94 MB)
0.99.0-beta1(Jan 16, 2022)

First fully playable beta.

The only missing gameplay feature right now is Map System.

Requires pairing with game data files, Android version is the only one with auto-downloader for freeware version.
Source code(tar.gz)
Source code(zip)
app-release.apk(10.40 MB)
doukutsu-rs.x86_64(5.41 MB)
doukutsu-rs.x86_64.exe(4.79 MB)
0.1.0-android9(Dec 2, 2021)
The game is done up to normal ending

Added an Android-specific downloader that fetches game files from game-data repo. No need to mess with SAF anymore.

Source code(tar.gz)
Source code(zip)
app-release.apk(8.45 MB)
0.1.0-android8(Oct 14, 2021)
Fixes:

The APK is now compiled in release mode and the key has changed!!! You might have to uninstall first if installation fails!

Improved touch controls for weapon switching (pressing on weapon on inventory screen closes it).

50/60tps timing setting is now persistent.

Fixed startup crashes.

Fixed some Android-specific graphical glitches.

Improved viewport scaling, it uses multiples of 480 in height now, so the game should look a bit better on most devices.

Installation:

Download the .apk and grab data files. Freeware builds that are known to work well:

https://github.com/doukutsu-rs/game-data/archive/r1.zip (bundled with desktop CI builds)

https://github.com/nxengine/nxengine-evo/releases/download/v2.6.5-rc2/NXEngine-Evo-v2.6.5-rc2-Win64.zip Cave Story+ should work nicely as well

Install and run the .apk

If you haven't copied the data files yet, close the game, go to file manager and copy game files to data directory of doukutsu-rs game data scope:

If your device's default file manager does not support SAF (you can't see the doukutsu-rs game data scope anywhere) try one of those instead:

https://play.google.com/store/apps/details?id=nextapp.fx

https://play.google.com/store/apps/details?id=me.zhanghai.android.files

Source code(tar.gz)
Source code(zip)
app-release.apk(6.29 MB)
0.1.0-android7(Oct 14, 2021)
Fixes:

The APK is now compiled in release mode and the key has changed!!! You might have to uninstall first if installation fails!

Too many to list actually

Technically playable up to Last Cave, but you would get stuck on Ironhead boss.

Installation:

Download the .apk and grab data files. Freeware builds that are known to work well:

https://github.com/doukutsu-rs/game-data/archive/r1.zip (bundled with desktop CI builds)

https://github.com/nxengine/nxengine-evo/releases/download/v2.6.5-rc2/NXEngine-Evo-v2.6.5-rc2-Win64.zip Cave Story+ should work nicely as well

Install and run the .apk

If you haven't copied the data files yet, close the game, go to file manager and copy game files to data directory of doukutsu-rs game data scope:

If your device's default file manager does not support SAF (you can't see the doukutsu-rs game data scope anywhere) try one of those instead:

https://play.google.com/store/apps/details?id=nextapp.fx

https://play.google.com/store/apps/details?id=me.zhanghai.android.files

Source code(tar.gz)
Source code(zip)
app-release.apk(5.45 MB)
0.1.0-android6(May 2, 2021)
Fixes:

Finished Sand Zone

Game is now completable up to Labirynth B (although you can go as far as to core room if you wouldn't get killed by invisible NPCs)

Installation:

Download the .apk and grab data files. Freeware builds that are known to work well:

https://github.com/doukutsu-rs/game-data/archive/r1.zip (bundled with desktop CI builds)

https://github.com/nxengine/nxengine-evo/releases/download/v2.6.5-rc2/NXEngine-Evo-v2.6.5-rc2-Win64.zip Cave Story+ should work nicely as well

Install and run the .apk

If you haven't copied the data files yet, close the game, go to file manager and copy game files to data directory of doukutsu-rs game data scope:

If your device's default file manager does not support SAF (you can't see the doukutsu-rs game data scope anywhere) try one of those instead:

https://play.google.com/store/apps/details?id=nextapp.fx

https://play.google.com/store/apps/details?id=me.zhanghai.android.files

Source code(tar.gz)
Source code(zip)
app-debug.apk(7.93 MB)
doukutsu-rs.exe(5.59 MB)
doukutsu-rs.x86_64(6.18 MB)
0.1.0-android5(Apr 29, 2021)
Fixes:

Fixed crashes that happened on certain devices running old versions of Android.

Fixed inability to skip intro scene.

Volume buttons are now working properly.

Added NPC layering support and made some visual fixes.

Fixed textbox rendering bugs.

Fixed Balfrog glitches.

Made various improvements to touch controls.

Installation:

Download the .apk and grab data files. Freeware builds that are known to work well:

https://github.com/doukutsu-rs/game-data/archive/r1.zip (bundled with desktop CI builds)

https://github.com/nxengine/nxengine-evo/releases/download/v2.6.5-rc2/NXEngine-Evo-v2.6.5-rc2-Win64.zip Cave Story+ should work nicely as well

Install and run the .apk

If you haven't copied the data files yet, close the game, go to file manager and copy game files to data directory of doukutsu-rs game data scope:

If your device's default file manager does not support SAF (you can't see the doukutsu-rs game data scope anywhere) try one of those instead:

https://play.google.com/store/apps/details?id=nextapp.fx

https://play.google.com/store/apps/details?id=me.zhanghai.android.files

Source code(tar.gz)
Source code(zip)
app-debug.apk(7.87 MB)
doukutsu-rs.exe(5.51 MB)
doukutsu-rs.x86_64(6.13 MB)
0.1.0-android4(Apr 23, 2021)
Fixes:

Added armv7 support for people who have ancient phones.

Many improvements to touch controls.

Screen insets are respected properly now.

All weapons are implemented, however missile launcher is still somewhat buggy.

Bunch of new NPCs.

Fixed some hitbox calculation inaccuracies on NPCs (which was noticeable eg. in cemetery map when big pignon was unable to fall through gap between islands).

Added support for loading custom soundtracks from <data>/Soundtracks/<name> directory.

Puppy carrying and CS+ Switch puppy stacking support (although I'm unsure if this one was done correctly but it somewhat works)

Added <FLA/boss defeat flash effect.

Fixed some TSC bugs and inaccuracies.

Fixed some NPC inaccuracies,

Fixed various safety issues such as out-of-bound accesses and rewritten some code that broke pointer aliasing rules in safe way.

Added nice looking ray casted lighting for player.

Added an inventory screen

Installation:

Download the .apk and grab data files. Freeware builds that are known to work well:

https://github.com/doukutsu-rs/game-data/archive/r1.zip (bundled with desktop CI builds)

https://github.com/nxengine/nxengine-evo/releases/download/v2.6.5-rc2/NXEngine-Evo-v2.6.5-rc2-Win64.zip Cave Story+ should work nicely as well

Install and run the .apk

If you haven't copied the data files yet, close the game, go to file manager and copy game files to data directory of doukutsu-rs game data scope:

If your device's default file manager does not support SAF (you can't see the doukutsu-rs game data scope anywhere) try one of those instead:

https://play.google.com/store/apps/details?id=nextapp.fx

https://play.google.com/store/apps/details?id=me.zhanghai.android.files

Source code(tar.gz)
Source code(zip)
app-debug.apk(7.85 MB)
doukutsu-rs.exe(5.51 MB)
doukutsu-rs.x86_64(6.13 MB)
0.1.0-android3(Feb 26, 2021)
Known issues:

Only arm64 and x86 devices are supported

Screen cutout insets are respected, but SystemUI (navbar, statusbar, etc.) insets aren't

Fixes:

The natives are now compiled in release mode so d-rs should run much faster on crap devices.

Rendering fixes - lighting is working again

Installation:

Download the .apk and grab data files. Freeware builds that are known to work well:

https://github.com/doukutsu-rs/game-data/archive/r1.zip (bundled with desktop CI builds)

https://github.com/nxengine/nxengine-evo/releases/download/v2.6.5-rc2/NXEngine-Evo-v2.6.5-rc2-Win64.zip Cave Story+ should work nicely as well

Install and run the .apk

If you haven't copied the data files yet, close the game, go to file manager and copy game files to data directory of doukutsu-rs game data scope:

If your device's default file manager does not support SAF (you can't see the doukutsu-rs game data scope anywhere) try one of those instead:

https://play.google.com/store/apps/details?id=nextapp.fx

https://play.google.com/store/apps/details?id=me.zhanghai.android.files

Source code(tar.gz)
Source code(zip)
app-debug.apk(17.62 MB)
doukutsu-rs.x86_64(6.30 MB)
0.1.0-android2(Feb 24, 2021)
Known issues:

Only arm64 and x86 devices are supported

Screen cutout insets are respected, but SystemUI (navbar, statusbar, etc.) insets aren't

Lighting effects are broken atm (disable them in settings)

Fixes:

Face pics are now visible

Fix SAF access issues on non-system file managers

Installation:

Download the .apk and grab data files. Freeware builds that are known to work well:

https://github.com/doukutsu-rs/game-data/archive/r1.zip (bundled with desktop CI builds)

https://github.com/nxengine/nxengine-evo/releases/download/v2.6.5-rc2/NXEngine-Evo-v2.6.5-rc2-Win64.zip Cave Story+ should work nicely as well

Install and run the .apk

If you haven't copied the data files yet, close the game, go to file manager and copy game files to data directory of doukutsu-rs game data scope:

If your device's default file manager does not support SAF (you can't see the doukutsu-rs game data scope anywhere) try one of those instead:

https://play.google.com/store/apps/details?id=nextapp.fx

https://play.google.com/store/apps/details?id=me.zhanghai.android.files

Source code(tar.gz)
Source code(zip)
app-debug.apk(25.25 MB)
0.1.0-android1(Feb 20, 2021)
Known issues:

Only arm64 and x86 devices are supported

Screen cutout insets are respected, but SystemUI (navbar, statusbar, etc.) insets aren't

Lighting effects are broken atm (disable them in settings)

Face pics are invisible

Installation:

Download the .apk and grab data files. Freeware builds that are known to work well:

https://github.com/doukutsu-rs/game-data/archive/r1.zip (bundled with desktop CI builds)

https://github.com/nxengine/nxengine-evo/releases/download/v2.6.5-rc2/NXEngine-Evo-v2.6.5-rc2-Win64.zip Cave Story+ should work nicely as well

Install and run the .apk

If you haven't copied the data files yet, close the game, go to file manager and copy game files to data directory of doukutsu-rs game data scope:

Source code(tar.gz)
Source code(zip)
app-debug.apk(25.25 MB)