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

More README cleanup

Browse source
This commit is contained in:
Clownacy 2020-10-25 13:34:31 +00:00
parent 1b9c2d3662
commit fe4c14615b
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -26,22 +26,22 @@ Technically, this alone made a decompilation feasible, as was the case for [the
Super Mario 64 decompilation project](https://github.com/n64decomp/sm64) - Super Mario 64 decompilation project](https://github.com/n64decomp/sm64) -
however, there was more to be found... however, there was more to be found...
In 2007, a Linux port of Cave Story was made by Peter Mackay and Simon Parzer. In 2007, a Linux port of Cave Story was made by Simon Parzer and Peter Mackay.
Details about it can be found on [Peter's old blog](https://web.archive.org/web/20070911202919/http://aaiiee.wordpress.com:80/). Details about it can be found on [Peter's old blog](https://web.archive.org/web/20070911202919/http://aaiiee.wordpress.com:80/).
This port received an update in 2011, including two shiny new executables. What This port received an update in 2011, including two shiny new executables. What
Peter and Simon didn't realise was that they left huge amounts of debugging they didn't realise was that they left huge amounts of debugging information in
information in these executables, including the names of every C++ source file, these executables, including the names of every C++ source file, as well as the
as well as the variables, functions, and structs they contained. variables, functions, and structs they contained.
This was a goldmine of information about not just the game's inner-workings, but This was a goldmine of information about not just the game's inner-workings, but
its _source code._ This is the same lucky-break [the Diablo decompilation project](https://github.com/diasurgical/devilution) its _source code._ This is the same lucky-break [the Diablo decompilation project](https://github.com/diasurgical/devilution)
had. With it, much of the game's code was pre-documented and explained _for_ us, had. With it, much of the game's code was pre-documented and explained, saving
saving us the effort of doing it ourselves. In fact, the combination of us the effort of doing it ourselves. In fact, the combination of
easy-to-decompile code, and a near-full set of function/variable names, reduced easy-to-decompile code, and a near-full set of function/variable names, reduced
much of the decompilation process to mere copy-paste. much of the decompilation process to mere copy-paste.
To top it all off, some of Cave Story's original source code would eventually To top it all off, some of Cave Story's original source code would eventually
see the light of day... see the light of day:
In early 2018, the Organya music engine was [released on GitHub](https://github.com/shbow/organya) In early 2018, the Organya music engine was [released on GitHub](https://github.com/shbow/organya)
by an old friend of Pixel's. On top of providing an insight into Pixel's coding by an old friend of Pixel's. On top of providing an insight into Pixel's coding
@ -49,7 +49,7 @@ style, this helped with figuring out one of the most complex parts of Cave
Story's codebase. Story's codebase.
And... that's it! It's not often that a game this decompilable comes along, so And... that's it! It's not often that a game this decompilable comes along, so
I'm glad that Cave Story was one of them. [Patching a dusty old executable from 2004 has its downsides](https://github.com/Clownacy/Cave-Story-Mod-Loader/blob/master/src/mods/graphics_enhancement/widescreen/patch_camera.c). I'm glad that Cave Story was one of them. [Patching a dusty old executable from 2005 sucks](https://github.com/Clownacy/Cave-Story-Mod-Loader/blob/master/src/mods/graphics_enhancement/widescreen/patch_camera.c).
## Building ## Building