yer

yer

noun 1. ground 2. place

A terrain generation toolkit.

Project Status

This project is in very early stages of development. Expect missing features, lack of documentation and occasional bugs.

Roadmap for Version 1.0

• Basic editor UI.

  • 3D viewport with preview mesh.
  • Layers list.
  • Layer parameters.
  • Undo/Redo.

• Layer types:

  • Constant.
  • Noise.
  • Bitmap.
  • Summit. (hills & mountains)

• Layer masking.

  • Basic. (circle, rectangle)
  • Bitmap.
  • Height.
  • Slope.
  • Biome.

• Terrain info.

  • Height.
  • Slope.
  • Biome.

• Export to textures.

• Export to mesh.

Features

TBD

Installation

Installation for Users

Currently there are no releases for Yer. However if you have a GitHub account, you can click Actions tab, choose a dev build and download the executable for your operating system from Artifacts section below. Once you have unzipped the download there should be a single executable file, you should be able to run it directly. This is a temporary method to test the application, there will be proper releases in the future.

Developer Setup

1. Yer is built on Bevy Game Engine. Please follow OS specific setup instructions for Windows or for Linux first.

2. To create a developer setup you just need to clone the respository:

   git clone git@github.com:muhuk/yer.git

3. Run tests:

   cargo test

4. Run a development build:

   cargo run

5. Build an executable locally:

   cargo build --release --no-default-features

Usage

TBD

Contributing

Currently the best way to contribute is to get acquinted with the code and then maybe do some code reviews.

License

Yer is released under GPL version 3 or any later version.