Skip to content

lingtorp/MeineKraft

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

❗ MeineKraft ❗

MIT license

MeineKraft is a physically based rendering engine written in C++17 & OpenGL 4.6.

MeineKraft is built on a core Entity-Component-System architecture. Gameobjects in the engine is a lighweight object-oriented layer on top of the ECS core systems in order to make it slightly easier to write gameplay code while keeping the performance and data-oriented architecture intact.

📝 Blogposts on the implementation of the most interesting parts can be found here with the tag MeineKraft.

Features 🏆

  • Voxel cone tracing based global illumination
    • 3D clipmap
    • joing bilateral upsampling/filtering
    • isotropic voxels
    • emissive materials
    • (optional) opacity normalization subpass
    • second-depth shadow mapping
    • percentage-closer filtering shadow mapping
    • normal mapping
  • Physically based BRDF
  • glTF roughness, metallic material model
  • Entity-Component-System architecture
  • JSON-based configuration
  • Editor

Documentation 📝

Relevant documentation for each part of the engine is located in the /documentation folder.

Dependencies 💾

  • dear imgui - editor GUI
  • assimp - model/scene importing
  • SDL2 - window creation, input handling
  • SDL-image - image loading and conversion
  • GLEW - OpenGL function loader
  • GLM - various mathmatical utilities

Platforms supported: Windows and Linux

Build 💻

NOTE: Before continueing go to the file util/filesystem.hpp and adjust the filepaths so that they match your system.

Linux (Ubuntu 18.10)

sudo apt install libsdl2-dev libsdl2-image-dev libassimp-dev libglew-dev
cmake --build .
cmake .
./MeineKraft

Windows

Install Vcpkg

Clone Vcpkg, build it, then run.

./vcpkg install sdl2:x64-windows sdl2-image:x64-windows glew:x64-windows assimp:x64-windows

Launch CMake-GUI and select MeineKraft repository and then create a build directory and select it. Generate the Visual Studio 2017/2019 solution and simply build and run it via Visual Studio.

License 📚

The MIT License (MIT) Copyright (c) 2017 Alexander Lingtorp

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Releases

No releases published

Packages

No packages published

Languages