duuqnd/cave-story-solaris
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Backport the portable branch's PHILOSOPHY.md

Browse source
This commit is contained in:
Clownacy 2020-09-22 00:33:50 +01:00
parent 620a25d75c
commit 049b5e373a
1 changed files with 17 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
PHILOSOPHY.md
View file

@ -25,31 +25,36 @@ know from the [Organya source code release](https://github.com/shbow/organya/)
what Pixel's code-style looked like, and I find it **extremely** hard to read. what Pixel's code-style looked like, and I find it **extremely** hard to read.
## Language ## Language
Cave Story's developer, Pixel, primarily speaks Japanese, but his code's Cave Story's developer (Pixel) primarily speaks Japanese, but his code's
variable/function names are mostly written in English (with a few rare instances variable/function names are mostly written in English (with a few rare instances
of Romanised Japanese). of Romanised Japanese).
The Organya source code release indicates Pixel wrote his comments in Japanese, The Organya source code release indicates that Pixel wrote his comments in
however, in this project, I prefer them to be written in English. Japanese, however, in this project, I prefer them to be written in English.
The English employed in this project is a mix of American English, Canadian The English employed in this project is a mix of American English, Canadian
English, and British English. English, and British English.
# `portable` branch # `portable` branch
This branch takes a different direction to the `accurate` branch, but they still This branch takes a different direction to the `accurate` branch, but they still
share some core philosophies: share many core philosophies:
## Goal ## Goal
The goal is still to accurately-reproduce Cave Story's original code, but While accurately-reproducing Cave Story's original code is still a priority, the
modified to the extent that it is easy to port to other platforms. This branch main focus of this branch is to port the game to other platforms, while also
is intended for purists that don't want to use Windows or its deprecated APIs. preserving the game the way it was experienced back in 2004.
Notably, this means bugs should still be left intact. However, bugs and other Essentially, this branch exists to provide a purist Cave Story experience
coding errors that affect portability should be fixed. without requiring an old Windows XP computer.
For comparison, I believe this branch shares some parallels with the Notably, this means that bugs should still be left intact. However, bugs and
Chocolate Doom project, except perhaps more strict. See the link below for their other coding errors that affect portability should be fixed.
list of philosophies which may be applicable here:
For comparison, I believe this branch shares many parallels with the
Chocolate Doom project. Follow the link below to see that project's list of
philosophies, which may be applicable here:
https://github.com/chocolate-doom/chocolate-doom/blob/master/PHILOSOPHY.md https://github.com/chocolate-doom/chocolate-doom/blob/master/PHILOSOPHY.md