shithub: cstory

Download patch

ref: 7334440c2757df39bf1293e036ac44bb779ef0e5
parent: e45d69fd2dc9f8af41653c231188ebc1948c9764
parent: d9e01225a9036be962b781a2ab2704bb60a9d3c0
author: Clownacy <Clownacy@users.noreply.github.com>
date: Tue Jun 23 15:42:32 EDT 2020 

Merge branch 'accurate' into portable


--- 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
@@ -68,16 +68,21 @@
 
 ## 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 ('<MIM', '<PHY')
-* Other common "EXE hacks" developed by the modding community (custom weapons, money system)
+* Custom weapons
+* A money system
+* The "Cave Story Mod Loader" (widescreen, support for Ogg Vorbis music)
+
+Note that such features should only be added if they see widespread use.
 
 ## Target audience
 While this branch is meant as a base for mods, it is not intended for modders
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.com/Clownacy/Cave-Story-Engine-2.svg?branch=portable)](https://travis-ci.com/Clownacy/Cave-Story-Engine-2)
+[![Build Status](https://travis-ci.com/Clownacy/CSE2.svg?branch=portable)](https://travis-ci.com/Clownacy/CSE2)
 
 ## Table of Contents
 
@@ -6,16 +6,16 @@
 
 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).
 
-# Cave Story Engine 2 (Portable)
+# CSE2 (Portable)
 
-Cave Story Engine 2 is a decompilation of Cave Story.
+CSE2 is a decompilation of Cave Story.
 
 This branch migrates the engine away from WinAPI and DirectX, and addresses numerous portability issues, allowing it to run on other platforms.
 
@@ -65,7 +65,7 @@
 cmake -B build -DCMAKE_BUILD_TYPE=Release
 ```
 
-MSYS2 users may want to append `-G"MSYS Makefiles" -DPKG_CONFIG_STATIC_LIBS=ON` to this command, also.
+MSYS2 users should append `-G"MSYS Makefiles" -DPKG_CONFIG_STATIC_LIBS=ON` to this command, also.
 
 You can also add the following flags:
 
-- 
⑨