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 7138ef050e Add IS shader permutation support 8 yıl önce
bled 66486287d3 Renderer: Optimize and correct volumetric shader 9 yıl önce
docs ba644515a2 Rearanging files around. Placing relevant files close together 9 yıl önce
engine_data d7dc76edc0 Renderer: Remove some noise from SSAO & enable shadows in volumetric 9 yıl önce
samples fafb6f0ea7 Fixes & some new cfg options 8 yıl önce
sandbox 0a2304b405 Vulkan: Rework the way of finding the image layout 9 yıl önce
shaders 7138ef050e Add IS shader permutation support 8 yıl önce
src 7138ef050e Add IS shader permutation support 8 yıl önce
tests 758c1c2e08 Vulkan: Refactor command buffer creation 8 yıl önce
thirdparty @ 40d7763bfa 8e80197411 Update newton 8 yıl önce
tools 45377710d7 Remove some ETC compression from textures 9 yıl önce
.appveyor.yml fc5d15209d Start using C++14. Fix vulkan bugs 8 yıl önce
.clang-format 839ca8b35a Major refactoring: Moved from 80 columns to 120 9 yıl önce
.gitignore e756829942 Add sponza as a sample 9 yıl önce
.gitmodules 8d2aaee2ae Fixing submodules 10 yıl önce
.travis.yml 86e1510dff Update .travis.yml 8 yıl önce
AndroidManifest.xml bc81b1130b Android 12 yıl önce
CMakeLists.txt fc5d15209d Start using C++14. Fix vulkan bugs 8 yıl önce
LICENSE 7d7a993f8e Update the copyright notice year 9 yıl önce
README.md fc5d15209d Start using C++14. Fix vulkan bugs 8 yıl önce

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 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/samples/sponza/sponza

More samples will follow.