A fork of CSE2 providing support and optimization for running on a Sun Ultra 1.
Find a file
2020-04-02 21:03:38 +01:00
assets/resources Don't embed font in executable 2020-03-17 21:14:15 +00:00
bin2h Fix errors 2020-03-14 22:50:04 +00:00
cmake Remove a duplicate lib from OPENGLES2_LIBRARIES 2020-01-20 15:41:54 +00:00
DoConfig Ignore argc, don't ignore argv 2020-04-02 20:58:01 +01:00
external Fixes 2020-04-01 23:15:22 +01:00
game_english/data Don't embed font in executable 2020-03-17 21:14:15 +00:00
game_japanese/data Don't embed font in executable 2020-03-17 21:14:15 +00:00
src Ignore argc, don't ignore argv 2020-04-02 20:58:01 +01:00
.gitattributes Mark TSC files as binary, not text 2020-01-09 06:32:10 +00:00
.gitignore Move CMake .gitignore line 2020-04-02 14:18:48 +01:00
.travis.yml Make Travis test alternate backends 2020-04-02 21:03:38 +01:00
CMakeLists.txt Use LINK_LIBRARIES instead of LIBRARIES 2020-04-02 20:57:16 +01:00
PHILOSOPHY.md Update PHILOSOPHY.md 2020-02-01 11:49:18 +00:00
README.md Update documentation 2020-04-02 20:22:52 +01:00
screenshot.png New screenshot 2019-09-05 20:57:48 +00:00

Build Status

Table of Contents

This repo has multiple branches:

Branch Description
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 This branch ports the engine to SDL2, and addresses numerous portability issues, allowing it to run on other platforms.
enhanced Based on the portable branch, this adds several enhancements to the engine, and makes it more accessible to modders.
emscripten Modifies the engine to build with Emscripten, allowing it to run in web browsers (no longer maintained).
wii Ports the engine to the Nintendo Wii (no longer maintained).

Cave Story Engine 2 (Portable)

Cave Story Engine 2 is a decompilation of Cave Story.

This branch migrates the engine from WinAPI to SDL2, and addresses numerous portability issues, allowing it to run on other platforms.

Screenshot

Background

In 2007, a Linux port of Cave Story was made by Peter Mackay and Simon Parzer. Details about it can be found in Peter's old blog. 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 information in these executables, including the names of every C++ source file, and the variables and functions they contained.

This was a goldmine of information about not just the game's inner-workings, but its source code. This alone made a decompilation viable, but it wasn't the only help we'd get...

When Pixel made Cave Story, he compiled the original Windows EXE with no optimisations. This left the generated assembly code extremely verbose and easy to read. It also made the code very decompiler-friendly, since the assembly could be mapped directly back to the original C(++) code.

A combination of easy-to-decompile code and a near-complete symbol list made much of the decompilation process a copy/paste job, but not all of the game would need decompiling, as some of Cave Story's source code would actually see the light of day...

In early 2018, the Organya music engine was released on GitHub by an old friend of Pixel's. On top of providing an insight into Pixel's coding style, this helped with figuring out one of the most complex parts of Cave Story's codebase.

It's because of these findings that a decompilation is possible: the Mario 64 decompilation project had a game that was built with no optimisations, the Devilution project was lucky enough to find a symbol list, so it's a miracle that we have both!

Many months of copypasting and tinkering later, here is the result.

Dependencies

  • SDL2
  • GLFW3
  • FreeType

In CMake builds, if these are not found, they will be built locally.

In addition, pkg-config is required for builds that require static-linkage.

Building

This project uses CMake, allowing it to be built with a range of compilers.

Switch to the terminal (Visual Studio users should open the Developer Command Prompt) and cd into this folder. After that, generate the files for your build system with:

cmake -B build -DCMAKE_BUILD_TYPE=Release

MSYS2 users may want to append -G"MSYS Makefiles" to this command, also.

You can also add the following flags:

Name Function
-DJAPANESE=ON Enable the Japanese-language build (instead of the unofficial Aeon Genesis English translation)
-DFIX_BUGS=ON Fix various bugs in the game
-DDEBUG_SAVE=ON Re-enable the ability to drag-and-drop save files onto the window
-DBACKEND_RENDERER=OpenGL3 Use the hardware-accelerated OpenGL 3.2 renderer
-DBACKEND_RENDERER=OpenGLES2 Use the hardware-accelerated OpenGL ES 2.0 renderer
-DBACKEND_RENDERER=SDLTexture Use the hardware-accelerated SDL2 Texture API renderer (default) (note: requires -DBACKEND_PLATFORM=SDL2)
-DBACKEND_RENDERER=SDLSurface Use the software-rendered SDL2 Surface API renderer (note: requires -DBACKEND_PLATFORM=SDL2)
-DBACKEND_RENDERER=Software Use the handwritten software renderer (note: requires -DBACKEND_PLATFORM=SDL2)
-DBACKEND_AUDIO=SDL2 Use the SDL2-driven software audio-mixer
-DBACKEND_AUDIO=miniaudio Use the miniaudio-driven software audio-mixer
-DBACKEND_PLATFORM=SDL2 Use SDL2 for windowing and OS-abstraction
-DBACKEND_PLATFORM=GLFW3 Use GLFW3 for windowing and OS-abstraction
-DLTO=ON Enable link-time optimisation
-DPKG_CONFIG_STATIC_LIBS=ON On platforms with pkg-config, static-link the dependencies (good for Windows builds, so you don't need to bundle DLL files)
-DMSVC_LINK_STATIC_RUNTIME=ON Link the static MSVC runtime library (Visual Studio only)
-DFORCE_LOCAL_LIBS=ON Compile the built-in versions of SDL2, GLFW3, and FreeType instead of using the system-provided ones

You can pass your own compiler flags with -DCMAKE_C_FLAGS and -DCMAKE_CXX_FLAGS.

You can then compile CSE2 with this command:

cmake --build build --config Release

If you're a Visual Studio user, you can open the generated CSE2.sln file instead, which can be found in the build folder.

Once built, the executables can be found in the game_english/game_japanese folder, depending on the selected language.

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 licence for our own code.