jazztickets/irrlamb

irrlamb - 3D physics game
by Alan Witkowski

Home Page:
https://github.com/jazztickets/irrlamb

Game Guide:
https://jazztickets.github.io/docs/irrlamb/

----- HOW TO PLAY -----

irrlamb is a 3D physics game in which you control a blue ball of energy in
an attempt to touch all glowing orbs in the level.

-- Game Controls --
E                     Move forward
D                     Move backwards
S                     Move left
F                     Move right
X                     Restart level
Spacebar              Jump
Escape                Menu (or quit game in test mode)
F1                    Menu
F2                    Invert mouse Y-axis
F3                    Show player position in console
F5                    Reload level from disk
F10                   Toggle Audio
F11                   Toggle HUD
F12                   Screenshot

-- Gamepad Controls --
Left Stick            Move
Right Stick           Adjust camera
A                     Jump
B                     Go back in menu
Y                     Validate replay (from Replays menu)
Select                Restart level
Start                 Menu
Left Bumper           Decrease replay speed
Right Bumper          Increase replay speed

-- Replay Controls --
Right Mouse Button    Enable free camera mode
Spacebar              Pause
Right Arrow           Skip 1 second
Up Arrow*             Increase replay speed by 0.1x
Down Arrow*           Decrease replay speed by 0.1x
Mouse Wheel*          Increase/decrease replay speed by 0.1x
1                     Set replay speed to 0.5x
2                     Set replay speed to 1.0x
3                     Set replay speed to 2.0x
4                     Set replay speed to 4.0x
5                     Set replay speed to 8.0x
F11                   Toggle HUD
F12                   Screenshot
V                     Validate replay (from Replays menu)

*Holding Left Shift changes by 0.01x

----- BUILDING ON LINUX -----

Download and extract the latest irrlamb-*-src.tar.gz from https://github.com/jazztickets/irrlamb/releases

OR

Clone the repository:
git clone https://github.com/jazztickets/irrlamb.git --recurse-submodules

-- Dependencies required --
ninja
cmake 2.8.12+
freetype2
sqlite3
openal
libvorbis
libogg
libjpeg
libpng
zlib

-- Installing dependencies on Ubuntu 20.04 --
sudo apt install ninja-build cmake build-essential libopenal-dev libvorbis-dev libjpeg-dev libpng-dev libfreetype6-dev libsqlite3-dev

-- Installing dependencies on Arch Linux --
sudo pacman -S base-devel ninja cmake openal libvorbis libogg libpng libjpeg freetype2 sqlite

-- Build executable --
./build.sh

-- Running the game without installing --
cd working && ./irrlamb

-- Installing --
cd build/release
sudo ninja install

-- Uninstall --
cd build/release
cat install_manifest.txt | xargs sudo rm

----- COMMAND-LINE ARGUMENTS -----
-resolution [width] [height]     Set screen resolution
-fullscreen                      Set fullscreen mode
-windowed                        Set windowed mode
-level [.xml file]               Test a level
-replay [.replay file]           View a replay
-validate [.replay file]         Test a level with replay inputs
-noaudio                         Disable audio

Save data is in:
	~/.local/share/irrlamb for linux
	%APPDATA%/irrlamb for windows