diff --git a/README.md b/README.md index 9873144..e2303d9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,102 @@ -# P3 -Proyecto 3 +# **Holy Spoons** | [*web*](https://dimateos.github.io/Holy_Spoons/) | [*video*](https://www.youtube.com/watch?v=IQfUdBuVHcc) | [*download*](https://mega.nz/#!41AlQS7I!-GBgQ_hPpN0wz3wzfsZMJC6KHxTzsjtobD_sylzSjn8) + +[![title](readme/title.png)](https://dimateos.github.io/Holy_Spoons/) + +## Please go ahead and check out: +* Our awesome [*web*](https://dimateos.github.io/Holy_Spoons/)! +* Our epic [*video*](https://www.youtube.com/watch?v=IQfUdBuVHcc) (Gameplay Reveal): +* Download the last [*build*](https://mega.nz/#!41AlQS7I!-GBgQ_hPpN0wz3wzfsZMJC6KHxTzsjtobD_sylzSjn8) + +# NapTime Studios +> *Done for the P3 (Project 3) subject during our third year at [UCM Madrid](https://informatica.ucm.es/) (university)* + +![logo](readme/logo.png) + +* Diego Baratto - [DiegoBV](https://github.com/DiegoBV) `dbaratto@ucm.es` +* Juan Barea - [JuBarea](https://github.com/JuBarea) `​jubarea@ucm.es` +* Lluis Cañellas - [LluisCS](https://github.com/LluisCS) `​​lluiscan@ucm.es` +* Diego Mateos - [dimateos](https://github.com/dimateos) `dimateos@ucm.es` +* Jorge Rodríguez - [jorgerodrigar](https://github.com/jorgerodrigar) `jorger09@ucm.es` +* Gonzalo Sanz - [gonzsa04](https://github.com/gonzsa04) `gonzsa04@ucm.es` + +## Dependencies *(made with)* +* [NVIDIA PhysX SDK 4.0](https://github.com/NVIDIAGameWorks/PhysX) +* [Ogre3D](https://www.ogre3d.org/) +* [Irrklang](https://www.ambiera.com/irrklang/) +* [JSON for Modern C++](https://nlohmann.github.io/json/) + + +## Gameplay +> *A fast paced 3d bullethell with mokeys* + +Holy Spoons is a fast-paced arena shooter in which you'll have to survive endless rounds of challenging enemies to achive a high score and save the world. Featuring 3 diferent worlds with several different enemies and champions variations and a Rogue-like upgrade system. + +![gameplay](docs/images/Upgrades.png) + +### Levels +![levels](readme/levels.png) + +### Enemies +![enemies](readme/enemies.png) + +### Guns +![weapons](readme/weapon.png) + +### Power Ups +![powerups](readme/powerups.png) + +### Leader board +> sweet jojoffline leaderboard (name wrote at `/user/config.json`) +> +![leaderb](docs/images/LeaderBoard.png) + + +## Controls + +You can edit them + some options at `/user/config.json` + +```json +{ + "name": "Paco", + + "controls": [ + { "FORWARD": "w" }, #movement + { "BACKWARD": "s" }, + { "LEFT": "a" }, + { "RIGHT": "d" }, + + { "FIRST": "1" }, #weapons + { "SECOND": "2" }, + { "THIRD": "3" }, + + { "PAUSE": "p" }, #actions + { "JUMP": "space" }, + { "RUN": "shift" } + ], + + "camera": [ + { "cam_fovY": 90.00 }, #sens + shoot w/ left mouse + { "cam_sensX": 1.25 }, + { "cam_sensY": 1.25 } + ], + + "holding": [ + { "hold_zoom": true }, #toggling options + { "hold_sprint": true } + ], + + "sound": [ + { "sound_music": 1.0 }, #audio (actually not implemented in the end) + { "sound_sfx": 1.0 } + ], + + "appConfigPath": "./Assets/globalCFG.json" #dev stuff +} + +``` + +## Documentation ***(in Spanish)*** + +At `/hitos` you can check all the pdf documents and our milestones presentations we had to make. + +* You also got architecture, design and pitch docs, etc... diff --git a/hitos/Readme.md b/hitos/Readme.md index fd26d3b..be93422 100644 --- a/hitos/Readme.md +++ b/hitos/Readme.md @@ -1,3 +1,5 @@ -Controles: -WASD, Espacio - Movimiento del jugador -Boton izq - disparar \ No newline at end of file +## Documentation ***(in Spanish)*** + +At `/hitos` you can check all the pdf documents and our milestones presentations we had to make. + +* You also got architecture, design and pitch docs, etc... diff --git a/readme/enemies.png b/readme/enemies.png new file mode 100644 index 0000000..af4601c Binary files /dev/null and b/readme/enemies.png differ diff --git a/readme/levels.png b/readme/levels.png new file mode 100644 index 0000000..b5584fe Binary files /dev/null and b/readme/levels.png differ diff --git a/readme/logo.png b/readme/logo.png new file mode 100644 index 0000000..f895b57 Binary files /dev/null and b/readme/logo.png differ diff --git a/readme/powerups.png b/readme/powerups.png new file mode 100644 index 0000000..1bc0b90 Binary files /dev/null and b/readme/powerups.png differ diff --git a/readme/title.png b/readme/title.png new file mode 100644 index 0000000..74e9bf6 Binary files /dev/null and b/readme/title.png differ diff --git a/readme/weapon.png b/readme/weapon.png new file mode 100644 index 0000000..2dfc0de Binary files /dev/null and b/readme/weapon.png differ