doukutsu-rs/README.md

# doukutsu-rs

A re-implementation of Cave Story (Doukutsu Monogatari) engine written in [Rust](https://www.rust-lang.org/), aiming for behavior 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](https://discord.gg/fbRsNNB)

#### Data files

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

The engine should work fine with [CSE2-Enhanced](https://github.com/Clownacy/CSE2) or [NXEngine(-evo)](https://github.com/nxengine/nxengine-evo) modified freeware data files and [Cave Story+](https://www.nicalis.com/games/cavestory+) (Nicalis commercial release, loading is supported but note we're not going to reverse engineer it or support it's features) data files.

#### Roadmap

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

#### Mandatory screenshots

**Freeware data files:**

![freeware](https://i.imgur.com/oCduSsy.png)

**Cave Story+ data files:**

![cs+](https://i.imgur.com/8qbfkeb.png)

#### 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 and 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](https://cavestory.org) - for LOTS of useful resources related to the game. 
- [Clownacy for CSE2](https://github.com/Clownacy/CSE2) - a great and very accurate reference for game's logic used in this project
- [CSMC](https://discord.gg/xRsWpz6) - a helpful Cave Story modding community
- [NXEngine](https://github.com/nxengine/nxengine-evo) - an another OSS rewrite of Cave Story engine I took some inspiration from.
initial commit 2020-08-18 16:46:07 +00:00			`# doukutsu-rs`

add carets and fix booster 2020-08-20 18:31:47 +00:00			`A re-implementation of Cave Story (Doukutsu Monogatari) engine written in [Rust](https://www.rust-lang.org/), aiming for behavior accuracy and cleaner code.`
initial commit 2020-08-18 16:46:07 +00:00			`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`

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`

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

update readme 2020-08-19 00:58:15 +00:00			`The engine should work fine with [CSE2-Enhanced](https://github.com/Clownacy/CSE2) or [NXEngine(-evo)](https://github.com/nxengine/nxengine-evo) modified freeware data files and [Cave Story+](https://www.nicalis.com/games/cavestory+) (Nicalis commercial release, loading is supported but note we're not going to reverse engineer it or support it's features) data files.`
initial commit 2020-08-18 16:46:07 +00:00
			`#### Roadmap`

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

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:`

			`![freeware](https://i.imgur.com/oCduSsy.png)`

			`Cave Story+ data files:`

			`![cs+](https://i.imgur.com/8qbfkeb.png)`
mandatory screenshot 2020-08-26 01:21:46 +00:00
initial commit 2020-08-18 16:46:07 +00:00			`#### 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.`

add carets and fix booster 2020-08-20 18:31:47 +00:00			`I had an idea of writing my own CS engine long time before and I would've very likely picked C++17/20 and SDL2, but after`
initial commit 2020-08-18 16:46:07 +00:00			`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](https://cavestory.org) - for LOTS of useful resources related to the game.`
			`- [Clownacy for CSE2](https://github.com/Clownacy/CSE2) - a great and very accurate reference for game's logic used in this project`
			`- [CSMC](https://discord.gg/xRsWpz6) - a helpful Cave Story modding community`
mandatory screenshot 2020-08-26 01:21:46 +00:00			`- [NXEngine](https://github.com/nxengine/nxengine-evo) - an another OSS rewrite of Cave Story engine I took some inspiration from.`