shithub: cstory

--- a/PHILOSOPHY.md

+++ b/PHILOSOPHY.md

@@ -62,7 +62,7 @@

 I prefer compiler-specific code to be avoided, since more-portable code benefits

 all compilers, and keeps the codebase free of clutter.

-# `enhanced` branch

+# `enhanced-lite` branch

 This branch deviates the most from the `accurate` branch, focussing less on

 authenticity, and more on improving the base engine.

@@ -94,3 +94,24 @@

 Cave Story's gameplay, avoiding an NXEngine-scenario where the game is riddled

 with inaccuracies, both small and large. This also has the benefit of making it

 easier to merge changes from the other branches.

+## Enhancements unrelated to modding

+Some features have made their way into this branch, despite not actually being

+of any direct use to modders - one example of this is the option to disable the

+pixel-alignment effect.

+The reason for allowing these features is that, while they are of no direct

+benefit to modders, they are of benefit _to players._ Thus, a mod with these

+features is better than a mod without them. Likewise, the input-rebinding menu

+falls under a similar use.

+The line is drawn when a feature comes at a _detriment_ to modders - for

+example, having an option to select an alternative soundtrack (such as the

+Nicalis ones) is nice for the player, but will complicate modding, as, if a mod

+includes custom music, the modder will either have to disable the soundtracks

+they don't support, or they'll have to create multiple versions of each song.

+# `enhanced` branch

+This branch is built upon the `enhanced-lite` branch, and follows similar ideals

+to said branch. However, this branch targets players rather than modders,

+allowing a greater range of features to be added.

--- a/README.md

+++ b/README.md

@@ -8,7 +8,8 @@

 --------|--------

 [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](https://www.github.com/Clownacy/Cave-Story-Engine-2/tree/enhanced) | Based on the portable branch, this adds several enhancements to the engine, and makes it more accessible to modders.

+[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).