Movatterモバイル変換

doukutsu-rs/doukutsu-rsPublic

NotificationsYou must be signed in to change notification settings
Fork64
Star1.1k

A faithful and open-source remake of Cave Story's engine written in Rust

doukutsu.rs

License

View license

1.1k stars 64 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 1,076 Commits
.cargo		.cargo
.github		.github
app		app
drsandroid		drsandroid
drshorizon		drshorizon
misc		misc
res		res
src		src
.gitignore		.gitignore
Cargo.lock		Cargo.lock
Cargo.toml		Cargo.toml
LICENSE		LICENSE
README.md		README.md
build.rs		build.rs
rustfmt.toml		rustfmt.toml

Repository files navigation

A fully playable re-implementation of the Cave Story (Doukutsu Monogatari) engine writteninRust.

Join the Discord server

Get stable/beta builds from
- get.doukutsu.rs
- GitHub Releases
- Flatpak (Linux only)
Get nightly builds (recommended for now, has latest fixes and improvements)
Permalinks to latest builds frommaster branch:

Note

macOS note: If you get a"doukutsu-rs" can't be opened message, right-click doukutsu-rs.app and click open.

Note

If you get issues with Epic Games Store version, scroll down for instructions.

Data files

In order to work doukutsu-rs needs to be paired with supported data files. This repository does not contain any datafiles.

doukutsu-rs works fine with freeware data files orNXEngine(-evo) or from asupported copy ofCave Story+.

How to set up data files on Android

If your phone has an app called"Files":

Launch this app.
Press☰ on the top left corner.
Tap on"doukutsu-rs game data".
Copy your game data files to the opened folder.

If your phone does not have this app:

Install the"Material Files" app fromHai Zhang and launch it(Google Play |F-Droid |Github Releases).
Press☰ on the top left corner.
Press"+ Add storage".
In the window that pops up, press"External storage".
Press☰ on the top left corner.
Tap on"doukutsu-rs game data".
Press the large blue button at the bottom labelled"USE THIS FOLDER".
Then click on☰ in the top left corner again and open.
Tap on"files" above"+ Add storage".
Copy your game data files to the opened folder.

Supported game editions and data file acquisition guides

Freeware

doukutsu-rs works out of the box when it's placed in the same directory as the original Doukutsu.exe executable. On the initialstartup, doukutsu-rs will automatically extract the additional resources that are embedded in the vanilla game into thedatadirectory. Until that is done, both doukutsu-rs and the vanilla executable have to exist in the directory.

Example root directory

Cave Story+

doukutsu-rs can be used as drop-in replacement forCaveStory+.exe. No modifications to game files are needed.

Original version (first released in 2011 on Steam) - expand for instructions

Steam release (Win/Mac/Linux)

Thedata folder is in the same place across all platforms.

If you want to use doukutsu-rs as a substitute for Mac version of Cave Story+ (which at moment of writing doesn't workon 10.15+ anymore), do the following:

Find the doukutsu-rs executable:
- In AppVeyor builds, it's indoukutsu-rs.app/Contents/MacOS/doukutsu-rs
- In your own builds, it's intarget/(release|debug)/doukutsu-rs
Open Steam Library, selectCave Story+, press theManage button (gear icon) and selectProperties...
SelectLocal Files and pressBrowse....
Open theCave Story+.app bundle and navigate toContents/MacOS directory.
Rename theCave Story+ executable to something else or delete it.
Copy the doukutsu-rs executable and rename it toCave Story+.
Launch the game from Steam and enjoy!

Warning

EPIC GAMES STORE VERSION WARNING

Nicalis for some reason ships a strayopengl32.dll DLL from Windows 7 with the Epic Games Store copies of Cave Story+.

However as the game is 32-bit and the dll is 64-bit it has no effect on the original version, but as it's a core Windows DLL and doukutsu-rs ships 64-bit builds and uses OpenGL, it's makes the game crash on startup.

The fix is to simply deleteopengl32.dll, as it's not used anyway.

Epic Games Store

Check your default installation directory.

GOG

Check your default installation directory.

Humble Bundle

The archive from Humble Bundle contains the necessarydata folder, in the same folder asCaveStory+.exe.

WiiWare

Remastered version (first released in 2017 on Switch)

Note

This version isincompatible with saves from the original version.

Interchanging the save files may result in spawning in wrong locations, softlocks, graphical glitches, or other issues.

Nintendo Switch

Extract thedata folder (contained inromfs) from your console using tool such asnxdumptool.

Important notes:

doukutsu-rs doesn't rely on the original ROM or executable, you just need the data files, go toRomFS options menu to just extract the files to SD card so you don't need to do any extra steps.
Ensure you're dumping the fileswith update included (Use update/DLC option), as 1.0 isn't supported.

Nintendo Switch homebrew port specific info

If you're running the homebrew port (drshorizon.nro) on your Switch, you can avoid the dumping step, doukutsu-rs willautomatically detect and mount the data files if you run it over Cave Story+ in Title Override mode (holdR while starting CS+ and launch d-rs from hbmenu).

You can put your own data files in/switch/doukutsu-rs/data directory on SD Card, which will be overlayed over RomFS ifyou run it in setup described above.