https://github.com/shapur1234/rezcraft
Voxel engine written in rust using wgpu, supporting both native and wasm
https://github.com/shapur1234/rezcraft
engine freesoftware minecraft nix-flake parallel-computing procedural-generation rust rust-lang voxel voxel-engine voxel-game voxels wasm webgpu wgpu
Last synced: 3 months ago
JSON representation
Voxel engine written in rust using wgpu, supporting both native and wasm
- Host: GitHub
- URL: https://github.com/shapur1234/rezcraft
- Owner: Shapur1234
- License: gpl-3.0
- Created: 2023-08-26T18:29:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-11T16:03:10.000Z (about 1 year ago)
- Last Synced: 2025-07-07T14:16:21.176Z (4 months ago)
- Topics: engine, freesoftware, minecraft, nix-flake, parallel-computing, procedural-generation, rust, rust-lang, voxel, voxel-engine, voxel-game, voxels, wasm, webgpu, wgpu
- Language: Rust
- Homepage:
- Size: 13.2 MB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Rezcraft](https://shapur1234.github.io/Rezcraft-Demo/ "Link to web version (mobile controls not supported)")
- Voxel engine written in rust using wgpu
- Supports both native targets and [wasm](https://en.wikipedia.org/wiki/WebAssembly)
## Screenshots
## Features
- Parallelised world and mesh generation
- Efficient meshes using [greedy meshing](https://0fps.net/2012/06/30/meshing-in-a-minecraft-game/)
- Easily add custom textures and blocks, modify blocktypes at runtime
- Colored lighting system, sunlight
- Configurable through in-app settings
- Transparency (native only)
- Savegame system (native only)
## How to
### Installation
- Run the [web version](https://shapur1234.github.io/Rezcraft-Demo/ "Link to web version (mobile controls not supported)") without installing anything
- Precompiled binaries can be found under [releases](https://github.com/Shapur1234/Rezcraft/releases), these binaries have all assets baked into themselves, so you need no resource directory
- You can also use the included nix developement shell and packages
- To host the web version locally, use the [script](./script/run_wasm.sh) (inside a nix dev shell)
- Alternatively, if you compile `rezcraft` without the `portable` feature enabled, setup your file structure like this:
- Have the binary `rezcraft` (or `rezcraft.exe` on windows) and the `res` directory are in the same directory
- Your directory tree should look like this:
```
├── res
│ ├── block
│ │ └── ...
│ ├── icon.png
│ ├── shader
│ │ └── ...
│ └── texture
│ └── ...
└── rezcraft (rezcraft.exe on windows)
```
- - The location of the save and resource directories (defaults are `./saves` and `./res`) can be change by setting the `SAVES_PATH` and `RESOURCE_PATH` enviromental variable
### Adding custom textures and blocks
#### Textures
- Add a `.png` image to `./res/texture/`, it will be loaded after programm restart
- All texture must be square and all textures must have the same resolution
#### Blocks
- Add a `.yaml` block describing file to `./res/block/`, use one of the exisitng files as a tempalte
- Blocks and their textures, light souces, and properties such as transparency and solidness can also be edited at runtime (`Edit block` menu while paused)
### Controls
| Key | Action |
| --------------- | -------------------------------- |
| Mouse motion | Rotate camera |
| W / ArrowUp | Move forward |
| S / ArrowDown | Move back |
| A / ArrowLeft | Move left |
| D / ArrowRight | Move right |
| Space / K | Move up |
| LShift / J | Move down |
| X / MouseRight | Delete block |
| C / MouseLeft | Place block |
| V / MouseMiddle | Pick block |
| M | Reload chunk at players position |
| F5 | Save |
| F9 | Load |
| F11 | Toggle fullscreen |
| F12 | Reload settings from config file |
| Tab | Pause / Resume |
| Escape | Exit |
## Building using cargo
- Have [rust](https://www.rust-lang.org/tools/install) installed, or optionally use the included dev shelle: `nix develop`
- Pick feautres
| Feature | Description | Notes |
| ----------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------- |
| portable | Doesn't read resources (textures, shaders...) from disk, but instead bakes them into the binary | Must be enabled when compiling for `wasm` |
| save_system | Allow for saving and olding of the world | Doesn't work with `wasm` |
| rayon | Extra pararelism for loading terrain and saving | Doesn't work with `wasm` |
- Manually
- To build - `cargo build --no-default-features --release --features "Feature1 Feature2"`
- To run - `cargo run --no-default-features --release --features "Feature1 Feature2"`
- To build for wasm - `wasm-pack build --release --no-default-features --features portable --target web --features wasm_thread/es_modules`
- Using the build script
- To build for native targets - [run_native.sh](./script/run_native.sh)
- To build for wasm - [run_wasm.sh](./script/run_wasm.sh)
## Links
- Source repo - [https://github.com/Shapur1234/Rezcraft](https://github.com/Shapur1234/Rezcraft)
- Crate.io - [https://crates.io/crates/rezcraft](https://crates.io/crates/rezcraft)
## Possible plans for future updates
- Improved worldgen
- Editable controls
- Physics, improved collision detection
- Optionally bake assets into the binary
- Fancy shader effects
- Multiplayer