~rabbits/hiversaires

ref: 174b9d35b7c02f95df373df4414b62dfcf55cf7a hiversaires/README.md -rw-r--r-- 2.5 KiB
174b9d35neauoire Improved readme 10 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.

#Requirements

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

#Arch

sudo pacman -S sdl2 sdl2_mixer

#Ubuntu

sudo apt-get install sdl2 sdl2_mixer

#OSX

If you're on a Mac, you can use Homebrew to install these libraries: brew install sdl2 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.

#Windows

Download SDL2, and SDL Mixer.

#Build

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:

./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, or A, Turn Left
  • Right Arrow, or D, Turn Right
  • Up Arrow, or W, Step Forward or Perform Action
  • Down Arrow, or S, 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).