README.md 2.19 KB
Newer Older
Huetagoyena's avatar
Huetagoyena committed
1 2
# Lander
CLI Top-Down Space Shooter
3

capuno's avatar
capuno committed
4 5
<div align=center>

Huetagoyena's avatar
Huetagoyena committed
6
![Main gif](http://i.imgur.com/70jvdo3.gif)
7

capuno's avatar
capuno committed
8 9
</div>

10
Lander is a top-down shooter made in C++
Huetagoyena's avatar
Huetagoyena committed
11

Huetagoyena's avatar
Huetagoyena committed
12
## CONTRIBUTORS
Huetagoyena's avatar
Huetagoyena committed
13 14
Main Contributors:

Huetagoyena's avatar
Huetagoyena committed
15 16 17
* [MrWhiteGoat](https://github.com/MrWhiteGoat)
* [Capuno](https://github.com/Capuno)

Huetagoyena's avatar
Huetagoyena committed
18
Another cool version using a BeagleBone Black as a controller (god bless GPL v3):
Huetagoyena's avatar
Huetagoyena committed
19 20 21 22 23 24

[Source](https://github.com/GustavoAC/Lander)

* [GustavoAC](https://github.com/GustavoAC)
* [thiagocesarm](https://github.com/thiagocesarm)

Huetagoyena's avatar
Huetagoyena committed
25

Huetagoyena's avatar
Huetagoyena committed
26
## DEPENDENCIES
Huetagoyena's avatar
Huetagoyena committed
27
> `libncurses5-dev`, `g++`, `libncursesw5-dev`
Huetagoyena's avatar
Huetagoyena committed
28

Huetagoyena's avatar
Huetagoyena committed
29
Distro | Command
Huetagoyena's avatar
Huetagoyena committed
30 31 32 33
------------: | :-------------
Debian & based | `sudo apt install g++ libncurses5-dev libncursesw5-dev`
Arch & based | `sudo pacman -S gcc`

34

Huetagoyena's avatar
Huetagoyena committed
35
## INSTALLATION
Huetagoyena's avatar
Huetagoyena committed
36

Huetagoyena's avatar
Huetagoyena committed
37 38
### Plan A: Automatic

Huetagoyena's avatar
Huetagoyena committed
39
The script is still under development, currently working on Debian and Ubuntu, should work on Mint with a little modification on line 21, didn't have time to fix it myself, send PR pls im too lazy.
Huetagoyena's avatar
Huetagoyena committed
40 41 42 43 44

```bash
$ curl https://raw.githubusercontent.com/Capuno/Lander/master/autoInstall.sh | bash
```

Huetagoyena's avatar
Huetagoyena committed
45 46 47 48 49 50 51 52 53 54 55
[Maybe its better to download the script somewhere and then execute it:](https://www.seancassidy.me/dont-pipe-to-your-shell.html)

```bash
$ wget https://raw.githubusercontent.com/Capuno/Lander/master/autoInstall.sh
$ md5sum autoInstall.sh
$ chmod +x autoInstall.sh
$ ./autoInstall.sh #Will install Lander in ${pwd}/lander
```

MD5 of the script = 01507fb4e4d3d65ed6c3ab4b2c1ca063 (checked in commit 620ca68c91039d1d4979a6f699b685ec9a1ad075)

Huetagoyena's avatar
Huetagoyena committed
56 57 58 59 60 61 62 63 64 65 66
### Plan B: Manual

After installing the [Dependencies](https://github.com/Capuno/Lander#dependencies)

```bash
$ git clone https://github.com/Capuno/Lander.git
$ cd Lander
$ make
$ ./lander_game
```

Huetagoyena's avatar
Huetagoyena committed
67
### Plan C: Binary only
Huetagoyena's avatar
Huetagoyena committed
68

capuno's avatar
capuno committed
69 70 71
Probably outdated... I don't think it's a good option, maybe only if you can't compile it for whatever reason.
If you have problems compiling it, please open a new issue.

Huetagoyena's avatar
Huetagoyena committed
72
```bash
Huetagoyena's avatar
Huetagoyena committed
73 74 75
$ wget https://github.com/Capuno/Lander/releases/download/v1.0.0/lander_game
$ chmod +x lander_game
$ ./lander_game
Huetagoyena's avatar
Huetagoyena committed
76 77
```

Huetagoyena's avatar
Huetagoyena committed
78
## CONTROLS
79 80 81 82 83 84

 * `z` moves left
 * `x` shoots
 * `c` moves right

This can be configured in `config.h` before compiling.
Huetagoyena's avatar
Huetagoyena committed
85 86 87 88 89



&emsp;

Huetagoyena's avatar
Huetagoyena committed
90
### KNOWN ISSUES
Huetagoyena's avatar
Huetagoyena committed
91
* *Laser changing color to red*
92
* *Console causes visual glitch*