README.md 1.74 KB
Newer Older
William Bundy's avatar
William Bundy committed
1
# [Rituals](rituals.handmade.network)
William Bundy's avatar
William Bundy committed
2 3 4 5
A free, open source Zelda-like survival/adventure game

This repository is up early to satisfy the "Public Git Repository" tier on my [Patreon](http://patreon.com/williambundy).

William Bundy's avatar
William Bundy committed
6 7
(9/30) I've moved this repository to git.handmadedev.org! (but don't worry, I push to github too)

William Bundy's avatar
William Bundy committed
8 9 10 11
### by William Bundy
 - @William_Bundy on twitter

## Stream
William Bundy's avatar
William Bundy committed
12
I stream Rituals' development regularly at [my twitch channel](http://twitch.tv/williambundy). My stream schedule is "sometime before 2PM Pacific" every day except Monday. This usually means around 11AM
William Bundy's avatar
William Bundy committed
13 14 15

## License
Rituals' source is licensed under the MIT license. Feel free to learn as much as you can from it.
William Bundy's avatar
William Bundy committed
16
I'm planning to relicence the game under something without a "redistribute the LICENSE.txt" clause; expect an update in the future where I do so.
William Bundy's avatar
William Bundy committed
17 18 19 20 21 22 23 24 25 26

## How to build (windows)
 1. Install Visual Studio (I'm using 2015)
 2. Change the msvcdir variable in make.bat, if necessary
 3. Download SDL2's development libraries
 4. Set LIBRARIES and INCLUDES in make.bat to point to those
 5. You probably want to delete the line "start python autogit.py" in make.bat too
 6. Run make.bat

## How to build (other OSes)
William Bundy's avatar
William Bundy committed
27
 1. Install clang or gcc
William Bundy's avatar
William Bundy committed
28 29
 2. Install SDL2 development packages for your distro, or the SDL2 framework for OSX
 2. Make sure you have sdl2-config
William Bundy's avatar
William Bundy committed
30
 2. On macOS, add -framework opengl to the makefile
William Bundy's avatar
William Bundy committed
31
 3. Run make.
William Bundy's avatar
William Bundy committed
32 33

## How to play
William Bundy's avatar
William Bundy committed
34
The game is currently in heavy development ("pre-alpha"), so there is very little to actually play:
William Bundy's avatar
William Bundy committed
35
 - Use the WASD keys to move.
William Bundy's avatar
William Bundy committed
36
 - Shoot some kind of... shotgun type weapon with left click.
William Bundy's avatar
William Bundy committed
37 38 39
 - Press F to whack the ground. If a tile breaks, bare earth is revealed underneath.
 - Press and hold Space to grab an entity in the direction you are facing.