Skip to content

Backyard-Studios/Renderwerk

Repository files navigation

Logo

Renderwerk

DirectX 12 powered Game/Rendering Engine

Explore my Notes »

Issues MIT License

🎨 Features

  • Performance Profiling with tracy
  • Job System
  • Memory Tracking (with support for stl structures)
  • Logging based on spdlog

🔮 Future Plans

  • DirectX 12 Rendering
  • Mesh Shading Pipeline

🚀 Getting Started

📦 Prerequisites

🛠️ Setting up the workspace

After cloning the repository, run the following commands in the root directory (Choose the appropriate scripts for your OS):

# Windows
.\Setup.bat

This command will install the necessary dependencies and tools required to build the project. It will also generate the Visual Studio solution file.

🧹 Cleaning the workspace

If you encounter any issues with the build system, you can clean the workspace with the following commands:

# Windows
.\Clean.bat

This will remove all build artifacts, intermediate files, manually downloaded dependencies and tools. You need to run the setup script again to restore the workspace to a working state.

⌚ Profiling

If you want to profile the engine, you need to download the tracy profiler software (Look into the prerequisites section for the specific version). In order to start profiling, you first need to run the downloaded tracy executable and press "Connect". This will start listening for incoming connections. After that, you can start the engine and the profiler will automatically connect to the engine. Doing this will allow you to also profile the engine initialization process. Closing the engine, while the profiler is still connected, will also allow you to profile the shutdown process. Attaching the profiler while the engine is running is also possible, but it will not allow you to profile the initialization process.

📜 License

See LICENSE for more information.

🫱🏽‍🫲🏽 Contact

Github Discord Twitter