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 e4f2421c55 Optimize AABB vs AABB collision 7 gadi atpakaļ
bled ca28094553 RenderGraph: More work 8 gadi atpakaļ
docs fa002881f5 Work on the new shader program design 8 gadi atpakaļ
engine_data 4f5da4f132 Add reprojection of light accumulation 7 gadi atpakaļ
samples e4f2421c55 Optimize AABB vs AABB collision 7 gadi atpakaļ
sandbox b7c9eb834d Update the copyright year 7 gadi atpakaļ
shaders 18f06eef3f Merge pull request #44 from godlikepanos/csm 7 gadi atpakaļ
src e4f2421c55 Optimize AABB vs AABB collision 7 gadi atpakaļ
tests 78d1ac4a01 Finalize the refactoring 7 gadi atpakaļ
thirdparty @ 7fe4172a1e 7bbc42e692 Update glslang 7 gadi atpakaļ
tools adea290514 Change the assets 7 gadi atpakaļ
.appveyor.yml c32929b1f8 RenderGraph: More work 8 gadi atpakaļ
.clang-format f9b96c34dc Update clang-format and change the formatting a bit 8 gadi atpakaļ
.gitignore 8c0d0f1e3d Add more functionality to the rigid body 7 gadi atpakaļ
.gitmodules 8d2aaee2ae Fixing submodules 10 gadi atpakaļ
.travis.yml 08cd46ccb4 [UPDATE] Update glslang 8 gadi atpakaļ
AndroidManifest.xml bc81b1130b Android 12 gadi atpakaļ
CMakeLists.txt 4f5da4f132 Add reprojection of light accumulation 7 gadi atpakaļ
LICENSE 7d7a993f8e Update the copyright notice year 9 gadi atpakaļ
README.md a49d6f7a4c Push the scene stuff 7 gadi atpakaļ

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
  • libx11-xcb-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.