2020-08-18 16:46:07 +00:00
# doukutsu-rs
2020-09-23 19:44:10 +00:00
[Download latest Nightly builds ](https://github.com/doukutsu-rs/doukutsu-rs/actions ) (Requires being logged in to GitHub)
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/ ).
2020-09-25 22:28:37 +00:00
2020-11-14 01:24:32 +00:00
**The project is still incomplete and not fully playable yet.**
2020-08-18 16:46:07 +00:00
2020-08-19 00:55:21 +00:00
[Join the Discord server ](https://discord.gg/fbRsNNB )
2020-08-18 16:52:28 +00:00
2020-08-18 16:46:07 +00:00
#### Data files
2020-10-30 02:03:41 +00:00
This repository does not contain any copyrighted files.
2021-01-01 01:46:01 +00:00
For better user experience, pre-built binaries are distributed with slightly modified freeware game files.
2020-08-18 16:46:07 +00:00
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.
2020-08-18 16:46:07 +00:00
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.
2020-08-28 20:16:27 +00:00
##### Where to get them?
**Freeware**
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.
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)~~
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+**
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.
2020-08-28 20:16:27 +00:00
2020-11-14 01:24:32 +00:00
#### Gameplay support roadmap
2020-08-18 16:46:07 +00:00
2020-10-27 01:05:49 +00:00
- [x] Checkmarked things = fully implemented
- [ ] Unmarked things = partially or not implemented yet.
2020-08-18 16:46:07 +00:00
- [ ] Text scripts (TSC)
2020-08-27 05:10:54 +00:00
- [x] Initial implementation
2020-11-14 01:24:32 +00:00
- [x] Full implementation of gameplay opcodes
2020-09-18 09:22:51 +00:00
- [x] Shift-JIS encoding support
2020-11-14 01:24:32 +00:00
- [ ] Credits opcodes
2020-09-03 12:28:34 +00:00
- [ ] Audio
- [x] Organya BGM playback
- [x] Text script bindings
- [ ] CS+ style .ogg BGM playback
2020-09-18 09:22:51 +00:00
- [x] PixTone SFX
2020-08-27 05:10:54 +00:00
- [ ] NPCs/entities
2020-09-04 23:47:17 +00:00
- [x] Initial implementation
2020-12-15 22:09:14 +00:00
- [ ] Miscellaneous entities (~40% done)
- [ ] Bosses (~30% done)
- [x] Omega
- [x] Balfrog
- [x] Monster X
2020-09-10 11:38:17 +00:00
- [x] First Cave
2020-10-27 01:05:49 +00:00
- [x] Mimiga Village
2020-11-01 19:58:33 +00:00
- [x] Egg Corridor
2020-12-02 14:43:18 +00:00
- [x] Grasstown
2020-12-15 22:09:14 +00:00
- [ ] Sand Zone (~50% done)
2020-10-27 01:05:49 +00:00
- [ ] Labirynth (~10% done)
2020-12-15 22:09:14 +00:00
- [x] Waterway
- [ ] Egg Corridor? (~20% done)
2020-10-04 18:37:12 +00:00
- [ ] Outer Wall
- [ ] Plantation
- [ ] Last Cave
- [ ] Balcony
- [ ] Hell
2020-08-27 05:10:54 +00:00
- [ ] Weapons
2020-10-27 01:20:10 +00:00
- [x] Leveling / XP system
2020-09-12 00:46:13 +00:00
- [x] Initial implementation
2020-10-04 18:37:12 +00:00
- [x] Snake
2020-09-12 00:46:13 +00:00
- [x] Polar Star
2020-10-04 18:37:12 +00:00
- [x] Fireball
2020-09-12 00:46:13 +00:00
- [ ] Machine Gun
- [ ] Missile Launcher
- [ ] Bubbler
2021-02-05 22:47:13 +00:00
- [x] Blade
2020-09-12 00:46:13 +00:00
- [ ] Super Missile Launcher
2021-02-05 22:47:13 +00:00
- [x] Nemesis
- [x] Spur
2020-10-30 02:03:41 +00:00
- [x] Saving and loading game state
2020-11-01 19:58:33 +00:00
- [ ] Support for different game editions
2020-10-30 02:03:41 +00:00
- [ ] Vanilla
- [x] Modified vanilla
2021-01-01 01:46:01 +00:00
- [ ] Cave Story+ (PC/Switch)
2020-10-30 02:03:41 +00:00
- [x] Base mod
- [ ] Mod loading
2020-12-06 23:51:16 +00:00
- [x] Curly Story
2021-01-01 01:46:01 +00:00
- [ ] Wind Fortress
2020-10-30 02:03:41 +00:00
- [ ] Boss Run
2020-11-14 01:24:32 +00:00
- [x] Seasonal graphics
2020-12-06 23:51:16 +00:00
- [x] Co-op gameplay
2020-08-27 05:10:54 +00:00
*(tbd)*
2020-08-18 16:46:07 +00:00
2020-08-26 01:25:52 +00:00
#### Mandatory screenshots
2020-08-26 01:21:46 +00:00
2020-08-26 01:25:52 +00:00
**Freeware data files:**
2020-10-30 02:03:41 +00:00
2020-08-26 01:25:52 +00:00
**Cave Story+ data files:**
2020-10-30 02:03:41 +00:00
2020-08-26 01:21:46 +00:00
2020-08-18 16:46:07 +00:00
#### Credits
2020-11-14 01:24:32 +00:00
- Studio Pixel/Nicalis for Cave Story
- [Cave Story Tribute Site ](https://cavestory.org ) - has lots of useful resources related to the game.
- [CSE2 ](https://github.com/Clownacy/CSE2 ) - widescreen fixes, more readable reference for game logic, mutual help in various things.
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.
