~rabbits/hiversaires

ref: 3e1627a4c505fa9109dd8d7d107a0b9946af8e5c hiversaires/README.md -rw-r--r-- 2.3 KiB
3e1627a4Rezmason Implementing the credits as just a slower splash, with fading in mixed in, and click-through links to the logos' corresponding sites. Added Aliceffekt logo and the secret logo. Updated the credit trigger to only show the secret if the player has an extra fuse *and* didn't use the walkthrough. 1 year, 3 months ago

#Hiversaires

Hiversaires is a point-n-click, or "escape" type game created for adventurers who remember games where you had to draw maps to find your way out of a cave. The dark world of Hiversaires features an original Aliceffekt soundtrack to lure you through its entangled corridors.

Feel free to send pull requests if you find an issue that you wish to correct.

#Build

We intend for Hiversaires to compile for most platforms. To build Hiversaires, you must have SDL2, SDL_ttf, SDL_mixer and mpg123.

If you're on a Mac, you can use Homebrew to install these libraries: brew install sdl2 sdl2_ttf sdl2_mixer mpg123

We rebuild the mixer to support MP3s by running brew edit sdl2_mixer, replacing --disable-music-mp3-mpg123 with --enable-music-mp3-mpg123, and then running brew reinstall --build-from-source sdl2_mixer

If the reinstall fails, run brew doctor and remove what it asks you to from /opt or /usr, then try again.

Finally, run the build script like this:

./build.sh [args...]

Supported build arguments are:

  • -debug builds in debug mode, with the sanitizers on and everything
  • -expand just outputs the macro-expanded code in bin/hiversaires.i
  • -borders draws thin borders around the stage layout regions
  • -run runs the build immediately if it succeeds
  • -increment skips rebuilding the bin folder around the program
  • and any of the runtime arguments below

#Run

To play Hiversaires, run it like this:

cd ./bin
./hiversaires [args...]

Supported arguments are:

  • -reset throws away the game save file, including window settings
  • -portrait initializes the game with a portrait aspect ratio

#Controls

#Basics

  • Left Arrow / clicking left side Turn Left
  • Right Arrow / clicking right side Turn Right
  • Up Arrow / clicking in center Step Forward or Perform Action
  • Down Arrow Step Backward

#Meta

  • R Press and hold to reset the game
  • Q Press and hold to run the game on auto-pilot; let go to return to manual control

#Debug

Spoiler alert! See the DEBUG_KEYS file for these controls.

#License

See the LICENSE file for license rights and limitations (CC).