Kemena3D https://kemena3d.com Open Source 3D Engine Thu, 11 Sep 2025 10:17:59 +0000 en-US hourly 1 https://wordpress.org/?v=6.9.4 https://kemena3d.com/site/wp-content/uploads/2025/05/cropped-app-icon-32x32.png Kemena3D https://kemena3d.com 32 32 Project Folder Structure https://kemena3d.com/project-folder-structure/?utm_source=rss&utm_medium=rss&utm_campaign=project-folder-structure Thu, 11 Sep 2025 09:16:59 +0000 https://kemena3d.com/?p=902 Introduction This documentation provides an overview of the folder structure generated by Kemena3D Studio when you create a new project. Upon selecting a location on your PC, the editor automatically sets up several folders and files for you. During development, it’s important to follow certain rules on how the editor manages these files, for example, placing your assets inside the Assets folder, while avoiding manual changes to the Library and Config folders. The following sections explain the purpose of each folder and how they work together to support your project. Main Folders When a new project is created, three folders are automatically generated. Do not rename or remove these folders, as the editor relies on them when reopening the project. Folder Name Description Assets The Assets folder is where you store your game resources, such as 3D models, textures, UI images, etc. Whenever the editor needs an asset, it will check this folder. If you make changes to any files here, the editor will automatically re-import them. Config The Config folder stores your project’s configuration files. These include both the editor’s settings and the publishing options used when building executables for different platforms. Library The Library folder stores all cache data, including asset metadata, thumbnails, and imported resources used by the editor. Modifying or deleting its contents may corrupt the project, so it should remain untouched. We have covered the purpose of the three main folders. Next, let’s examine their contents, including the key files and subfolders they contain. Assets The Assets folder is empty by default. You may add files by dragging them directly into the folder or, preferably, by importing them through the editor. Any changes made to this folder or its subfolders will trigger a file check event, prompting the editor to refresh its file registry and re-import any modified files. It is recommended to move or delete files using the editor itself, as it handles the process cleanly and helps prevent potential issues with your project. Config Coming soon Library If you open the Library folder (not recommended unless necessary), you will find a file named assets.json along with three folders: ImportedAssets, Metadata, and Thumbnails. The following section explains their purposes. Folder Name Description ImportedAssets Contains assets converted for editor use. The editor does not work with raw files in the Assets folder directly, but instead uses the processed versions stored here. Metadata Each asset has an associated metadata file in this folder. Metadata stores settings such as compression format, quality, and export profiles. These settings are used when importing assets from Assets into ImportedAssets, and also during packaging and publishing of the final game. Thumbnails Stores preview thumbnails for certain asset types (meshes, images, materials, particles, worlds). Not all assets will have thumbnails. File Name Description assets.json Registry file that tracks all assets in the project. Version Control When using version control (e.g., Git) for your project, you can safely exclude the ImportedAssets and Thumbnails folders, as their contents are typically large and can be regenerated by the editor when the project is opened. The remaining folders and files should be included in your repository. Note that you may need Git Large File Storage (LFS) for handling asset files, ensure that your Git server supports it.

The post Project Folder Structure first appeared on Kemena3D.

]]> Introduction

This documentation provides an overview of the folder structure generated by Kemena3D Studio when you create a new project. Upon selecting a location on your PC, the editor automatically sets up several folders and files for you.

During development, it’s important to follow certain rules on how the editor manages these files, for example, placing your assets inside the Assets folder, while avoiding manual changes to the Library and Config folders.

The following sections explain the purpose of each folder and how they work together to support your project.

Main Folders

When a new project is created, three folders are automatically generated. Do not rename or remove these folders, as the editor relies on them when reopening the project.

Folder NameDescription
AssetsThe Assets folder is where you store your game resources, such as 3D models, textures, UI images, etc. Whenever the editor needs an asset, it will check this folder. If you make changes to any files here, the editor will automatically re-import them.
ConfigThe Config folder stores your project’s configuration files. These include both the editor’s settings and the publishing options used when building executables for different platforms.
LibraryThe Library folder stores all cache data, including asset metadata, thumbnails, and imported resources used by the editor. Modifying or deleting its contents may corrupt the project, so it should remain untouched.

We have covered the purpose of the three main folders. Next, let’s examine their contents, including the key files and subfolders they contain.

Assets

The Assets folder is empty by default. You may add files by dragging them directly into the folder or, preferably, by importing them through the editor. Any changes made to this folder or its subfolders will trigger a file check event, prompting the editor to refresh its file registry and re-import any modified files.

It is recommended to move or delete files using the editor itself, as it handles the process cleanly and helps prevent potential issues with your project.

Config

Coming soon

Library

If you open the Library folder (not recommended unless necessary), you will find a file named assets.json along with three folders: ImportedAssets, Metadata, and Thumbnails. The following section explains their purposes.

Folder NameDescription
ImportedAssetsContains assets converted for editor use. The editor does not work with raw files in the Assets folder directly, but instead uses the processed versions stored here.
MetadataEach asset has an associated metadata file in this folder. Metadata stores settings such as compression format, quality, and export profiles. These settings are used when importing assets from Assets into ImportedAssets, and also during packaging and publishing of the final game.
ThumbnailsStores preview thumbnails for certain asset types (meshes, images, materials, particles, worlds). Not all assets will have thumbnails.
File NameDescription
assets.jsonRegistry file that tracks all assets in the project.

Version Control

When using version control (e.g., Git) for your project, you can safely exclude the ImportedAssets and Thumbnails folders, as their contents are typically large and can be regenerated by the editor when the project is opened. The remaining folders and files should be included in your repository.

  • ✅Assets
  • ✅Config
  • ✅Library
    • ❌ImportedAssets
    • ✅Metadata
    • ❌Thumbnails
    • ✅assets.json

Note that you may need Git Large File Storage (LFS) for handling asset files, ensure that your Git server supports it.

The post Project Folder Structure first appeared on Kemena3D.

]]> Installing MinGW via Msys2 (Windows) https://kemena3d.com/installing-mingw-via-msys2-windows/?utm_source=rss&utm_medium=rss&utm_campaign=installing-mingw-via-msys2-windows Fri, 29 Aug 2025 17:24:13 +0000 https://kemena3d.com/?p=810 Learn how to access the source code of the Kemena3D SDK, retrieve and compile its required dependencies, and build the SDK according to your specific development needs. This guide will walk you through each step to help you get up and running smoothly.

The post Installing MinGW via Msys2 (Windows) first appeared on Kemena3D.

]]> Introduction

There are several ways to install MinGW on Windows. One of the easiest methods is through MSYS2, a package management system that provides tools for installing, managing, and updating components from the GCC ecosystem on Windows. With MSYS2, you can easily set up and maintain packages such as CMake, GCC, MinGW, CPython, OpenSSL, FFmpeg, and many others, making it a more convenient option for Windows users.

Installing Msys2

Visit https://www.msys2.org and in the first step of their installation guide, click the download link (e.g. Download the installer: msys2-x86_64-20250622.exe). Install MSYS2 into your preferred folder and complete the setup process.

After that, skip the second step on their website, as it usually does not work. Instead, follow the instructions provided in the next step below.

Installing MinGW

Once the installation is complete, the installer will prompt you to run MSYS2. Click Yes to proceed. If you accidentally close it, you can launch it again from the installation folder by opening msys2.exe.

An important step that the official website does not mention is running the command:

pacman -Sy

This updates the repository list. Without this step, the installation command will fail. You may need to run the update command multiple times until no further updates are available.

Next, run the following command to install MinGW. Unlike the website’s guide, this will install the complete toolchain package set. When prompted to choose which package to install, simply press Enter to skip the selection and install everything:

pacman -S --needed base-devel mingw-w64-x86_64-toolchain

When you run the command, you’ll see an interface similar to the screenshot shown below.

Once the installation is complete, you can close MSYS2. To verify that MinGW was installed successfully, check whether the mingw folder contains files (for example: C:\msys64\mingw64\bin). If it’s not empty, the installation was successful.

Installing CMake

In addition, you can install CMake from the MSYS2 package manager if you don’t already have it installed:

pacman -S mingw-w64-x86_64-cmake

Let the process run for a while, and soon you’ll have CMake working together with MinGW

Setting System Environment Variable

On Windows, you need to add the MSYS2 MinGW path to the system PATH environment variable so that the Command Prompt can locate the MinGW and CMake executables. Navigate to Control Panel → System Properties → Environment Variables.

Afterwards, ensure that you add the proper path (e.g. C:\msys64\mingw64\bin) to the PATH environment variable, in either the System variables or User variables section.

That’s it! You can now try compiling the Kemena3D SDK or Kemena3D Studio. Happy coding!

The post Installing MinGW via Msys2 (Windows) first appeared on Kemena3D.

]]> Building Kemena3D SDK (Linux – Ubuntu) https://kemena3d.com/building-kemena3d-sdk-linux/?utm_source=rss&utm_medium=rss&utm_campaign=building-kemena3d-sdk-linux Fri, 27 Jun 2025 19:11:17 +0000 https://kemena3d.com/?p=705 Learn how to access the source code of the Kemena3D SDK, retrieve and compile its required dependencies, and build the SDK according to your specific development needs. This guide will walk you through each step to help you get up and running smoothly.

The post Building Kemena3D SDK (Linux – Ubuntu) first appeared on Kemena3D.

]]>

⚠️The SDK build process has undergone major changes, now using Python scripts instead of batch scripts. As a result, this tutorial is outdated. The documentation will be updated when time permits, thank you for your patience.

Prerequisite Software

Before getting started, make sure to install the necessary prerequisite software. This includes a compiler appropriate for your target platform, as well as Git for cloning the source code from the repository.

Operating SystemSoftware
Linux– Git and Github CLI (optional)
– GCC 14 and above (and other tools in build-essential package)
– CMake 3.10 or above
– Curl (for downloading packages)
– OpenGL development libraries (libgl1-mesa-dev libglu1-mesa-dev)
– Other linux dependencies https://github.com/libsdl-org/SDL/blob/main/docs/README-linux.md

(Note: We’re using Ubuntu for this tutorial, but the tools and dependencies should be similar across most Linux distributions. The only differences you might notice are in the screenshots, which can vary depending on the desktop environment used.)

Obtaining Source Code

To build the Kemena3D SDK from source, the first step is to obtain the SDK’s source code. You can either download an official stable release from https://kemena3d.com/downloads, or access the latest development version directly from our GitHub repository at https://github.com/leezhieng/kemena3d.

After cloning the Git repository or extracting the source code from the ZIP archive, you’ll find a directory structure containing folders such as Assets, Demo, Dependencies, Source and Tools. Below is an overview of the purpose of each folder:

FolderDescription
AssetsThis folder contains various test assets that you can use to experiment with and evaluate the engine’s features. Please note that each asset may be distributed under a different license, some may not permit use in commercial projects. Be sure to review the README file included in each asset’s folder for specific licensing details.
DemoHere you’ll find the source code for the demo projects designed to showcase Kemena3D in action. You can also download a pre-built version of the demo from our official website if you prefer to try it without building from source.
DependenciesAll external libraries required by the engine are managed here. To respect the individual licenses of these libraries, we do not include or fork them directly in the repository. Instead, we provide a shell script that automates downloading and building the necessary dependencies with configurable options for your build environment.
SourceThis folder contains the complete source code for the Kemena3D SDK, including all engine core classes. The source code for AngelScript is directly bundled in this directory, in accordance with the author’s recommendation and licensing terms, which permit redistribution.
ToolsThis folder contains a collection of tools to help you prepare and process your assets. For example skybox generator, normal map generator, image converter, and other utilities designed to streamline your asset pipeline and enhance development workflow.

(Note: This project includes only the SDK. The full editor is maintained as a separate project, which you can access at https://github.com/leezhieng/kemena3d-studio.)

Downloading and Building Dependencies

One of the most challenging aspects of building a C++ project is managing dependencies. To simplify this process, we’ve provided an easy-to-use shell script that automatically downloads and builds all required dependencies based on a few simple configuration options. You can find this script in the Dependencies folder, each supported operating system has its own version of the script.

Operating SystemShell Script
Linuxdownload_dep_linux.sh

(Note: Refers to the operating system you’re using for development, not the platform you’re targeting. For example, if you’re developing on Windows but building your project for Android, you should still run download_dep_windows.bat.)

By default, the script may not be executable because all files are treated as plain text unless explicitly marked otherwise. To make it executable, right-click the file, open the Properties window, and ensure the “Executable as Program” option is enabled.

Even after enabling the option, double-clicking the file may still not run it as a program. Instead, right-click the file and select the new “Run as a Program” option to execute it.

When you run the shell script, you’ll see an interface similar to the screenshot shown below.

(Note: If you’re coming from Windows or macOS, you might notice that Linux shell script offers only 2 options instead of 3. This is because Linux typically uses a single compiler GCC, unlike other platforms that may offer alternatives like MSVC or Xcode.)

Before proceeding with the download and compilation of dependencies, the shell script will prompt you with a few configuration options:

  1. Static or Dynamic Linking
    Decide whether to link the dependencies statically (embed all required functionality directly into the executable) or dynamically (link via SOs at runtime).
    We recommend static linking in most cases, as the licenses of the included dependencies typically allow it. However, some use cases, such as integrating with other modules under restrictive licenses (e.g., the Qt Community Edition, which doesn’t permit static linking in certain scenarios), may require dynamic linking instead.
  2. Configure Assimp Settings
    Choose how you want to configure Assimp support:
    • Include all supported 3D model formats (import and export), ideal for use in game editors or tools where broad format support is needed.
    • Enable read-only GLTF format support only, which is recommended if you want a smaller executable and only need GLTF support for runtime use.
      (Note: You can customize this option in the shell script if you need a different format besides GLTF.)

Once you’ve selected your preferred build options, the shell script will begin downloading all required dependencies, either by cloning their repositories or fetching official stable releases, and then proceed to build them based on your chosen configuration.

The entire process typically takes around 15 to 20 minutes, depending on your system and internet speed. Feel free to sit back and relax while the script takes care of the setup for you.

You may encounter some warnings during the compilation process. However, as long as the build completes without errors, these warnings can generally be ignored and won’t affect the functionality of the engine or its dependencies.

If you need to change the build configuration or perform a clean build of the dependencies, you can safely delete all subfolders inside the Dependencies directory. Then, simply re-run the shell script to start the setup process from scratch. This approach is recommended to prevent any potential configuration conflicts or build issues.

Building the SDK from Source Code

To build the Kemena3D SDK, navigate back to the root directory where you’ll find the CMakeLists.txt file, this is where all the build settings are defined. While you’re free to run CMake manually using this file, we’ve made the process easier by providing a pre-configured shell script. Just like with the dependencies, each supported operating system comes with its own version of the script for convenience.

Operating SystemShell Script
Linuxbuild_sdk_linux.sh

Just like before, you’ll be prompted to choose whether to build the SDK as a static or dynamic library. Once you’ve made your selection, the build process will begin.

This step is usually much quicker than building the dependencies. In most cases, it only takes a minute or two to complete.

After successfully completing the build process without any errors, the compiled library files will be located in the /Source/lib/Debug and /Source/lib/Release directories.

The types of files generated, such as .lib, .a, or .dll will depend on your chosen linking method (static or dynamic).

  • For static builds, you’ll typically see .lib (on Visual Studio) or .a (on MinGW, Linux, macOS).
  • For dynamic builds, you’ll see .dll on Windows and .so or .dylib on Linux/macOS, along with their corresponding import libraries (.lib or .a).

Congratulations! You’ve successfully built the Kemena3D SDK! It’s now fully ready to be integrated into your projects. Whether you’re developing a game, visualization tool, or interactive application, you can now start leveraging the full power of the engine in your development workflow.

The post Building Kemena3D SDK (Linux – Ubuntu) first appeared on Kemena3D.

]]> Building Kemena3D SDK (macOS) https://kemena3d.com/building-kemena3d-sdk-macos/?utm_source=rss&utm_medium=rss&utm_campaign=building-kemena3d-sdk-macos Fri, 27 Jun 2025 13:26:55 +0000 https://kemena3d.com/?p=651 Learn how to access the source code of the Kemena3D SDK, retrieve and compile its required dependencies, and build the SDK according to your specific development needs. This guide will walk you through each step to help you get up and running smoothly.

The post Building Kemena3D SDK (macOS) first appeared on Kemena3D.

]]>

⚠️The SDK build process has undergone major changes, now using Python scripts instead of batch scripts. As a result, this tutorial is outdated. The documentation will be updated when time permits, thank you for your patience.

Prerequisite Software

Before getting started, make sure to install the necessary prerequisite software. This includes a compiler appropriate for your target platform, as well as Git for cloning the source code from the repository.

Operating SystemSoftware
macOS– Git
– Xcode 16 or above
– Homebrew (optional, for installing CMake and GCC)
– CMake 3.10 or above
– GCC (if not using Xcode)

Obtaining Source Code

To build the Kemena3D SDK from source, the first step is to obtain the SDK’s source code. You can either download an official stable release from https://kemena3d.com/downloads, or access the latest development version directly from our GitHub repository at https://github.com/leezhieng/kemena3d.

After cloning the Git repository or extracting the source code from the ZIP archive, you’ll find a directory structure containing folders such as Assets, Demo, Dependencies, Source and Tools. Below is an overview of the purpose of each folder:

FolderDescription
AssetsThis folder contains various test assets that you can use to experiment with and evaluate the engine’s features. Please note that each asset may be distributed under a different license, some may not permit use in commercial projects. Be sure to review the README file included in each asset’s folder for specific licensing details.
DemoHere you’ll find the source code for the demo projects designed to showcase Kemena3D in action. You can also download a pre-built version of the demo from our official website if you prefer to try it without building from source.
DependenciesAll external libraries required by the engine are managed here. To respect the individual licenses of these libraries, we do not include or fork them directly in the repository. Instead, we provide a shell script that automates downloading and building the necessary dependencies with configurable options for your build environment.
SourceThis folder contains the complete source code for the Kemena3D SDK, including all engine core classes. The source code for AngelScript is directly bundled in this directory, in accordance with the author’s recommendation and licensing terms, which permit redistribution.
ToolsThis folder contains a collection of tools to help you prepare and process your assets. For example skybox generator, normal map generator, image converter, and other utilities designed to streamline your asset pipeline and enhance development workflow.

(Note: This project includes only the SDK. The full editor is maintained as a separate project, which you can access at https://github.com/leezhieng/kemena3d-studio.)

Downloading and Building Dependencies

One of the most challenging aspects of building a C++ project is managing dependencies. To simplify this process, we’ve provided an easy-to-use shell script that automatically downloads and builds all required dependencies based on a few simple configuration options. You can find this script in the Dependencies folder, each supported operating system has its own version of the script.

Operating SystemShell Script
macOSdownload_dep_mac.command

(Note: Refers to the operating system you’re using for development, not the platform you’re targeting. For example, if you’re developing on Windows but building your project for Android, you should still run download_dep_windows.bat.)

The first time you run the shell script, you might see a security warning stating that it can’t be opened. To proceed, you’ll need to manually allow it from the Privacy & Security settings page.

Go to Settings → Privacy & Security → Security and click Open Anyway.

If you still can’t run the shell script and encounter the error message shown below, you’ll need to run a terminal command to grant execution permission. This is a macOS security measure designed to protect your system.

Use the cd command to navigate to the Dependencies folder inside the Kemena3D SDK directory, then run

chmod +x download_dep_mac.command

to grant execute permission. The shell script should now be ready to run.

Run the shell script again, this time, you’ll see an interface similar to the screenshot shown below.

Before proceeding with the download and compilation of dependencies, the shell script will prompt you with a few configuration options:

  1. Select a Compiler
    Choose whether to build the dependencies using XCode or GCC. This selection must match the compiler you’re using to build your project.
  2. Static or Dynamic Linking
    Decide whether to link the dependencies statically (embed all required functionality directly into the executable) or dynamically (link via DYLIBs at runtime).
    We recommend static linking in most cases, as the licenses of the included dependencies typically allow it. However, some use cases, such as integrating with other modules under restrictive licenses (e.g., the Qt Community Edition, which doesn’t permit static linking in certain scenarios), may require dynamic linking instead.
  3. Configure Assimp Settings
    Choose how you want to configure Assimp support:
    • Include all supported 3D model formats (import and export), ideal for use in game editors or tools where broad format support is needed.
    • Enable read-only GLTF format support only, which is recommended if you want a smaller executable and only need GLTF support for runtime use.
      (Note: You can customize this option in the shell script if you need a different format besides GLTF.)

Once you’ve selected your preferred build options, the shell script will begin downloading all required dependencies, either by cloning their repositories or fetching official stable releases, and then proceed to build them based on your chosen configuration.

The entire process typically takes around 15 to 20 minutes, depending on your system and internet speed. Feel free to sit back and relax while the script takes care of the setup for you.

You may encounter some warnings during the compilation process. However, as long as the build completes without errors, these warnings can generally be ignored and won’t affect the functionality of the engine or its dependencies.

If you encounter the following error xcrun: error: unable to find utility "metal", not a developer tool or in PATH and the build fails, you’ll need to open the terminal and run this command:

sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer

That should fix the error above.

If you need to change the build configuration or perform a clean build of the dependencies, you can safely delete all subfolders inside the Dependencies directory. Then, simply re-run the shell script to start the setup process from scratch. This approach is recommended to prevent any potential configuration conflicts or build issues.

Building the SDK from Source Code

To build the Kemena3D SDK, navigate back to the root directory where you’ll find the CMakeLists.txt file, this is where all the build settings are defined. While you’re free to run CMake manually using this file, we’ve made the process easier by providing a pre-configured shell script. Just like with the dependencies, each supported operating system comes with its own version of the script for convenience.

Operating SystemShell Script
macOSbuild_sdk_mac.command

Just like before, you’ll be prompted to choose two options: the compiler you want to use and whether to build the SDK as a static or dynamic library. Once you’ve made your selections, the build process will begin.

This step is usually much quicker than building the dependencies. In most cases, it only takes a minute or two to complete.

After successfully completing the build process without any errors, the compiled library files will be located in the /Source/lib/Debug and /Source/lib/Release directories.

The types of files generated, such as .lib, .a, or .dll will depend on your chosen linking method (static or dynamic).

  • For static builds, you’ll typically see .lib (on Visual Studio) or .a (on MinGW, Linux, macOS).
  • For dynamic builds, you’ll see .dll on Windows and .so or .dylib on Linux/macOS, along with their corresponding import libraries (.lib or .a).

Congratulations! You’ve successfully built the Kemena3D SDK! It’s now fully ready to be integrated into your projects. Whether you’re developing a game, visualization tool, or interactive application, you can now start leveraging the full power of the engine in your development workflow.

The post Building Kemena3D SDK (macOS) first appeared on Kemena3D.

]]> Building Kemena3D SDK (Windows) https://kemena3d.com/building-kemena3d-sdk-windows/?utm_source=rss&utm_medium=rss&utm_campaign=building-kemena3d-sdk-windows Wed, 25 Jun 2025 06:20:41 +0000 https://kemena3d.com/?p=398 Learn how to access the source code of the Kemena3D SDK, retrieve and compile its required dependencies, and build the SDK according to your specific development needs. This guide will walk you through each step to help you get up and running smoothly.

The post Building Kemena3D SDK (Windows) first appeared on Kemena3D.

]]>

⚠️The SDK build process has undergone major changes, now using Python scripts instead of batch scripts. As a result, this tutorial is outdated. The documentation will be updated when time permits, thank you for your patience.

Prerequisite Software

Before getting started, make sure to install the necessary prerequisite software. This includes a compiler appropriate for your target platform, as well as Git for cloning the source code from the repository.

Operating SystemSoftware
Windows– Git and TortoiseGit (optional)
– Visual Studio 2022 Community Edition with “Game Development with C++” modules
– MinGW 14 or above (if not using Visual Studio)
– CMake 3.10 or above

Obtaining Source Code

To build the Kemena3D SDK from source, the first step is to obtain the SDK’s source code. You can either download an official stable release from https://kemena3d.com/downloads, or access the latest development version directly from our GitHub repository at https://github.com/leezhieng/kemena3d.

After cloning the Git repository or extracting the source code from the ZIP archive, you’ll find a directory structure containing folders such as Assets, Demo, Dependencies, Source and Tools. Below is an overview of the purpose of each folder:

FolderDescription
AssetsThis folder contains various test assets that you can use to experiment with and evaluate the engine’s features. Please note that each asset may be distributed under a different license, some may not permit use in commercial projects. Be sure to review the README file included in each asset’s folder for specific licensing details.
DemoHere you’ll find the source code for the demo projects designed to showcase Kemena3D in action. You can also download a pre-built version of the demo from our official website if you prefer to try it without building from source.
DependenciesAll external libraries required by the engine are managed here. To respect the individual licenses of these libraries, we do not include or fork them directly in the repository. Instead, we provide a batch script that automates downloading and building the necessary dependencies with configurable options for your build environment.
SourceThis folder contains the complete source code for the Kemena3D SDK, including all engine core classes. The source code for AngelScript is directly bundled in this directory, in accordance with the author’s recommendation and licensing terms, which permit redistribution.
ToolsThis folder contains a collection of tools to help you prepare and process your assets. For example skybox generator, normal map generator, image converter, and other utilities designed to streamline your asset pipeline and enhance development workflow.

(Note: This project includes only the SDK. The full editor is maintained as a separate project, which you can access at https://github.com/leezhieng/kemena3d-studio.)

Downloading and Building Dependencies

One of the most challenging aspects of building a C++ project is managing dependencies. To simplify this process, we’ve provided an easy-to-use batch script that automatically downloads and builds all required dependencies based on a few simple configuration options. You can find this script in the Dependencies folder, each supported operating system has its own version of the script.

Operating SystemBatch Script
Windowsdownload_dep_windows.bat

(Note: Refers to the operating system you’re using for development, not the platform you’re targeting. For example, if you’re developing on Windows but building your project for Android, you should still run download_dep_windows.bat.)

When you run the batch script, you’ll see an interface similar to the screenshot shown below.

Before proceeding with the download and compilation of dependencies, the batch script will prompt you with a few configuration options:

  1. Select a Compiler
    Choose whether to build the dependencies using Visual Studio 2022 Community Edition or MinGW. This selection must match the compiler you’re using to build your project.
  2. Static or Dynamic Linking
    Decide whether to link the dependencies statically (embed all required functionality directly into the executable) or dynamically (link via DLLs at runtime).
    We recommend static linking in most cases, as the licenses of the included dependencies typically allow it. However, some use cases, such as integrating with other modules under restrictive licenses (e.g., the Qt Community Edition, which doesn’t permit static linking in certain scenarios), may require dynamic linking instead.
  3. Configure Assimp Settings
    Choose how you want to configure Assimp support:
    • Include all supported 3D model formats (import and export), ideal for use in game editors or tools where broad format support is needed.
    • Enable read-only GLTF format support only, which is recommended if you want a smaller executable and only need GLTF support for runtime use.
      (Note: You can customize this option in the batch script if you need a different format besides GLTF.)

Once you’ve selected your preferred build options, the batch script will begin downloading all required dependencies, either by cloning their repositories or fetching official stable releases, and then proceed to build them based on your chosen configuration.

The entire process typically takes around 15 to 20 minutes, depending on your system and internet speed. Feel free to sit back and relax while the script takes care of the setup for you.

You may encounter some warnings during the compilation process. However, as long as the build completes without errors, these warnings can generally be ignored and won’t affect the functionality of the engine or its dependencies.

If you need to change the build configuration or perform a clean build of the dependencies, you can safely delete all subfolders inside the Dependencies directory. Then, simply re-run the batch script to start the setup process from scratch. This approach is recommended to prevent any potential configuration conflicts or build issues.

Building the SDK from Source Code

To build the Kemena3D SDK, navigate back to the root directory where you’ll find the CMakeLists.txt file, this is where all the build settings are defined. While you’re free to run CMake manually using this file, we’ve made the process easier by providing a pre-configured batch script. Just like with the dependencies, each supported operating system comes with its own version of the script for convenience.

Operating SystemBatch Script
Windowsbuild_sdk_windows.bat

Just like before, you’ll be prompted to choose two options: the compiler you want to use and whether to build the SDK as a static or dynamic library. Once you’ve made your selections, the build process will begin.

This step is usually much quicker than building the dependencies. In most cases, it only takes a minute or two to complete.

After successfully completing the build process without any errors, the compiled library files will be located in the /Source/lib/Debug and /Source/lib/Release directories.

The types of files generated, such as .lib, .a, or .dll will depend on your chosen linking method (static or dynamic).

  • For static builds, you’ll typically see .lib (on Visual Studio) or .a (on MinGW, Linux, macOS).
  • For dynamic builds, you’ll see .dll on Windows and .so or .dylib on Linux/macOS, along with their corresponding import libraries (.lib or .a).

Congratulations! You’ve successfully built the Kemena3D SDK! It’s now fully ready to be integrated into your projects. Whether you’re developing a game, visualization tool, or interactive application, you can now start leveraging the full power of the engine in your development workflow.

The post Building Kemena3D SDK (Windows) first appeared on Kemena3D.

]]>