You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-4Lines changed: 14 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,27 @@
2
2
3
3
# :rocket: What is R-Type ?
4
4
Our project R-Type is an ersatz of the famous [R-Type](https://www.youtube.com/watch?v=2xAX6XTzpg0) arcade game, the purpose of the game is to control a ship and navigate throught the space while shooting and destroying ennemy ships.
5
+
5
6
However, the specifity of our game is that we implemented a multiplayer mode that allow you to play in coop from 2 to 4 players.
6
7
8
+
Our game also dispose of two difficulties, EASY and HARD as well as a WAVE EDITOR in order to modify monster spawning during the game (check SCRIPT.md on the documentation to have more informations about it).
9
+
7
10
# In game preview
8
11

12
+

13
+

14
+

15
+
9
16
# :star: Pre-compiled version for the impatient ones
10
17
You can look on the right side of our repository, in the [Releases](https://github.com/VictorHarri-Chal/R-Type/releases) section in order to download a pre-compiled version depending on your operating system to play right away
11
18
12
19
# :computer: Supported Platforms
13
-
Our project can be played on both ```Linux``` and ```Windows``` OS as well as ```MacOS```
20
+
Our project can be played on both ```Linux``` and ```Windows``` OS as well as ```MacOS``` and ```Raspberry Pi```
14
21
15
22
# :hammer: Building
16
23
To build our project you need to execute a simple script a the root of our repository.
17
24
18
-
It will take care of dowloading the dependencies as well as compiling our code.
25
+
It will take care of dowloading the dependencies as well as compiling the code.
19
26
20
27
```./install.sh```
21
28
@@ -27,13 +34,16 @@ And then, you can connect as many clients as you wish with this command:
27
34
28
35
```./r-type_client```
29
36
37
+
You can specify a ```-g``` after the ```./r-type_client``` if you want to play immediatly in solo mode without going through menus.
38
+
39
+
Or you can specify a ```-w``` if you want to have the menus and the solo mode in windowed (fullscreen by default).
40
+
30
41
### On Linux, Windows & Mac
31
42
The dependencies are [CMake](https://cmake.org/), [SFML](https://www.sfml-dev.org/index-fr.php) and [Boost](https://boost.org).
32
43
33
44
# :video_game: How to play
34
-
Depending on your setup : (look the settings in game)
35
45
36
-
- No mouse -> Move with the ```ARROW KEYS``` and shoot with ```SPACE```
46
+
Move with the ```ARROW KEYS```, shoot with ```SPACE``` and use your class skill with ```C```
37
47
38
48
# :page_with_curl: Documentation
39
49
To read our project documentation, you need to execute a script in order to open a local web page.
0 commit comments