source: opengl-game/README.txt@ 17714b8

feature/imgui-sdl points-test
Last change on this file since 17714b8 was 17714b8, checked in by Dmitry Portnoy <dmitry.portnoy@…>, 5 years ago

Update the README and makefile to correctly setup and build vulkangame with SDL2 on Ubuntu

  • Property mode set to 100644
File size: 3.9 KB
Line 
1Installation Instructions for Linux
2---------------------------------------
3
4sudo apt-get install xorg-dev libglew-dev libglm-dev
5
6make newgame && ./newgame
7
8(Old Linux instructions for compiling game.cpp)
9-sudo apt-get install cmake xorg-dev libglew-dev libglu1-mesa-dev freeglut3-dev mesa-common-dev
10
11-Compile GLFW3 from source
12 (cmake . && make && sudo make install)
13
14Installation Instructions for OSX
15---------------------------------------
16
17brew install glew
18brew install glfw --without-shared-library
19brew install glm
20
21This should place all necessary files (or possibly symlinks to them) in
22/usr/loca/include and /usr/local/lib.
23
24Run 'xcode-select --install'
25This should make g++ check for libraries in /usr/local/
26
27If the above command gives you the following error, you should be able to move on and compile the game.
28"xcode-select: error: command line tools are already installed, use "Software Update" to install updates"
29
30make newgame && ./newgame
31
32Installation Instructions for Windows
33---------------------------------------
34
35Create lib/ and include/ folders in the root opengl-game directory you cloned.
36
37Download the pre=compiled 64bit binaries of GLFW and GLEW.
38Copy the include/GL/ and include/GLFW/ folders into your include/ folder.
39
40For GLEW, copy lib/RELEASE/Win64/glew32s.lib into your lib folder.
41For GLFW, copy lib-vc2019/glfw3.lib into your lib folder.
42
43Download GLM and copy the glm folder (the one with all the .hpp files) into the include/ folder you made above.
44GLM is a header-only library, so there is nothing to copy into the lib/ folder.
45
46Open and run NewOpenGLGame.sln in Visual Studio 2017 and run it.
47
48
49--------------------
50VULKAN INSTRUCTIOS
51--------------------
52
53Windows
54--------
55
56Create an include directory inside the opengl-game folder
57
58Download GLM and copy the glm folder into your include directory
59
60Download the 64bit pre-compiledbinaries of GLFW3
61 - Copy lib-vc2019/glfw3.lib into your lib directory
62 - Copy the whole include/GLFW directory into your include directory
63
64Download the SDL2 pre-built Windows binaries
65 - Copy the SDL2 include folder into /include and rename it SDL2
66 - Copy the contents of lib/x64 to lib
67
68Download the SDL2_image Visual C++ development libraries from https://www.libsdl.org/projects/SDL_image/
69Download the SDL2_ttf Visual C++ development libraries from https://www.libsdl.org/projects/SDL_ttf/
70(Might use SDL2_gfx later as well)
71
72Copy the 64-bit static libraries to the lib directory you created above
73
74TODO: Figure out how to do static compilation with SDL2
75
76Since I'm currently using dynamic SDL2 libraries for Windows, some DLLs from sdl2-ttf and sdl2-image
77
78Download the vulkan sdk
79 - Add the location of the Include folder to the VS2019 project properties under C/C++ -> General -> Addition Include DIrectories
80 - Add the location of the Lib folder to the VS2019 project properties under Linker -> General -> Addition Library DIrectories
81
82Linux:
83--------
84
85Download the vulkan sdk (make sure VULKAN_SDK_PATH in the makefile points to it)
86
87sudo apt-get install libxcb1-dev xorg-dev libglm-dev libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev
88
89source setup-env.sh into your current shell
90
91make vulkangame && ./vulkangame
92
93OSX
94--------
95
96Download the vulkan sdk (make sure VULKAN_SDK_PATH in the makefile points to it)
97
98brew install sdl2 sdl2_image sdl2_ttf
99
100make vulkangame && ./vulkangame
101
102REFERENCE
103----------
104
105UV coords 0 u 1 x, y, z -1 (untransformed z ranges from 0 to 1, glm::perspective seems to make the z range negative)
106 0 -------> ^
107 | |
108 v | -1 | 0 1
109 | <-----|----->
110 1 V /|
111 / |
112 1 v
113 1
114
115DEPLOYMENT
116-----------
117
118The deploy folder has an old Inno Setup script for deploying the game on Windows.
119
120I should check out IzPack. Seems to be a cross-platform solution.
Note: See TracBrowser for help on using the repository browser.