1
0
Fork 0
mirror of https://github.com/doukutsu-rs/doukutsu-rs synced 2024-11-15 18:32:48 +00:00
doukutsu-rs/README.md
2020-08-19 02:58:15 +02:00

2.1 KiB

doukutsu-rs

A re-implementation of Cave Story (Doukutsu Monogatari) engine written in Rust, aiming for accuracy and cleaner code. Later plans might involve turning it into a fully-featured modding tool with live debugging and stuff.

The project is still in a very early state and nowhere near being playable. Expect lots of breaking changes and bugs

Join the Discord server

Data files

doukutsu-rs project does not re-distribute any copyrighted files.

The engine should work fine with CSE2-Enhanced or NXEngine(-evo) modified freeware data files and Cave Story+ (Nicalis commercial release, loading is supported but note we're not going to reverse engineer it or support it's features) data files.

Roadmap

  • Tilemap and player rendering
  • Weapons
  • Text scripts (TSC)
  • Making it actually playable
  • Modding enhancements and built-in tools
  • idk the list is TBD

why rust, it's a hipster language lol

The project is a result of me wanting to build something in a new programming language for memes.

I had an idea of writing my own CS engine long time before and I would've very likely picked C++17/20+SDL2, but after all I've picked Rust instead because it seemed quite interesting for me.

Would 90% of end-users running this thing care about the programming language software was written in? After all who tf cares if the performance is the same (and maybe a slightly better), but you also get a lot of various benefits?

Credits

  • Studio Pixel for Cave Story
  • Cave Story Tribute Site - for LOTS of useful resources related to the game.
  • Clownacy for CSE2 - a great and very accurate reference for game's logic used in this project
  • CSMC - a helpful Cave Story modding community
  • NXEngine - an another OSS rewrite of Cave Story engine.