Onyx is a Vulkan-based C++ engine designed for high-performance and volumetric terrain (voxel). Work on it started in 2022, with most progress happening in 2024 during my Twitch streams. The goal is to make it a lightweight, user-friendly, and fast game engine.

This engine is still actively being developed, and as such, the code provided is not guaranteed to be fully functional or free of bugs. Expect ongoing changes and improvements as the project evolves.

It currently only runs on Windows as there are now native window implementations for other platforms.

Core pillars for the design of Onyx.

• Bindless Vulkan renderer.
• Fully data-driven design using node-graph editor.
• Enforced asynchronous asset loading.
• Volumetric Chunk streaming for massive worlds.
• Engine architecture for easy extensibility.

Onyx Engine Installation Guide

Requirements & Dependencies

To successfully build and run Onyx, ensure the following software and tools are installed:

Required Tools

1. CMake

   • Version: 3.28 or higher
   • Download CMake

2. Vulkan SDK

   • Version: 1.3 or higher
   • Additional Requirements:
     During Vulkan SDK installation, ensure the following components are selected:
     • SDK 32-bit Core Components
     • Shader Toolchain Debug Symbols 64-bit
     • Shader Toolchain Debug Symbols 32-bit
   • Download Vulkan SDK

3. C++ Compiler

   • Standard: C++23 or higher
   • Examples:
     • Microsoft Visual Studio
       • The free Community Edition includes the MSVC compiler with C++20 support.
     • GCC (GNU Compiler Collection)
       • Install GCC 11+ from the GCC Installation Guide.
       • Windows users can install GCC via WSL for a Linux-like environment.

Obtain the Source Code

Option 1: Download the ZIP File

You can download the source code directly from the GitHub repository as a ZIP file:

1. Go to the repository's GitHub page.
2. Click the Code button, then select Download ZIP.
3. Extract the downloaded ZIP file to a directory of your choice.

Option 2: Clone the Repository with Git

If you prefer to use Git, clone the repository to your local system with the following command:

git clone https://github.com/Ak-Elements/Onyx.git Onyx
cd Onyx

TIP: If you are unfamiliar with the command line, you can use one of the Git clients for your platform. Refer to the platform-specific build instructions for further details on those.

Build Instructions

Follow the steps to configure, and build the Onyx engine depending on your platform.

• Windows Build Instructions
• Linux Build Instructions
• macOS Build Instructions

Additional Notes

• A GPU with Vulkan support is required.
• Contributions and issues can be tracked on the repository's GitHub page.

License

Required Notice: Copyright AkElements

This repository is licensed under the PolyForm Noncommercial License 1.0.0 https://polyformproject.org/licenses/noncommercial/1.0.0/

For questions regarding the license or if you would like to have a more permissive license feel free to contact me. (akelements.dev@gmail.com)