ZieIony/Ghurund

My DirectX 12 playground - an engine and a bunch of tools and samples.

★ 96Forks 8C++GitHub ↗Compare
box2ddirectxdirectx12enginegame-enginehlslphysxuiwindows-11xaudio2

README

GhurundEngine

My DirectX 12 playground.

Engine

It's written in C++ and HLSL. Uses DirectX 12, PhysX and WinAPI. It's a fourth iteration after one OpenGL engine, one DX9 and one DX11.

It was never meant to be the most performant - I'm more interested in writing clean, object-oriented code, learning things, and just having fun. That's why Ghurund contains many small debug tools, and unit tests. I wrote a couple of small games using Ghurund, but that's also not my goal. I enjoy programming in C++, learning 3D graphics, physics, etc. It's really handy to have my own project for that, that can be quickly set up to test certain things, like atmospheric scattering shaders.

I'm using WinAPI and MSVC-specific features in this project, so you won't be able to compile it with GCC nor run it without Windows.

Apps
  • Editor - the editor for Ghurund, wip.
  • Messenger - a simple text messenger using Ghurund's networking.
  • Preview - a simple resource viewer for Ghurund resources.
Samples

A couple of demos and samples, mostly for checking whether the project compiles and runs fine.

Tests

Unit tests for Ghurund features. Tests also include performance tests, compilation tests, and other tests that aren't really 'unit'.

Tools
  • BindingGenerator - generates bindings for UI widgets.
  • ShaderCompiler - compiles shader files using Ghurund to quickly validate shader code correctness.
  • SystemInfo - prints info about detected CPU, GPU, memory and display modes.

Compilation

To build your own version you need the following tools:

Knowledge sources

Documentation and samples
Blogs and tutorials
Books

License

MIT License

Copyright (c) 2018 Marcin Korniluk 'Zielony'

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Contributors

ZieIony

Issues