https://github.com/michidk/vulkan-engine

A game engine writte for Vulkan in Rust
https://github.com/michidk/vulkan-engine

game-engine rust vulkan

Last synced: 12 days ago
JSON representation

A game engine writte for Vulkan in Rust

• Host: GitHub
• URL: https://github.com/michidk/vulkan-engine
• Owner: michidk
• Created: 2021-01-31T15:29:40.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-26T10:53:43.000Z (8 months ago)
• Last Synced: 2024-10-11T09:51:09.389Z (29 days ago)
• Topics: game-engine, rust, vulkan
• Language: Rust
• Homepage:
• Size: 7.34 MB
• Stars: 23
• Watchers: 5
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vulkan Engine

[![Continuous integration](https://img.shields.io/github/actions/workflow/status/michidk/vulkan-engine/ci.yaml?label=CI&style=for-the-badge)](https://github.com/michidk/vulkan-engine/actions)

This repository contains a playground project by [Jonas](https://github.com/Shemnei), [Robin](https://github.com/Rob2309), and [Michael](https://github.com/michidk) to learn the Vulkan graphics API. It uses the [Rust language](https://www.rust-lang.org/) and the [Ash](https://github.com/MaikKlein/ash) Vulkan wrapper.

## Goal

The goal is to build a somewhat usable game engine and a demo using it. While we are probably never going to implement a fully-fledged engine, we will make shortcuts to implement specific parts of it that we find interesting. It is more a learning project than anything else.

## Features

Currently implemented features are:

- A scene graph with entities and components

- Vulkan rendering

- BRDF shading and lighting

- Deferred rendering and post-processing effects

- Debug UI Layer with frame stats, scene graph and component inspectors

- `.obj` parser

- Runs on both Linux and Windows

## Screenshots

BRDF testing:

![brdf testing](/.github/images/examples/brdf.png)

Debug UI:

![debug ui](/.github/images/examples/debug-ui.png)

Custom meshes:

![custom meshes](/.github/images/examples/suzanne.png)

## Workspace

| Folder | Description | Readme |

| ---- | ----------- | - |

| [crates/engine](/crates/engine) | Main engine library | This one |

| [crates/ve_asset](/crates/ve_asset) | Utility that converts files into our custom format | [here](./crates/ve_asset/README.md) |

| [crates/ve_format](/crates/ve_format) | Stores some shared structs | [here](./crates/ve_format/README.md) |

| [crates/ve_shader_reflect](/crates/ve_shader_reflect) | Retrieves metadata from compiled shaders to feed into the material pipeline | [here](/crates/ve_shader_reflect/README.md) |

## Examples

Examples are in the [crates/engine/examples](crates/engine/examples) folder. They can be run with `cargo +nightly run --example `.

| Name | Description |

| ---- | ----------- |

| [minimal](/crates/engine/examples/minimal/) | Displays a triangle using vertex colors |

| [brdf](/crates/engine/examples/brdf/) | Renders a couple of spheres using physically-based rendering |

| [mesh](/crates/engine/examples/mesh/) | Loads and renders a custom mesh |

| [textured_material](/crates/engine/examples/textured_material/) | Creates a texture at runtime and renders it onto a quad |

| [components](/crates/engine/examples/components/) | Shows off the engine's component system |

## Building

### Prerequisites

- [Rust](https://www.rust-lang.org/) (2021 Edition)

- [Vulkan SDK](https://www.lunarg.com/vulkan-sdk/) (at least v1.2.189.2)

Build with `make build` or run an example with `make run`.

## Resources

- [Vulkan 1.2 Specs](https://www.khronos.org/registry/vulkan/specs/1.2-khr-extensions/html/index.html)

- [Vulkan Tutorial](https://vulkan-tutorial.com/Introduction)

- [Ash Documentation](https://docs.rs/ash/0.33.3/ash/)