Changes in docs/README.txt [cb6fabb:7865c5b] in opengl-game


Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed

  • docs/README.txt

    rcb6fabb r7865c5b  
    1 --------------------
    2 VULKAN INSTRUCTIOS
    3 --------------------
    4 
    5 These are the most up-to-date instructions. Use these rather than the ones
    6 listed further down, which are for the old OpenGL version of the game
    7 
    8 Windows
    9 --------
    10 
    11 Create an include directory inside the opengl-game folder
    12 
    13 Download GLM and copy the glm folder into your include directory
    14 
    15 Download the 64bit pre-compiledbinaries of GLFW3
    16  - Copy lib-vc2019/glfw3.lib into your lib directory
    17  - Copy the whole include/GLFW directory into your include directory
    18 
    19 Download the SDL2 pre-built Windows binaries
    20  - Copy the SDL2 include folder into /include and rename it SDL2
    21  - Copy the contents of lib/x64 to lib
    22 
    23 Download the SDL2_image Visual C++ development libraries from https://www.libsdl.org/projects/SDL_image/
    24 Download the SDL2_ttf Visual C++ development libraries from https://www.libsdl.org/projects/SDL_ttf/
    25 (Might use SDL2_gfx later as well)
    26 
    27 Copy the 64-bit static libraries to the lib directory you created above
    28 
    29 TODO: Figure out how to do static compilation with SDL2
    30 
    31 Since I'm currently using dynamic SDL2 libraries for Windows, some DLLs from sdl2-ttf and sdl2-image
    32 
    33 Download the vulkan sdk
    34  - Add the location of the Include folder to the VS2019 project properties under C/C++ -> General -> Addition Include DIrectories
    35  - Add the location of the Lib folder to the VS2019 project properties under Linker -> General -> Addition Library DIrectories
    36 
    37 Linux:
    38 --------
    39 
    40 Download the vulkan sdk (make sure VULKAN_SDK_PATH in the makefile points to it)
    41 
    42 sudo apt-get install libxcb1-dev xorg-dev libglm-dev libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev
    43 
    44 source setup-env.sh into your current shell
    45 
    46 mActually, I think now this should work, after following the online instructions for installing Vulkan:
    47 sudo apt-get install vulkan-sdk libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libglm-dev
    48 (Follow the instructions at https://vulkan.lunarg.com/sdk/home#linux to add the latest Vulkan SDK version to apt-get)
    49 (Verify that installing libvulkan-1 is not required)
    50 
    51 make vulkangame && ./vulkangame
    52 
    53 For the sfml version: (these directions need verification)
    54 
    55 sudo apt-get install libglm-dev libsfml-dev
    56 
    57 Currently, the apt-get sfml package doesn't have Vulkan support, so need to install from source as follows:
    58 
    59 Build the library yourself by following the instructions at https://www.sfml-dev.org/tutorials/2.5/compile-with-cmake.php
    60 
    61 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
    62 
    63 sudo apt-get install cmake-qt-gui
    64 
    65 Clone the sfml repo
    66 
    67 OSX
    68 --------
    69 
    70 brew install cmake pkg-config glm sdl2 sdl2_image sdl2_ttf sdl2_gfx
    71 (cmake is needed for the python script mentioned below)
    72 
    73 Download the Vulkan SDK from https://vulkan.lunarg.com/sdk/home
    74 
    75 Install it by running this from inside the downloaded folder:
    76 sudo ./install_vulkan.py
    77 
    78 make shaders
    79 make vulkangame
    80 ./vulkangame
    81 
    82 
    83 INSTRUCTIONS FOR THE SFML VERSION ()
    84 
    85 OLD INSTALL INSTRUCTIONS FOR THE OpenGL version (might no longer work)
    86 -----------------------------------------------------------------------
    87 
    881Installation Instructions for Linux
    892---------------------------------------
    … …  
    13447
    13548
     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
     91Actually, I think now this should work, after following the online instructions for installing Vulkan:
     92sudo apt-get install vulkan-sdk libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libglm-dev
     93(Follow the instructions at https://vulkan.lunarg.com/sdk/home#linux to add the latest Vulkan SDK version to apt-get)
     94(Verify that installing libvulkan-1 is not required)
     95
     96make vulkangame && ./vulkangame
     97
     98For the sfml version: (these directions need verification)
     99
     100sudo apt-get install libglm-dev libsfml-dev
     101
     102Currently, the apt-get package doesn't have Vulkan support, so need to install from source as follows:
     103
     104Build the library yourself by following the instructions at https://www.sfml-dev.org/tutorials/2.5/compile-with-cmake.php
     105
     106sudo apt-get install libfreetype-dev libx11-dev libxrandr-dev libudev-dev libopengl-dev libflac-dev libogg-dev libvorbis-dev libopenal-dev libpthread-stubs0-dev
     107
     108sudo apt-get install cmake-qt-gui
     109
     110Clone the sfml repo
     111
     112OSX
     113--------
     114
     115Download the vulkan sdk (make sure VULKAN_SDK_PATH in the makefile points to it)
     116
     117brew install sdl2 sdl2_image sdl2_ttf sdl2_gfx
     118
     119make vulkangame && ./vulkangame
    136120
    137121REFERENCE
Note: See TracChangeset for help on using the changeset viewer.