Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 2.95 KB

README.md

File metadata and controls

56 lines (41 loc) · 2.95 KB
Raw

CI build

A fork of Hurrican, freeware jump and shoot game created by Poke53280, with SDL2 enabled by default, support for libopenmpt and CRT simulation. Also uses XDG compliant data/config paths on UNIX. Additional userlevels from http://turricanforever.de included.

Original code by Eiswuxe (Poke53280) [Winterworks]
Further work by Pickle136, Stefan Schmidt (thrimbor) and Leandro Nini (drfiemost)
CRT simulation partially based on CRT effect - Shadertoy, Unity article from luka712's blog

screenshot

Dependencies

The code depends on SDL2 (or the old deprecated SDL) with the image and mixer components, and libepoxy. Optionally libopenmpt can be used for the music in place of the standard from SDL_mixer (see below). A compiler with c++17 support is required.

Building

The code can be built using cmake (tested on Linux and MinGW)

git clone --recurse-submodules https://github.com/HurricanGame/Hurrican.git
cd Hurrican/Hurrican
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
cmake --build .

The following build options are available:

Predefined platforms

  • -DPLATFORM=<RPI|GCW|RDU|RDU2|PANDORA> : Compile for the specified platform, setting the correct options

OpenGL Options

  • -DRENDERER=GL1 : Use the OpenGL 1.X code (fixed pipline)
  • -DRENDERER=GLES1 : Use the OpenGL 1.X code with ES compatible
  • -DRENDERER=GL2 : Use the OpenGL 2.0 code (programable pipline) [this is the default if not specified]
  • -DRENDERER=GLES2 : Use the OpenGL 2.0 code with ES compatible
  • -DRENDERER=GL3 : Use the OpenGL 3.0 code (programable pipline)
  • -DRENDERER=GLES3 : Use the OpenGL 3.0 code with ES compatible
  • -DFBO=ON : Add FBO support, allow screen to be scaled to arbitrary dimensions, available only with GL2 or GL3 and enabled by default
  • -DDEFAULT_SCREENBPP=<16|24|32> : Set the default screen depth, 32 if not specified

Sound

  • -DOPENMPT=ON : Use the libopenmpt code for music (SDL2_mixer uses libmodplug while SDL_mixer uses the lower quality mikmod engine)

Generic

  • -DFAST_RANDOM=OFF : Use standard C random function in place of the fast LCG
  • -DFAST_TRIG=ON : Use fast approximation for trigonometric functions
  • -DDISABLE_EXCEPTIONS=ON : Disable exception handling to reduce binary size

Debug

  • -DDISABLE_MEMPOOLING=ON : Bypass pooled memory manager
  • -DCMAKE_BUILD_TYPE=<Asan|Ubsan>: Enable the Address or Undefined Behaviour Sanitizer