From 1df1248e2ed1da19d45c20b0d2f7c4a85bb44850 Mon Sep 17 00:00:00 2001 From: Clownacy Date: Fri, 5 Jun 2020 14:38:28 +0100 Subject: [PATCH 1/5] Clarify enhanced-lite's purpose a little I realised GZDoom is a pretty poor comparison, since that thing goes out of its way to add stuff like swimming, crouching, and jumping. Boom specifically prioritised preserving the 'feel' of Doom, which I think makes it much closer to CSE2E. --- PHILOSOPHY.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/PHILOSOPHY.md b/PHILOSOPHY.md index bb72792b..7f8c62e8 100644 --- a/PHILOSOPHY.md +++ b/PHILOSOPHY.md @@ -68,16 +68,21 @@ authenticity, and more on improving the base engine. ## Goal This branch is intended to benefit modders, by providing a feature-rich base for -mods (think 'GZDoom' rather than 'Chocolate Doom'). +mods, while still keeping the original game's 'feel' (think of the Boom project +rather than Chocolate Doom or GZDoom). That said, I want to avoid the codebase becoming an over-engineered mess of seldom-used and niche features - only features with a strong reason to be included should be added. -Current sources for features include... -* The "Cave Story Mod Loader" (widescreen, support for Ogg Vorbis music) +Priority features include ones that already exist in the modding community as +"EXE hacks", such as... * Common custom TSC commands (' Date: Fri, 5 Jun 2020 15:41:25 +0100 Subject: [PATCH 2/5] Fix a typo in PHILOSOPHY.md --- PHILOSOPHY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PHILOSOPHY.md b/PHILOSOPHY.md index 7f8c62e8..a38f09a9 100644 --- a/PHILOSOPHY.md +++ b/PHILOSOPHY.md @@ -1,5 +1,5 @@ # `accurate` branch -Being a pure, plain decompilation of the original `Doukusu.exe` file (v1.0.0.6), +Being a pure, plain decompilation of the original `Doukutsu.exe` file (v1.0.0.6), there should not be much to say about this branch's philosophies: ## Goal From 49b4ffb7223922a5a5247eb5799a265d0da51199 Mon Sep 17 00:00:00 2001 From: Clownacy Date: Mon, 15 Jun 2020 23:34:44 +0100 Subject: [PATCH 3/5] Clear-up some README wording --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 26ee1bcc..d8b838c6 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ Switch to the terminal (Visual Studio users should open the [Developer Command P cmake -B build -DCMAKE_BUILD_TYPE=Release ``` -MSYS2 users may want to append `-G"MSYS Makefiles"` to this command, also. +MSYS2 users should append `-G"MSYS Makefiles"` to this command, also. You can also add the following flags: From 93852242f4758aaf5ab1e093c6153668ff4febbe Mon Sep 17 00:00:00 2001 From: Clownacy Date: Mon, 22 Jun 2020 17:16:49 +0100 Subject: [PATCH 4/5] Just use 'CSE2' everywhere, instead of the full name Since Nicalis reobtained the 'Cave Story' trademark back in April, it looks like we're going to have to go the route of the Wine project and change what the abbreviation is short for... Can't Sue Everyone 2? Clownacy Saga, Episode 2? Code-Stealing Eyesore 2? --- README.md | 4 ++-- vs2003/CSE2.vcproj | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d8b838c6..345e261d 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ Branch | Description [emscripten](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/emscripten) | Modifies the engine to build with Emscripten, [allowing it to run in web browsers](http://sonicresearch.org/clownacy/cave.html) (no longer maintained). [wii](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/wii) | Ports the engine to the Nintendo Wii (no longer maintained). -# Cave Story Engine 2 +# CSE2 -Cave Story Engine 2 is a decompilation of Cave Story. +CSE2 is a decompilation of Cave Story. ![Screenshot](screenshot.png) diff --git a/vs2003/CSE2.vcproj b/vs2003/CSE2.vcproj index 27e0f055..68cf93b0 100644 --- a/vs2003/CSE2.vcproj +++ b/vs2003/CSE2.vcproj @@ -2,7 +2,7 @@ From d9e01225a9036be962b781a2ab2704bb60a9d3c0 Mon Sep 17 00:00:00 2001 From: Clownacy Date: Tue, 23 Jun 2020 16:30:12 +0100 Subject: [PATCH 5/5] Update URLs in readme --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 345e261d..933cb8ae 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Build Status](https://travis-ci.com/Clownacy/Cave-Story-Engine-2.svg?branch=accurate)](https://travis-ci.com/Clownacy/Cave-Story-Engine-2) +[![Build Status](https://travis-ci.com/Clownacy/CSE2.svg?branch=accurate)](https://travis-ci.com/Clownacy/CSE2) ## Table of Contents @@ -6,12 +6,12 @@ This repo has multiple branches: Branch | Description --------|-------- -[accurate](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/accurate) | The main decompilation branch. The code intended to be as close to the original as possible, down to all the bugs and platform-dependencies. -[portable](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/portable) | This branch ports the engine away from WinAPI and DirectX, and addresses numerous portability issues, allowing it to run on other platforms. -[enhanced-lite](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/enhanced-lite) | Based on the `portable` branch, this branch is **intended for modders**, and adds several enhancements and features to the engine. -[enhanced](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/enhanced) | Based on the `enhanced-lite` branch, this branch is **intended for players**, and adds further enhancements and features to the engine. -[emscripten](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/emscripten) | Modifies the engine to build with Emscripten, [allowing it to run in web browsers](http://sonicresearch.org/clownacy/cave.html) (no longer maintained). -[wii](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/wii) | Ports the engine to the Nintendo Wii (no longer maintained). +[accurate](https://www.github.com/Clownacy/CSE2/tree/accurate) | The main decompilation branch. The code intended to be as close to the original as possible, down to all the bugs and platform-dependencies. +[portable](https://www.github.com/Clownacy/CSE2/tree/portable) | This branch ports the engine away from WinAPI and DirectX, and addresses numerous portability issues, allowing it to run on other platforms. +[enhanced-lite](https://www.github.com/Clownacy/CSE2/tree/enhanced-lite) | Based on the `portable` branch, this branch is **intended for modders**, and adds several enhancements and features to the engine. +[enhanced](https://www.github.com/Clownacy/CSE2/tree/enhanced) | Based on the `enhanced-lite` branch, this branch is **intended for players**, and adds further enhancements and features to the engine. +[emscripten](https://www.github.com/Clownacy/CSE2/tree/emscripten) | Modifies the engine to build with Emscripten, [allowing it to run in web browsers](http://sonicresearch.org/clownacy/cave.html) (no longer maintained). +[wii](https://www.github.com/Clownacy/CSE2/tree/wii) | Ports the engine to the Nintendo Wii (no longer maintained). # CSE2