Update README.md

This commit is contained in:
François Autin 2021-06-26 00:21:50 +00:00
parent b2171ac44d
commit ecf639234d

View File

@ -1,19 +1,16 @@
![Boulevard Combattant Logo](src/main/resources/launcher/logo.png) ![Boulevard Combattant Logo](src/main/resources/launcher/logo.png)
# Boulevard Combattant # 👊 Boulevard Combattant
2D Fighting game, inspired by Street Fighter III: Third Strike. [**Watch the game trailer now**](https://www.youtube.com/watch?v=E0YPzBLoElg)
Developed in the context of an end-of-year project at ISTIC (2020/2021)
<figure class="video_container"> Boulevard Comabattant is a 2D Fighting game, inspired by Street Fighter III: Third Strike. Challenge your friends in an epic faceoff on the streets of Angoulême!
<iframe src="https://www.youtube.com/embed/E0YPzBLoElg" frameborder="0" allowfullscreen="true"> </iframe>
</figure> Built upon our lwjgl and glfw based game engine, BK Engine, Boulevard Comabattant was designed to be easily expansible in the future.
![Game screenshot](docs/game_screenshot.png) ![Game screenshot](docs/game_screenshot.png)
Currently, only a single character is playable. However, the engine allows for easy expansion in the future. ## 🎮 How to play?
## How to play?
Set your preferences in the launcher window, plug-in two DirectInput or XInput capable controllers in your computer, and press start! Use the left analog stick or the D-Pad to move, and the four face buttons for kick and punch, neo-geo style. Set your preferences in the launcher window, plug-in two DirectInput or XInput capable controllers in your computer, and press start! Use the left analog stick or the D-Pad to move, and the four face buttons for kick and punch, neo-geo style.
@ -21,18 +18,18 @@ Set your preferences in the launcher window, plug-in two DirectInput or XInput c
Blue, the main character, knows some advanced martial arts techniques, which can be unlocked through special combinaisons ;). Blue, the main character, knows some advanced martial arts techniques, which can be unlocked through special combinaisons ;).
## How to install / build? ## How to install / build?
Please refer to [INSTALL.md](INSTALL.md). Please refer to [INSTALL.md](INSTALL.md).
## Technologies used by the project ## 🧪 Technologies used by the project
* Java * Java 🍵
* OpenGL via [lwjgl](https://www.lwjgl.org/) * OpenGL via [lwjgl](https://www.lwjgl.org/) 📺
* OpenAL via [lwjgl](https://www.lwjgl.org/) * OpenAL via [lwjgl](https://www.lwjgl.org/) 📢
* [JavaFX](https://openjfx.io) * [JavaFX](https://openjfx.io) 🪟
## Authors ## Authors
* [François AUTIN](https://gitlab.istic.univ-rennes1.fr/fautin) * [François AUTIN](https://gitlab.istic.univ-rennes1.fr/fautin)
* [Victor AZRA](https://gitlab.istic.univ-rennes1.fr/vazra) * [Victor AZRA](https://gitlab.istic.univ-rennes1.fr/vazra)
@ -40,3 +37,6 @@ Please refer to [INSTALL.md](INSTALL.md).
* [Antoine DUPUIS](https://gitlab.istic.univ-rennes1.fr/18002392) * [Antoine DUPUIS](https://gitlab.istic.univ-rennes1.fr/18002392)
* [Léo NOLIÈRE](https://gitlab.istic.univ-rennes1.fr/lnoliere) * [Léo NOLIÈRE](https://gitlab.istic.univ-rennes1.fr/lnoliere)
* [Rémi RATIVEL](https://gitlab.istic.univ-rennes1.fr/rrativel) * [Rémi RATIVEL](https://gitlab.istic.univ-rennes1.fr/rrativel)
*Developed in the context of an end-of-year project at ISTIC (2020/2021).*