cave-story-solaris/README.md
Clownacy bcd02cb6cc Improved README
* Added licensing information
* Stated dependencies
* Added zxin's link to 'Bug Fixes.txt'
2019-01-26 15:48:50 +00:00

920 B

Cave Story Engine 2

Cave Story Engine is an in-progress decompilation of Cave Story (freeware release), ported from DirectX to SDL2.

Screenshot

Dependencies

This project currently depends on SDL2 and Freetype2.

Building

Just run 'make' in the base directory, preferably with some of the following optional settings:

  • RELEASE=1 to compile a release build (optimised, stripped, etc.)
  • STATIC=1 to produce a statically-linked executable (good for Windows builds)
  • JAPANESE=1 to enable the Japanese-language build (instead of the unofficial Aeon Genesis English translation)
  • FIX_BUGS=1 to fix certain bugs (see src/Bug Fixes.txt)

Licensing

Being a decompilation, the majority of the code in this project belongs to Daisuke "Pixel" Amaya - not us. We've yet to agree on a license for our own code.