Skip to content

Letronix624/let-engine

Repository files navigation

GitHub Workflow Status (with event) Crates.io Static Badge Website Static Badge

Let Engine

simple game engine

  • Heavily under development.
  • Not all features are ready. The development phase is Alpha.
  • When using this game engine now I recommend cloning it and when experiencing problems fix them and submit a pull request. Because the stage is Alpha not everything is tested. The focus right now is to push all the features I need.

Facts and features

  • Layer based object system

  • Labels and text

  • Custom shader support (limited)

  • Egui support as a feature

  • Rapier Physics

  • Tick System

Progress

To do:

  • 3D layers

  • Post processing

  • Serialisation, Deserialisation with Serde

  • Better labels with text edit and caret

Installation

Command line:

cargo add let_engine

Debian based dependencies

sudo apt install -y libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev build-essential cmake libvulkan-dev libasound2-dev libfontconfig1-dev

Arch based dependencies

sudo pacman -Sy vulkan-devel

Zypper based dependencies

sudo zypper install alsa-devel cmake
sudo zypper install --type pattern devel_basis devel_C_C++ devel_vulkan mingw64-cross-gcc-c++ mingw64-cross-pkgconf

Radicle

To clone this repository on Radicle, simply run:

rad clone rad:z35VMD8yfGYcrvb7k2eyxiUL4VUko

Examples

run by doing

cargo run --example pong / circle / egui

Tips

For best performance compile to release with this in the Cargo.toml

[profile.release]
opt-level = 3
lto = "fat"
codegen-units = 1

Minimum requirements (Client)

A graphics driver with Vulkan 1.2 support.

Contribution

feel free to contribute. Go resolve some of the issues I made or take a look at this: dependency status also read the contribution guidelines.

Plan

Once all planned features have been implemented, the code looks acceptable, the performance is acceptable and when I am happy with the format I will release 1.0.0.

After the first stage of my game engine is completed, this is where I will start advertising the game engine. Only together this game engine can be made great.

https://crates.io/crates/let-engine