KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #cli #open-source #ai #claude-code #codex #developer-tools #react #windows #deepseek-harness #ai-agent

Topaz

★ 32 Open GitHub ↗

C++23 Game Engine

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Topaz Engine

[![OGL Debug](https://github.com/Harrand/Topaz/actions/workflows/codebuild_opengl_debug.yml/badge.svg)](https://github.com/Harrand/Topaz/actions/workflows/codebuild_opengl_debug.yml)
[![OGL Release](https://github.com/Harrand/Topaz/actions/workflows/codebuild_opengl_release.yml/badge.svg)](https://github.com/Harrand/Topaz/actions/workflows/codebuild_opengl_release.yml)
[![VK Debug](https://github.com/Harrand/Topaz/actions/workflows/codebuild_vulkan_debug.yml/badge.svg)](https://github.com/Harrand/Topaz/actions/workflows/codebuild_vulkan_debug.yml)
[![VK Release](https://github.com/Harrand/Topaz/actions/workflows/codebuild_vulkan_release.yml/badge.svg)](https://github.com/Harrand/Topaz/actions/workflows/codebuild_vulkan_release.yml)

![Documentation](https://github.com/Harrand/Topaz/actions/workflows/documentation.yml/badge.svg)

## About

Topaz is a 3D graphics engine.
 * C++23 (no modules)
 * Very low-level declarative graphics API.
 * Supports Windows/Linux and Clang/GCC/MSVC (See requirements section below for required versions)
 
 [Topaz 4.2.0](https://github.com/Harrand/Topaz/tree/Topaz4.2) is the most recent release of the Topaz Engine. The next version is Topaz 5.0, currently in early development on the master branch.

The Topaz project has been ongoing since it began as a school project in 2015.

## Notable Features
- Low-level GPU rendering API.

## Version History
Each major version is a total rewrite and thus completely different from the previous. Each minor version typically consists of API-breaking feature changes. Patch versions are not formally shipped unless they contain emergency bugfixes for a flawed release.
| Topaz Version | Release Date | Branch      | Documentation        |
|:-------------:|:-------------|-------------|----------------------|
| 5.0			|TBD		   |[master](https://github.com/Harrand/Topaz/)	 | [harrand.github.io](https://harrand.github.io/Topaz)
| 4.2.0			|Apr 23, 2024 |	[Topaz4.2](https://github.com/Harrand/Topaz/tree/Topaz4.2)	 | [Branch: gh-pages-tz4.2](https://github.com/Harrand/Topaz/tree/gh-pages-tz4.2)
| 4.1.0			|Dec 1, 2023  |	[Topaz4.1](https://github.com/Harrand/Topaz/tree/Topaz4.1)	 | [Branch: gh-pages-tz4.1](https://github.com/Harrand/Topaz/tree/gh-pages-tz4.1)
| 4.0.0			|July 9, 2023 |	[Topaz4.0](https://github.com/Harrand/Topaz/tree/Topaz4.0)	 | [Branch: gh-pages-tz4.0](https://github.com/Harrand/Topaz/tree/gh-pages-tz4.0)
| 3.6.1			|Dec 10, 2022 |[Topaz3.6](https://github.com/Harrand/Topaz/tree/Topaz3.6)	 | [Branch: gh-pages-tz3.6](https://github.com/Harrand/Topaz/tree/gh-pages-tz3.6)
| 3.6.0			|Dec 8, 2022 |[Topaz3.6](https://github.com/Harrand/Topaz/tree/Topaz3.6)	 | [Branch: gh-pages-tz3.6](https://github.com/Harrand/Topaz/tree/gh-pages-tz3.6)
| 3.5.0			|Sep 22, 2022|[Topaz3.5](https://github.com/Harrand/Topaz/tree/Topaz3.5)	 | [Branch: gh-pages-tz3.5](https://github.com/Harrand/Topaz/tree/gh-pages-tz3.5)
| 3.4.0			|Aug 3, 2022 |[Topaz3.4](https://github.com/Harrand/Topaz/tree/Topaz3.4)| [Branch: gh-pages-tz3.4](https://github.com/Harrand/Topaz/tree/gh-pages-tz3.4)
| 3.3.0           |Jun 12, 2022|[Topaz3.3](https://github.com/Harrand/Topaz/tree/Topaz3.3)| [Branch: gh-pages-tz3.3](https://github.com/Harrand/Topaz/tree/gh-pages-tz3.3) |
| 3.2.0           |Apr 23, 2022|[Topaz3.2](https://github.com/Harrand/Topaz/tree/Topaz3.2)| [Branch: gh-pages-tz3.2](https://github.com/Harrand/Topaz/tree/gh-pages-tz3.2) |
| 3.1.0           |Feb 13, 2022|[Topaz3.1](https://github.com/Harrand/Topaz/tree/Topaz3.1)| [Branch: gh-pages-tz3.1](https://github.com/Harrand/Topaz/tree/gh-pages-tz3.1) |
| 3.0.0           |Sep 17, 2021| [Topaz3.0](https://github.com/Harrand/Topaz/tree/Topaz3.0)|[Branch: gh-pages-tz3](https://github.com/Harrand/Topaz/tree/gh-pages-tz3)|
| 2.0.0           |May 9, 2021|[Topaz2.0](https://github.com/Harrand/Topaz/tree/Topaz2.0)|[Branch: gh-pages-tz2](https://github.com/Harrand/Topaz/tree/gh-pages-tz2)|
| 1.0.0            |Sep 25, 2020|[Topaz1.0](https://github.com/Harrand/Topaz/tree/Topaz1.0)|[Branch: gh-pages-tz1](https://github.com/Harrand/Topaz/tree/gh-pages-tz1)|
<details>
<summary>More Releases</summary>

### Note: I do not recommend any of these. These are listed just for completeness.

| Topaz Version | Release Date | Release      |
|:-------------:|:-------------|--------------|
| 0.7.0			|Apr 10, 2019  |	[Raycasts, Octrees & Improved Utility](https://github.com/Harrand/Topaz/releases/tag/0.7.0)	  |
| 0.6.0			|Jul 18, 2018  |	[Shadow Mapping & Physics](https://github.com/Harrand/Topaz/releases/tag/0.6.0)	  |
| 0.5.1			|Dec 12, 2017  |	[Refactoring 1](https://github.com/Harrand/Topaz/releases/tag/0.5.1)	  |
| 0.5.0			|Oct 8, 2017  |	[Physics & Collision](https://github.com/Harrand/Topaz/releases/tag/0.5.0)	  |
| 0.4.0			|Sep 25, 2017  |	[Displacement Maps & Skyboxes](https://github.com/Harrand/Topaz/releases/tag/0.4.0)	  |
| 0.3.0			|Sep 21, 2017  |	[GUI & Flexible](https://github.com/Harrand/Topaz/releases/tag/0.3.0)	  |
| 0.2.0			|Jun 5, 2017  |	[Prettier, faster and more features](https://github.com/Harrand/Topaz/releases/tag/0.2.0)	  |
| 0.1.6			|Apr 16, 2017  |	[Skybox & Audio](https://github.com/Harrand/Topaz/releases/tag/0.1.6)	  |
| 0.1.5			|Apr 11, 2017  |	[Dynamic Lighting](https://github.com/Harrand/Topaz/releases/tag/0.1.5)	  |
| 0.1.4			|Apr 9, 2017  |	[Audio](https://github.com/Harrand/Topaz/releases/tag/0.1.4)	  |
| 0.1.3			|Mar 29, 2017  |	[World Construction](https://github.com/Harrand/Topaz/releases/tag/0.1.3)	  |
| 0.1.2			|Mar 25, 2017  |	[Hightail House Construction](https://github.com/Harrand/Topaz/releases/tag/0.1.2)	  |
| 0.1.1			|Mar 24, 2017  |	[Parallax Displacement Mapping](https://github.com/Harrand/Topaz/releases/tag/0.1.1)	  |
| 0.1.0			|Mar 21, 2017  |	[Dev Test](https://github.com/Harrand/Topaz/releases/tag/0.1)	  |
</details>

## Build Instructions
1. Checkout the repository resursively.
2. Configure CMake. It is recommended you use a preset.
	
	Example:  `cmake --preset host_vulkan_debug`
3. Build the `topaz` target to build the engine. Run the `tztest` target to build and run all unit-tests.

## Dependencies
The table below shows all the engine's dependencies.

| Dependency                                                                                |  Render API | Build Config  | Dependency Type         |
|-------------------------------------------------------------------------------------------|:-----------:|:-------------:|-------------------------|
|[Vulkan SDK](https://www.lunarg.com/vulkan-sdk/)											| Vulkan	  | All			  | Needs pre-installation	|

## Requirements
The following requirements apply for all possible build configurations:
* A C++23-compliant compiler. GCC, MSVC and Clang are all tested so you can be confident using these. If you're not using any of these compilers, your mileage may vary.
* CMake 3.21 or later is required to build.
#### Vulkan Build
* Windows or Linux.
	* macOS may be theoretically possible down-the-line via MoltenVK, but no work at all has been done or planned to provide support for it.
* Vulkan SDK 1.3 or later must be installed.

* Your graphics card must support Vulkan 1.3. [Check your graphics card here](https://vulkan.gpuinfo.org/).
	* It must also support the following vulkan extension(s):
		- VK_KHR_swapchain
		- VK_KHR_shader_non_semantic_info (debug builds only)

Topaz

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README