~rabbits/hiversaires

174b9d35b7c02f95df373df4414b62dfcf55cf7a — neauoire 8 months ago eed9aca
Improved readme
2 files changed, 34 insertions(+), 25 deletions(-)

M CONTRIBUTORS.md
M README.md
M CONTRIBUTORS.md => CONTRIBUTORS.md +8 -16
@@ 4,21 4,13 @@ There have been several versions of Hiversaires over the years. Friends have tak

Here's a list of them.

Devine Lu Linvega      Art 
Rekka Bellum           Art
rezmason               Code(C Ver.)
.ruby                  Code(Haxe Ver.)
Gabriel Verdon         Promo Art
cancel                 Advisor

Devine Lu Linvega
Rekka Bellum
Testing:

.ruby
rezmason

Offal
Tekgo
Orihaus
Minikomi
John Eternal
Richard E Flanagan

Gabriel Verdon

cancel
Mike Pavone
Offal, Tekgo, Orihaus, Minikomi, John Eternal, Richard E Flanagan, Mike Pavone

M README.md => README.md +26 -9
@@ 4,11 4,23 @@ Hiversaires is a point-n-click, or "escape" type game created for adventurers wh

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](https://wiki.libsdl.org/), [SDL_mixer](https://www.libsdl.org/projects/SDL_mixer/) and [mpg123](https://mpg123.org).

## Build
### Arch

We intend for Hiversaires to compile for most platforms. To build Hiversaires, you must have [SDL2](https://wiki.libsdl.org/), [SDL_mixer](https://www.libsdl.org/projects/SDL_mixer/) and [mpg123](https://mpg123.org).
```
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`



@@ 17,7 29,13 @@ 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:
### Windows

Download [SDL2](https://wiki.libsdl.org/), and [SDL Mixer](https://www.libsdl.org/projects/SDL_mixer/release/SDL2_mixer-2.0.4-win32-x64.zip).

## Build

Run the build script like this:

```
./build.sh [args...]


@@ 36,8 54,7 @@ Supported build arguments are:
To play Hiversaires, run it like this:

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

Supported arguments are:


@@ 48,10 65,10 @@ Supported arguments are:

### 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
- `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