source: opengl-game/docs/README.txt@ 87cfede

--------------------
CONTROLS
--------------------

Use left and right arrow keys to move your ship
Use Z and X to fire your left and right lasers at the cubes (asteroids)

--------------------
VULKAN INSTRUCTIOS
--------------------

These are the most up-to-date instructions. Use these rather than the ones
listed further down, which are for the old OpenGL version of the game

Windows
--------

Create an include directory inside the opengl-game folder

Download GLM and copy the glm folder into your include directory

Download the 64bit pre-compiledbinaries of GLFW3
 - Copy lib-vc2019/glfw3.lib into your lib directory
 - Copy the whole include/GLFW directory into your include directory

Download the SDL2 pre-built Windows binaries
 - Copy the SDL2 include folder into /include and rename it SDL2
 - Copy the contents of lib/x64 to lib

Download the SDL2_image Visual C++ development libraries from https://www.libsdl.org/projects/SDL_image/
Download the SDL2_ttf Visual C++ development libraries from https://www.libsdl.org/projects/SDL_ttf/
(Might use SDL2_gfx later as well)

Copy the 64-bit static libraries to the lib directory you created above

TODO: Figure out how to do static compilation with SDL2

Since I'm currently using dynamic SDL2 libraries for Windows, some DLLs from sdl2-ttf and sdl2-image

Download the vulkan sdk
 - Add the location of the Include folder to the VS2019 project properties under C/C++ -> General -> Addition Include DIrectories
 - Add the location of the Lib folder to the VS2019 project properties under Linker -> General -> Addition Library DIrectories

Linux:
--------

Add the Vulkan SDK repo to apt

sudo apt install build-essential vulkan-sdk libglm-dev libsdl2-dev

make vulkangame && ./vulkangame

For the sfml version: (these directions need verification)

sudo apt install libglm-dev libsfml-dev

Currently, the apt sfml package doesn't have Vulkan support, so need to install from source as follows:

Build the library yourself by following the instructions at https://www.sfml-dev.org/tutorials/2.5/compile-with-cmake.php

sudo apt install libfreetype-dev libx11-dev libxrandr-dev libudev-dev libopengl-dev libflac-dev libogg-dev libvorbis-dev libopenal-dev libpthread-stubs0-dev

sudo apt install cmake-qt-gui

Clone the sfml repo

OSX
--------

brew install cmake pkg-config glm sdl2 sdl2_image sdl2_ttf sdl2_gfx
(cmake is needed for the python script mentioned below)

Download the Vulkan SDK from https://vulkan.lunarg.com/sdk/home

Install it by running this from inside the downloaded folder:
sudo ./install_vulkan.py

make shaders
make vulkangame
./vulkangame


INSTRUCTIONS FOR THE SFML VERSION ()

OLD INSTALL INSTRUCTIONS FOR THE OpenGL version (might no longer work)
-----------------------------------------------------------------------

Installation Instructions for Linux
---------------------------------------

sudo apt install xorg-dev  libglew-dev libglm-dev libglfw3-dev

make openglref && ./openglref

(Old Linux instructions for compiling game.cpp)
-sudo apt install cmake xorg-dev  libglew-dev libglu1-mesa-dev freeglut3-dev mesa-common-dev

-Compile GLFW3 from source
 (cmake . && make && sudo make install)

Installation Instructions for OSX
---------------------------------------

brew install glew
brew install glfw --without-shared-library
brew install glm

This should place all necessary files (or possibly symlinks to them) in
/usr/loca/include and /usr/local/lib.

Run 'xcode-select --install'
This should make g++ check for libraries in /usr/local/

If the above command gives you the following error, you should be able to move on and compile the game.
"xcode-select: error: command line tools are already installed, use "Software Update" to install updates"

make newgame && ./newgame

Installation Instructions for Windows
---------------------------------------

Create lib/ and include/ folders in the root opengl-game directory you cloned.

Download the pre-compiled 64bit binaries of GLFW and GLEW.
Copy the include/GL/ and include/GLFW/ folders into your include/ folder.

For GLEW, copy lib/RELEASE/Win64/glew32s.lib into your lib folder.
For GLFW, copy lib-vc2019/glfw3.lib into your lib folder.

Download GLM and copy the glm folder (the one with all the .hpp files) into the include/ folder you made above.
GLM is a header-only library, so there is nothing to copy into the lib/ folder.

Open and run NewOpenGLGame.sln in Visual Studio 2017 and run it.



REFERENCE
----------

UV coords   0  u  1       x, y, z  -1  (untransformed z ranges from 0 to 1, glm::perspective seems to make the z range negative)
         0  ------->                ^
           |                        |
         v |                  -1    | 0   1
           |                  <-----|----->
         1 V                       /|
                                  / |
                                1   v
                                    1

DEPLOYMENT
-----------

The deploy folder has an old Inno Setup script for deploying the game on Windows.

I should check out IzPack. Seems to be a cross-platform solution.