Changeset 756162f in opengl-game for docs

Timestamp:

May 1, 2021, 6:26:44 PM (4 years ago)

Author:

Dmitry Portnoy <dportnoy@…>

Branches:

feature/imgui-sdl

Children:

9d21aac

Parents:

b8072d3 (diff), cb6fabb (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

git-author:

Dmitry Portnoy <dportnoy@…> (05/01/21 18:26:23)

git-committer:

Dmitry Portnoy <dportnoy@…> (05/01/21 18:26:44)

Message:

Merge branch 'feature/imgui-sdl' of medievaltech.com:opengl-game into feature/imgui-sdl

File:

• docs/README.txt (modified) (2 diffs)

docs/README.txt

@@ +1 @@
+--------------------
+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:
+--------
+
+Download the vulkan sdk (make sure VULKAN_SDK_PATH in the makefile points to it)
+
+sudo apt-get install libxcb1-dev xorg-dev libglm-dev libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev
+
+source setup-env.sh into your current shell
+
+mActually, I think now this should work, after following the online instructions for installing Vulkan:
+sudo apt-get install vulkan-sdk libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libglm-dev
+(Follow the instructions at https://vulkan.lunarg.com/sdk/home#linux to add the latest Vulkan SDK version to apt-get)
+(Verify that installing libvulkan-1 is not required)
+
+make vulkangame && ./vulkangame
+
+For the sfml version: (these directions need verification)
+
+sudo apt-get install libglm-dev libsfml-dev
+
+Currently, the apt-get 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-get install libfreetype-dev libx11-dev libxrandr-dev libudev-dev libopengl-dev libflac-dev libogg-dev libvorbis-dev libopenal-dev libpthread-stubs0-dev
+
+sudo apt-get 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
 ---------------------------------------
@@ -47 +141 @@
 
 
---------------------
-VULKAN INSTRUCTIOS
---------------------
-
-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:
---------
-
-Download the vulkan sdk (make sure VULKAN_SDK_PATH in the makefile points to it)
-
-sudo apt-get install libxcb1-dev xorg-dev libglm-dev libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev
-
-source setup-env.sh into your current shell
-
-Actually, I think now this should work, after following the online instructions for installing Vulkan:
-sudo apt-get install vulkan-sdk libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libglm-dev
-(Follow the instructions at https://vulkan.lunarg.com/sdk/home#linux to add the latest Vulkan SDK version to apt-get)
-(Verify that installing libvulkan-1 is not required)
-
-make vulkangame && ./vulkangame
-
-For the sfml version: (these directions need verification)
-
-sudo apt-get install libglm-dev libsfml-dev
-
-Currently, the apt-get 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-get install libfreetype-dev libx11-dev libxrandr-dev libudev-dev libopengl-dev libflac-dev libogg-dev libvorbis-dev libopenal-dev libpthread-stubs0-dev
-
-sudo apt-get install cmake-qt-gui
-
-Clone the sfml repo
-
-OSX
---------
-
-Download the vulkan sdk (make sure VULKAN_SDK_PATH in the makefile points to it)
-
-brew install sdl2 sdl2_image sdl2_ttf sdl2_gfx
-
-make vulkangame && ./vulkangame
 
 REFERENCE