NcEngine is a 3D game engine written in C++20 targeting Windows. It is actively being developed but is still in very early stages. Features are in varying stages of completeness.
- Getting Started
- More Information
- Windows
- Vulkan SDK 1.3.211.0 or higher
- CMake 3.20
- Compiler with c++20 support:
- Visual Studio 17 2022
- MinGW-w64 9.0.0
Run CMake on the root CMakeLists with your required options:
cmake -S ./ -B build -DCMAKE_INSTALL_PREFIX=NcSdk
cmake --build build --target install --config Release
There is also a build script with optional parameters for configuring the generator and output directories:
script/build.ps1 -Generator msvc -BuildType Release
- NcEngine: Engine libraries and headers.
- To include in a CMake project use:
find_package(NcEngine PATHS install-path)and link againstNc::NcEngine-dev.
- To include in a CMake project use:
- NcEditor: Application for project creation and management.
- Application and utilities are installed to
install-path/bin.
- Application and utilities are installed to
- Sample: Application containing demo, test, and benchmark scenes.
- Installed to
install-path/sample.
- Installed to
While the default Nc::Engine-dev target can be built with a Release configuration, it still includes extra code for profiling and inspection by NcEditor that is otherwise not needed by the project itself. This can be excluded by defining NC_PROD_BUILD=ON during the CMake configure step. The target will instead be exported as Nc::Engine, and additional items, like NcEditor and the sample, will not be built. Unique build and install directories should be used when enabling and disabling this option.
Default: OFF
Include tests when building the NcSdk project.
Default: OFF
Build binaries with debug, utility, and profiling code stripped. Only NcEngine is built, and its target name is changed to 'Nc::NcEngine' (dropping the '-dev' suffix). NcEditor uses this for project release builds.
Default: ON (OFF when NC_PROD_BUILD=ON)
Flag used by both CMake and NcEngine specifying whether to include the debug editor in the final executable. Some blocks of coded required only by the editor are wrapped in #ifdefs. If this value is set to ON, it must be passed when building both the engine library and your project.
Default: ON (OFF when NC_PROD_BUILD=ON)
Enables extra checks through the NC_ASSERT macro. These are enabled by default, even in release builds, as they are unlikely to have a serious effect on performance.
Default: ON (OFF when NC_PROD_BUILD=ON)
Enabled profiling with Optick. This also requires the Optick application (https://www.optickprofiler.com) and the Optick
shared library (installed to install-prefix/bin/OptickCore.dll).
Default: 2 (1 when NC_PROD_BUILD=ON)
Flag used to control logging verbosity to the diagnostics file specified in config.ini. Set to 0, 1, or 2 for off, standard, or verbose.
To learn more: