vectozavr-shooter/README.md

# Shooter on self-written 3D engine

<h4>About:</h4>

Source code of simple shooter on [3Dzavr game engine](https://github.com/vectozavr/3dzavr)

![Project demonstration](img/gamePlay2.png)

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/)
[![Community Discord](https://img.shields.io/discord/788056426324426782.svg?label=discord&logo=discord)](https://discord.gg/NzSf5tyS)
![Commits](https://img.shields.io/github/last-commit/vectozavr/shooter)
[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/vectozavr/shooter)](https://www.tickgit.com/browse?repo=github.com/vectozavr/shooter)
![Issues](https://img.shields.io/bitbucket/issues-raw/vectozavr/shooter)
![Repo size](https://img.shields.io/github/repo-size/vectozavr/shooter)

<h4>Installation:</h4>
1) [Download release](https://github.com/vectozavr/shooter/releases/tag/0.1.0), [unzip it](https://www.7-zip.org) and run shooter.exe file


2) Write <b>ip</b> and <b>port</b> of server in <b>connect.txt</b> file.


3) Write <b>port</b> of the server in <b>server.txt</b> file (only for computer where the server will be running).


3) Enjoy gaming!

[<h5>Click here if you want to run the server</h3>](https://github.com/vectozavr/shooter_server)

<h4>Control:</h4>

<b>Mouse</b>, <b>Space</b>, <b>A</b>, <b>S</b>, <b>W</b>, <b>D</b> – player control.

<b>SHIFT</b> – slow motion (this ability is not infinite: its bar is next to hp)

<b>E & Q </b> or keys <b> <- -> </b> – change weapon

<b>R</b> – recharge

<b>O</b> – turn OpenGL on/off

<b>Tab</b> – turn debug mode on/off

<h4>Playing with a source code:</h4>

1) [Download and install OpenAL library](https://openal.org/downloads/) for SFML sound support (in current version you can't setup this engine without OpenAL)

2) Clone this repository

3) Open project
   
   Using [CLion](https://www.jetbrains.com/clion/) with [MinGW (32-bit)](https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/7.3.0/threads-posix/dwarf/i686-7.3.0-release-posix-dwarf-rt_v5-rev0.7z/download) compiler: open <b>CMakeList.txt</b> as a project

   Using [Visual Studio](https://visualstudio.microsoft.com/ru/): open <b>shooter.sln</b> as a project

4) Built project and run the game

Structure:
![Project demonstration](img/structure.png)

Online:
![Project demonstration](img/gamePlay4.png)

GamePlay:
![Project demonstration](img/gamePlay3.png)
![Project demonstration](img/gamePlay5.png)
![Project demonstration](img/gamePlay6.png)
![Project demonstration](img/gamePlay7.png)
![Project demonstration](img/opengl.png)
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
+								# Shooter on self-written 3D engine
 								<h4>About:</h4>
 								Source code of simple shooter on [3Dzavr game engine](https://github.com/vectozavr/3dzavr)
 								![Project demonstration](img/gamePlay2.png)
-												readme changing

											
										
										
											2021-10-25 13:27:24 +03:00
+								[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/)
 								[![Community Discord](https://img.shields.io/discord/788056426324426782.svg?label=discord&logo=discord)](https://discord.gg/NzSf5tyS)
 								![Commits](https://img.shields.io/github/last-commit/vectozavr/shooter)
-												Huge refactoring v3

											
										
										
											2021-10-30 11:24:19 +03:00
+								[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/vectozavr/shooter)](https://www.tickgit.com/browse?repo=github.com/vectozavr/shooter)
-												readme changing

											
										
										
											2021-10-25 13:27:24 +03:00
+								![Issues](https://img.shields.io/bitbucket/issues-raw/vectozavr/shooter)
 								![Repo size](https://img.shields.io/github/repo-size/vectozavr/shooter)
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												update readme file

											
										
										
											2022-07-21 05:53:29 +03:00
+								<h4>Installation:</h4>
 ) [Download release](https://github.com/vectozavr/shooter/releases/tag/0.1.0), [unzip it](https://www.7-zip.org) and run shooter.exe file
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												add to readme new compiled version of game.

											
										
										
											2021-10-23 17:40:22 +03:00
+) Write <b>ip</b> and <b>port</b> of server in <b>connect.txt</b> file.
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												add to readme new compiled version of game.

											
										
										
											2021-10-23 17:40:22 +03:00
+) Write <b>port</b> of the server in <b>server.txt</b> file (only for computer where the server will be running).
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
 ) Enjoy gaming!
-												refactor

											
										
										
											2022-07-19 14:07:41 +03:00
+								[<h5>Click here if you want to run the server</h3>](https://github.com/vectozavr/shooter_server)
-												readme changing

											
										
										
											2021-10-25 04:42:24 +03:00
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
+								<h4>Control:</h4>
-												small refactoring

											
										
										
											2022-02-23 17:29:42 +03:00
+								<b>Mouse</b>, <b>Space</b>, <b>A</b>, <b>S</b>, <b>W</b>, <b>D</b> – player control.
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												small refactoring

											
										
										
											2022-02-23 17:29:42 +03:00
+								<b>SHIFT</b> – slow motion (this ability is not infinite: its bar is next to hp)
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												small refactoring

											
										
										
											2022-02-23 17:29:42 +03:00
+								<b>E & Q </b> or keys <b> <- -> </b> – change weapon
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												small refactoring

											
										
										
											2022-02-23 17:29:42 +03:00
+								<b>R</b> – recharge
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												small refactoring

											
										
										
											2022-02-23 17:29:42 +03:00
+								<b>O</b> – turn OpenGL on/off
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												small refactoring

											
										
										
											2022-02-23 17:29:42 +03:00
+								<b>Tab</b> – turn debug mode on/off
 								<h4>Playing with a source code:</h4>
-												add structure.png file

											
										
										
											2021-09-20 13:54:09 +03:00
-												Code refactoring.

											
										
										
											2021-10-17 12:03:03 +03:00
+) [Download and install OpenAL library](https://openal.org/downloads/) for SFML sound support (in current version you can't setup this engine without OpenAL)
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												Code refactoring.

											
										
										
											2021-10-17 12:03:03 +03:00
+) Clone this repository
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												Code refactoring.

											
										
										
											2021-10-17 12:03:03 +03:00
+) Open project
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												add to readme new compiled version of game.

											
										
										
											2021-10-23 17:47:25 +03:00
+								   Using [CLion](https://www.jetbrains.com/clion/) with [MinGW (32-bit)](https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/7.3.0/threads-posix/dwarf/i686-7.3.0-release-posix-dwarf-rt_v5-rev0.7z/download) compiler: open <b>CMakeList.txt</b> as a project
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												add to readme new compiled version of game.

											
										
										
											2021-10-23 17:47:25 +03:00
+								   Using [Visual Studio](https://visualstudio.microsoft.com/ru/): open <b>shooter.sln</b> as a project
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												Code refactoring.

											
										
										
											2021-10-17 12:03:03 +03:00
+) Built project and run the game
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
-												small refactoring

											
										
										
											2022-02-23 17:29:42 +03:00
+								Structure:
 								![Project demonstration](img/structure.png)
-												Initial commit

											
										
										
											2021-09-13 15:53:43 +03:00
 								Online:
 								![Project demonstration](img/gamePlay4.png)
 								GamePlay:
 								![Project demonstration](img/gamePlay3.png)
 								![Project demonstration](img/gamePlay5.png)
 								![Project demonstration](img/gamePlay6.png)
 								![Project demonstration](img/gamePlay7.png)
-												OpenGL graphics acceleration support!

											
										
										
											2021-10-22 19:42:32 +03:00
+								![Project demonstration](img/opengl.png)