FOnline Engine
Current master GitHub
Documentation Docs/en/reference/cmake/options.md

CMake Project Options

Generated reference. Do not edit this page directly. Update BuildTools/cmake/ProjectInterface.json, then run python BuildTools/docs_cmake.py --write.

Reference index Canonical JSON model Generation contract

Options are declared during StartProjectGeneration() from the interface manifest. All values are CMake cache values after declaration.

See the reference index for override order.

Stable ID Option Type / value Required Default Allowed Category Description
cmake.option.FO_MAIN_CONFIG FO_MAIN_CONFIG STRING / path Yes Required - project-identity Path to the embedding project's main .fomain configuration file.
cmake.option.FO_DEV_NAME FO_DEV_NAME STRING / identifier Yes Required - project-identity Short project identifier used as the generated target and binary prefix.
cmake.option.FO_NICE_NAME FO_NICE_NAME STRING / string Yes Required - project-identity Human-readable project name used by generated applications and packages.
cmake.option.FO_GEOMETRY FO_GEOMETRY STRING / enum Yes Required HEXAGONAL, SQUARE geometry World-grid geometry mode.
cmake.option.FO_MAP_HEX_WIDTH FO_MAP_HEX_WIDTH STRING / integer Yes Required - geometry Map cell width in pixels.
cmake.option.FO_MAP_HEX_HEIGHT FO_MAP_HEX_HEIGHT STRING / integer Yes Required - geometry Map cell height in pixels.
cmake.option.FO_MAP_CAMERA_ANGLE FO_MAP_CAMERA_ANGLE STRING / number Yes Required - geometry Map camera angle in degrees.
cmake.option.FO_APP_ICON FO_APP_ICON STRING / path Yes Required - project-identity Application icon source used by generated platform targets.
cmake.option.FO_OUTPUT_PATH FO_OUTPUT_PATH STRING / path Yes Required - output Common root for generated binaries, packages, baking data, and validation output.
cmake.option.FO_CXX_STANDARD FO_CXX_STANDARD STRING / integer No 20 - toolchain C++ language standard used for project compilation; values below 20 are unsupported.
cmake.option.FO_BINARY_OUTPUT_POSTFIX FO_BINARY_OUTPUT_POSTFIX STRING / string No - output Optional postfix appended to generated binary output directory names.
cmake.option.FO_EMBEDDED_DATA_CAPACITY FO_EMBEDDED_DATA_CAPACITY STRING / integer No 200000 - capacity Capacity reserved for embedded data in generated binaries.
cmake.option.FO_EFFECT_SCRIPT_VALUES FO_EFFECT_SCRIPT_VALUES STRING / integer No 16 - rendering-shape Number of float slots in ScriptValueBuf; the value must be a multiple of four.
cmake.option.FO_EFFECT_MAX_PASSES FO_EFFECT_MAX_PASSES STRING / integer No 6 - rendering-shape Maximum number of passes in one effect.
cmake.option.FO_MODEL_LAYERS_COUNT FO_MODEL_LAYERS_COUNT STRING / integer No 30 - model-shape Number of model rendering layers compiled into the engine shape contract.
cmake.option.FO_MODEL_MAX_TEXTURES FO_MODEL_MAX_TEXTURES STRING / integer No 8 - model-shape Maximum number of textures available to one 3D model.
cmake.option.FO_MODEL_MAX_BONES FO_MODEL_MAX_BONES STRING / integer No 54 - model-shape Maximum number of bone matrices available to one 3D model.
cmake.option.FO_MODEL_BONES_PER_VERTEX FO_MODEL_BONES_PER_VERTEX STRING / integer No 4 - model-shape Number of bone influences compiled into each 3D model vertex.
cmake.option.FO_STRING_INLINE_CAPACITY FO_STRING_INLINE_CAPACITY STRING / integer No 31 - capacity Characters kept inside an engine string before it allocates; the value must be one less than a multiple of eight.
cmake.option.FO_MSAN_LIBCXX_ROOT FO_MSAN_LIBCXX_ROOT STRING / path No - toolchain Install prefix of an MSan-instrumented libc++ used by San_Memory configurations.
cmake.option.FO_MSAN_IGNORELIST FO_MSAN_IGNORELIST STRING / path No ${CMAKE_CURRENT_SOURCE_DIR}/${FO_ENGINE_ROOT}/BuildTools/sanitizers/msan-ignorelist.txt - toolchain MemorySanitizer ignorelist path.
cmake.option.FO_RESHARPER_SETTINGS FO_RESHARPER_SETTINGS STRING / path No - tooling Optional ReSharper solution settings file copied during finalization.
cmake.option.FO_ENABLE_3D FO_ENABLE_3D BOOL / boolean No OFF - feature Compile support for 3D models.
cmake.option.FO_SPARK_PARTICLES FO_SPARK_PARTICLES BOOL / boolean No OFF - feature Compile the SPARK particle baker, runtime backend, and Mapper authoring tools.
cmake.option.FO_EFFEKSEER_PARTICLES FO_EFFEKSEER_PARTICLES BOOL / boolean No OFF - feature Compile the Effekseer project compiler and runtime backend.
cmake.option.FO_NATIVE_SCRIPTING FO_NATIVE_SCRIPTING BOOL / boolean No OFF - scripting Reserve the Native scripting source-root option; the current tree has no implemented Native backend.
cmake.option.FO_ANGELSCRIPT_SCRIPTING FO_ANGELSCRIPT_SCRIPTING BOOL / boolean No OFF - scripting Compile the AngelScript scripting backend.
cmake.option.FO_MANAGED_SCRIPTING FO_MANAGED_SCRIPTING BOOL / boolean No OFF - scripting Compile the Managed C# scripting backend and embedded Mono runtime.
cmake.option.FO_MEMORY_DIAGNOSTICS FO_MEMORY_DIAGNOSTICS BOOL / boolean No OFF - profiling Enable rpmalloc occupancy statistics in regular builds; Debug and Tracy already enable them when rpmalloc is available.
cmake.option.FO_DISABLE_RPMALLOC FO_DISABLE_RPMALLOC BOOL / boolean No OFF - dependency Disable the bundled rpmalloc allocator.
cmake.option.FO_DISABLE_MONGO FO_DISABLE_MONGO BOOL / boolean No OFF - dependency Disable MongoDB backend support.
cmake.option.FO_DISABLE_SQLITE FO_DISABLE_SQLITE BOOL / boolean No OFF - dependency Disable SQLite backend support.
cmake.option.FO_DISABLE_ASIO FO_DISABLE_ASIO BOOL / boolean No OFF - dependency Disable the Asio networking backend.
cmake.option.FO_DISABLE_WEB_SOCKETS FO_DISABLE_WEB_SOCKETS BOOL / boolean No OFF - dependency Disable WebSocket transport support.
cmake.option.FO_DISABLE_NAMESPACE FO_DISABLE_NAMESPACE BOOL / boolean No OFF - native-interface Compile engine native symbols without the FOnline namespace.
cmake.option.FO_DISABLE_VULKAN FO_DISABLE_VULKAN BOOL / boolean No OFF - rendering Disable the Vulkan rendering backend.
cmake.option.FO_DISABLE_SDL_GPU FO_DISABLE_SDL_GPU BOOL / boolean No OFF - rendering Disable the SDL_GPU rendering backend.
cmake.option.FO_VERBOSE_BUILD FO_VERBOSE_BUILD BOOL / boolean No OFF - diagnostics Enable verbose FOnline build-system status output.
cmake.option.FO_BUILD_CLIENT FO_BUILD_CLIENT BOOL / boolean No OFF - target Generate client application targets.
cmake.option.FO_BUILD_SERVER FO_BUILD_SERVER BOOL / boolean No OFF - target Generate server application targets.
cmake.option.FO_BUILD_MAPPER FO_BUILD_MAPPER BOOL / boolean No OFF - target Generate mapper application targets.
cmake.option.FO_BUILD_ASCOMPILER FO_BUILD_ASCOMPILER BOOL / boolean No OFF - target Generate the AngelScript compiler application target.
cmake.option.FO_BUILD_BAKER FO_BUILD_BAKER BOOL / boolean No OFF - target Generate baker application targets.
cmake.option.FO_UNIT_TESTS FO_UNIT_TESTS BOOL / boolean No OFF - quality Generate engine unit-test targets.
cmake.option.FO_CODE_COVERAGE FO_CODE_COVERAGE BOOL / boolean No OFF - quality Generate the code-coverage configuration; this mode cannot be combined with application or unit-test build modes.
Start typing to search.