/ README.md
README.md
1 [](https://github.com/Letronix624/let-engine) [](https://crates.io/crates/let-engine) [](https://docs.rs/let-engine) [](https://let.software/) [](https://app.radicle.xyz/nodes/seed.let.software/rad:z35VMD8yfGYcrvb7k2eyxiUL4VUko) 2 3 # let-engine (pre-alpha) 4 5 _batteries included game engine_ 6 7 - Heavily under development. 8 - Not all core features are ready. 9 If you for some reason at all are interested in using this game engine, I recommend cloning it and when experiencing problems fix them and submit a pull request. Not everything is tested and the focus right now is to develop all features in first. 10 Please contact me, let from [let.software](https://let.software/), if you require personal support. 11 12 ## Features 13 14 - Modular backend system 15 16 - Layer based object system 17 18 - Labels and text 19 20 - Built in default networking protocol 21 22 - Built in default gpu backend 23 24 - Built in Rapier physics 25 26 - Tick System 27 28 # Installation 29 30 To add `let-engine` to your project, run this in your project directory: 31 ```bash 32 cargo add let-engine 33 ``` 34 ## Dependencies 35 ### Debian based dependencies 36 37 ```bash 38 sudo apt install -y libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev build-essential cmake libvulkan-dev libasound2-dev libfontconfig1-dev 39 ``` 40 ### Arch based dependencies 41 42 ```bash 43 sudo pacman -Sy vulkan-devel 44 ``` 45 ### Zypper based dependencies 46 47 ``` 48 sudo zypper install alsa-devel cmake 49 sudo zypper install --type pattern devel_basis devel_C_C++ devel_vulkan mingw64-cross-gcc-c++ mingw64-cross-pkgconf 50 ``` 51 52 ### Brew dependencies 53 ``` 54 brew install vulkan-headers cmake 55 ``` 56 ## Radicle 57 58 To clone this repository on [Radicle](https://radicle.xyz), simply run: 59 60 ``` 61 rad clone rad:z35VMD8yfGYcrvb7k2eyxiUL4VUko 62 ``` 63 # Examples 64 65 run by doing 66 ```bash 67 cargo run --example 68 ``` 69 ## Tip 70 For best performance compile to `release` with **this** in the `Cargo.toml` 71 72 ```toml 73 [profile.release] 74 opt-level = 3 75 lto = "fat" 76 codegen-units = 1 77 ``` 78 79 ## Minimum requirements (Client) 80 A device with Vulkan 1.2 support. 81 # Contribution 82 feel free to contribute. Go resolve some of the issues I made or take a look at this: 83 [](https://deps.rs/repo/github/Letronix624/let-engine) 84 also read [the contribution guidelines](CONTRIBUTING.md). 85 86 # Plan 87 After the first stage of my game engine is completed, this is where I will start advertising the game engine. 88 Only together this game engine can be made great. 89 90 https://crates.io/crates/let-engine