Skip to content

Commit 9869a1c

Browse files
Update README.md
1 parent 6890f9c commit 9869a1c

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,27 @@
22

33
# :rocket: What is R-Type ?
44
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+
56
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.
67

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+
710
# In game preview
811
![Menu](menu.png)
12+
![Classes](classes.png)
13+
![Game](game1.png)
14+
![Boss](game2.png)
15+
916
# :star: Pre-compiled version for the impatient ones
1017
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
1118

1219
# :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```
1421

1522
# :hammer: Building
1623
To build our project you need to execute a simple script a the root of our repository.
1724

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.
1926

2027
```./install.sh```
2128

@@ -27,13 +34,16 @@ And then, you can connect as many clients as you wish with this command:
2734

2835
```./r-type_client```
2936

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+
3041
### On Linux, Windows & Mac
3142
The dependencies are [CMake](https://cmake.org/), [SFML](https://www.sfml-dev.org/index-fr.php) and [Boost](https://boost.org).
3243

3344
# :video_game: How to play
34-
Depending on your setup : (look the settings in game)
3545

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

3848
# :page_with_curl: Documentation
3949
To read our project documentation, you need to execute a script in order to open a local web page.

0 commit comments

Comments
 (0)