Welcome to Frame, a versatile 3D engine harnessing the power of OpenGL, with forthcoming support for Vulkan or DirectX 12. Designed to facilitate an immersive dive into computer graphics, Frame accepts models in OBJ format and images readable by stb (jpg, png, hdr, and more).
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What you need to build and run Frame:
- GIT - Essential for cloning the repository. You can download it here.
- Compiler - Necessary for building the project. Options include:
- Visual Studio (Community Edition is sufficient)
- Alternatives like clang or gcc
- CMake - Required for creating the build system. Download it here.
- VCPKG - Frame uses VCPKG for managing C++ libraries, it will be install automatically VCPKG GitHub.
- Ninja - Linux build presets rely on the Ninja generator. Install it from your package manager or set the generator to
Unix Makefiles.
Update the local VCPKG and other externals dependencies:
git submodule update --init --recursiveNavigate to your Frame directory and use the following commands to build the project:
cmake --preset windowsAfter setting up, you can build the project using Visual Studio or via the command line with the following command:
cmake --build --preset windows-releaseOr if you want the debug version you can use:
cmake --build --preset windows-debugNavigate to your Frame directory and use the following commands to build the project:
cmake --preset linux-releaseOr if you want the debug version:
cmake --preset linux-debugAfter setting up, you can build the project using Visual Studio or via the command line with the following command:
cmake --build --preset linux-releaseOr if you want to build the debug version:
cmake --build --preset linux-debugExplore various practical examples to get accustomed to what Frame is capable of! Check them out here.