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 e87c12d74f Add a compute clear in the renderer před 7 roky
bled ca28094553 RenderGraph: More work před 8 roky
docs fa002881f5 Work on the new shader program design před 8 roky
engine_data 218e6f245a Fix GL for MESA. Fix vulkan RADV před 7 roky
samples a09d38499d More bug fixes před 7 roky
sandbox adde53aab2 Make tracing toggleable před 7 roky
shaders e87c12d74f Add a compute clear in the renderer před 7 roky
src e87c12d74f Add a compute clear in the renderer před 7 roky
tests ddcc00bad3 Remove some unneeded parameters před 7 roky
thirdparty @ 130c472bd8 6bd730cb88 Finilize it před 7 roky
tools 4851f02db6 Format the new glsl programs před 7 roky
.appveyor.yml c32929b1f8 RenderGraph: More work před 8 roky
.clang-format f9b96c34dc Update clang-format and change the formatting a bit před 8 roky
.gitignore 6bd730cb88 Finilize it před 7 roky
.gitmodules 8d2aaee2ae Fixing submodules před 10 roky
.travis.yml 08cd46ccb4 [UPDATE] Update glslang před 8 roky
AndroidManifest.xml bc81b1130b Android před 12 roky
CMakeLists.txt 9535744401 Add tinyexpr před 7 roky
LICENSE 7d7a993f8e Update the copyright notice year před 9 roky
README.md 0ef1c4fb8f [BUGFIX] Add some more information on the build requirements před 8 roky

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
  • libxrandr-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.