AnKi 3D Engine - Vulkan and D3D12, modern renderer, scripting, physics and more

#game-engine #gamedev #engine #3d #rendering #opengl #vulkan #glsl #hlsl #cpp

Panagiotis Christopoulos Charitos 76385eabe5 [REFACTOR] Add micro samplers skeleton 8 vuotta sitten
bled ca28094553 RenderGraph: More work 8 vuotta sitten
docs fa002881f5 Work on the new shader program design 8 vuotta sitten
engine_data 15c3f407d0 Add a font file 8 vuotta sitten
programs 9f146a3030 [OPTIMIZATION] Use a compute shader to do visibility tests on lens flares instead of occlusion queries 8 vuotta sitten
samples a08f78227c Move Dbg to the render graph 8 vuotta sitten
sandbox a08f78227c Move Dbg to the render graph 8 vuotta sitten
shaders 16eb91ffdc [FEATURE] Improve quality of gbuffer's normal map 8 vuotta sitten
src 76385eabe5 [REFACTOR] Add micro samplers skeleton 8 vuotta sitten
tests 36f98ba6a5 [REFACTOR] Use SDL's vulkan functionality. Refactor Buffer initializer. Update SDL2 8 vuotta sitten
thirdparty @ 3b16e5508d 3428187d35 [BUGFIX] Handle VK_ERROR_OUT_OF_DATE_KHR 8 vuotta sitten
tools 8bf2bcd0e0 Skeleton: More work 8 vuotta sitten
.appveyor.yml c32929b1f8 RenderGraph: More work 8 vuotta sitten
.clang-format 99bf099800 Improve and optimize SSAO. Fix dist calculation in visibility tests. Change the code format a bit 8 vuotta sitten
.gitignore 51777587ae Making everything feature complete 8 vuotta sitten
.gitmodules 8d2aaee2ae Fixing submodules 10 vuotta sitten
.travis.yml 5e947ce117 TravisCI: Try to fix the clang build 8 vuotta sitten
AndroidManifest.xml bc81b1130b Android 12 vuotta sitten
CMakeLists.txt 0f7e51a97c Make AnKi build with Visual Studio 2017 8 vuotta sitten
LICENSE 7d7a993f8e Update the copyright notice year 9 vuotta sitten
README.md b1ae14eb24 Renderer: Optimize omni shadows. CMake: Install the binaries to a dir 8 vuotta sitten

README.md

AnKi logo

AnKi 3D engine is a Linux and Windows opensource game engine that runs on OpenGL 4.5 and Vulkan 1.0 (Experimental).

Video

1 License

AnKi's license is BSD. This practically means that you can use the source or parts of the source on proprietary and non proprietary products as long as you follow the conditions of the license.

See LICENSE file for more info.

2 Building AnKi

OS Master Branch Build Status
Linux Build Status Linux
Windows Build status Windows

To checkout the source including the submodules type:

git clone --recurse-submodules https://github.com/godlikepanos/anki-3d-engine.git anki

AnKi's build system is using CMake. A great effort was made to ease the building process that's why the number of external dependencies are almost none.

2.1 On Linux

Prerequisites:

  • Cmake 2.8 and up
  • GCC 5.0 and up or Clang 3.7 and up
  • libx11-dev installed
  • [Optional] libxinerama-dev if you want proper multi-monitor support

To build the release version:

$cd path/to/anki
$mkdir build
$cd ./build
$cmake .. -DCMAKE_BUILD_TYPE=Release
$make

To view and configure the build options you can use ccmake tool or other similar tool:

$cd path/to/anki/build
$ccmake .

This will open an interface with all the available options.

2.2 On Windows

Prerequisites:

  • CMake 2.8 and up
    • Make sure you add cmake.exe to your PATH environment variable (The installer asks, press yes)
  • MinGW-w64 5.0 and up
    • MinGW has many variants. You need the POSIX version plus SEH (eg x86_64-posix-seh)
    • Install to a path without spaces (eg C:/mingw-w64)
    • Append the path where mingw's binaries are located (eg C:/mingw-w64/bin) to the PATH environment variable

To build the release version open PowerShell and type:

$cd path/to/anki
$mkdir build
$cd build
$cmake .. -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release
$mingw32-make

NOTE: If you have a better way to build on Windows please let us know.

3 Next steps

Try to build with samples enabled (search for the ANKI_BUILD_SAMPLES=ON option in your CMake GUI) and try running the sponza executable. Then you will be able to see sponza running in AnKi. All samples must run from within their directory.

$cd path/to/anki/samples/sponza
$./path/to/build/bin/sponza

More samples will follow.