procedural-generation-2

KO | EN

gitlite — search

#python #react #typescript #golang #machine-learning #rust #deep-learning #linux #nodejs #windows #cli #kubernetes #pytorch #mcp

procedural-generation-2

(★ 88)

A small Bevy project that procedurally generates a 2D pixel art landscape.

procedural-generation-2 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Procedural Generation Project 2

This repository contains basic generation logic for a 2D, pixel art, tile set-based world. It was written in Rust,
using Bevy engine (v0.19). The purpose of this project was to familiarise myself a little more with Rust and
procedural generation. It's a follow-up on my first attempt to learn
Rust, [Rusteroids](https://github.com/kimgoetzke/rusteroids),
and my first, non-Rust procedural generation
project, [Procedural Generation Project 1](https://github.com/kimgoetzke/procedural-generation-1).
You will neither find advanced concepts of Rust being applied (correctly) here nor advanced procedural generation
techniques.

## Demo

[![YouTube - Demo](https://img.youtube.com/vi/Y6WG1mbpJhg/0.jpg)](https://www.youtube.com/watch?v=Y6WG1mbpJhg)
![Screenshot 8](https://raw.githubusercontent.com/kimgoetzke/procedural-generation-2/main/assets/ignore/screenshot8.jpg)
![Screenshot 9](https://raw.githubusercontent.com/kimgoetzke/procedural-generation-2/main/assets/ignore/screenshot9.jpg)
![Demo GIF 5](https://raw.githubusercontent.com/kimgoetzke/procedural-generation-2/main/assets/ignore/demo5.gif)
![Demo GIF 7](https://raw.githubusercontent.com/kimgoetzke/procedural-generation-2/main/assets/ignore/demo7.gif)
![Demo GIF 6](https://raw.githubusercontent.com/kimgoetzke/procedural-generation-2/main/assets/ignore/demo6.gif)
![Demo GIF 2](https://raw.githubusercontent.com/kimgoetzke/procedural-generation-2/main/assets/ignore/demo2.gif)

## Features

- Generates an infinite and animated, 2D pixel art world that is fully deterministic
- Executes generation processes asynchronously (excluding entity spawning, of course)
- Terrain generation:
    - Uses **multi-fractal Perlin noise** to generate terrain layers
    - Features 3 biomes (dry, moderate, humid), each with 5 terrain types (water, shore, and three land layers e.g.
      sand/grass/forest)
    - Each terrain type supports 16 different tile types, many with transparency allowing for smooth
      transitions and layering
    - Uses a chunk-based approach (as can be seen in the GIFs)
    - Employs **contextual layers** (`Metadata`) to make chunks context aware, allowing for gradual elevation
      changes over great distances and inter-chunk biome changes without reducing generation performance
- Object generation:
    - Uses a basic **A\* pathfinding** algorithm implementation to generate paths crossing multiple chunks
    - Generates 3 modular building types - each allowing for different door locations, and window/roofs styles - in
      settled areas along paths
    - Uses the **wave function collapse** algorithm to generate additional decorative objects such as trees, ruins,
      stones, etc.
    - Supports multi-tile objects and connected objects, the rules for which are expressed in `.toml` files -
      for example, ruins can span multiple tiles and span over multiple terrain types
- Features 32x32px sprites (or sprites that fit within a 32x32px grid) that were created by me
- `bevy-inspector-egui` plugin to play around with the generation parameters at runtime
- `iyes_perf_ui` plugin for performance metrics in an overlay

## Attribution

- Art work is somewhat inspired by [sanctumpixel](https://sanctumpixel.itch.io/)'s style
- All sprites were created by myself and are available under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)

## How to use

> [!NOTE]
> When you start the application, the default settings will result in no land or objects being spawned at the
> origin `cg(0, 0)`, so you'll have to move the camera in any direction to see something.

- `A`/`D`/`W`/`S` to move the camera
- Hold `Shift` to move camera faster
-  `PageUp`/`PageDown` or use mouse wheel to zoom in/out
- `T`/`F6` to reset the camera's zoom level (and rotation) but not its position
- `R`/`F5` to regenerate the world with the current settings
- `Right Click` a tile to show and log its debug info
- `F1` to toggle world inspector UI
- `F2` to toggle settings
- `F11` to toggle fullscreen/windowed mode
- `Z` to toggle performance metrics overlay
- `X` to toggle debug gizmos
- `C` to toggle tile debug info being displayed

## How to develop

### Looking at the codebase for the first time or haven't looked at it in a while?

- Start with the `GenerationStage` enum in conjunction with the `world_generation_system` in `GenerationPlugin` which is
  driving the generation process
- The terrain/world generation which generates chunks and tiles sits in `crate::generation::world`
- The object generation which generates paths and decorative objects placed on the terrain lives in
  `crate::generation::object`
- Resources used for both of the above can be found in `crate::generation::resources`
- Structs and enums used across multiple modules sit in `crate::generation::lib`

### Using Nix Flakes, JetBrains RustRover & Direnv

You can run this project in any way you like, but I have set things up to make it easy to develop using JetBrains
RustRover. For this, you'll need:

- `direnv`
- Any Direnv integration plugin e.g. https://plugins.jetbrains.com/plugin/15285-direnv-integration
- `nix`

This way, you'll just need to `direnv allow` in the project directory after which all prerequisites (incl. Rust, Cargo,
all Bevy dependencies, etc.) will be available to you. The JetBrains plugin will ensure that the environment is
available to your IDE and you can run the project from there (vs `cargo build` and `cargo run` in the terminal).

##### How to deal with RustRover making problems again

RustRover forgetting where the Rust standard library is?

```
find /nix/store -type d -name rust_lib_src
```

### Using Nix Flakes

Without `direnv`, you can use the Nix Flake by running `nix develop` in the project directory. If you want to use an IDE
such as JetBrains RustRover, you'll have to set up the environment manually. You'll most likely have to make
`LD_LIBRARY_PATH` available to your IDE.

Upgrade the flake by running `nix flake update` in the repository's base directory.

### Reminders

#### How to add decorative object sprite assets

1. Add the sprite to the relevant sprite sheet in `assets/objects/`
2. Add a new option to the `ObjectName` enum
3. Optional: Add the object name to the `any.terrain.ruleset.toml` file (top, right, bottom, left) if it can be placed
   next to
   a tile that contains no object (i.e. `ObjectName::Empty`)
4. Add the object name to the `all.tile-type.ruleset.toml` file (like just `Fill`) to the relevant `TileType`s on which
   the object can be placed
5. Add a new state to the relevant `{terrain}.terrain.ruleset.toml` file using the index from the sprite sheet
    - Make sure provide of permitted neighbours (even if just `Empty` on all sides)
    - Make sure the permitted neighbours themselves list the new object name as a neighbour, too
    - The application will run some validations and prevent startup with clear error messages if the configured state is
      unresolvable
6. Optional: Add the object name to any terrain-climate combination in `all.exclusions.ruleset.toml` if it shouldn't
   be placed in those terrains and/or climates
7. Optional: If this is a large asset, make sure to add it to `ObjectName.is_multi_tile()`
8. Optional: If this is an animated asset, add it to `ObjectName.is_animated()`

#### How to add building or path sprite assets

1. Add the sprite to the relevant sprite sheet in `assets/objects/`
2. Update the column and row values in `constants.rs` for buildings/paths, if necessary
3. Add the new option(s) to the `ObjectName` enum
4. Add the object name(s) to the `is_building()` or `is_path()` function in `object_name.rs`
5. Add the object name(s) to the `get_index_for_building()` or `get_index_for_path()` function in `object_name.rs`
6. Add the object name(s) to the `any.terrain.ruleset.toml` file where appropriate (top, right, bottom, left)
7. If building sprite: Add the object name(s) to relevant `BuildingType` in the `BuildingComponentRegistry`

You can but don't need to update any other ruleset files as buildings and paths are placed prior to decorative objects
and therefore don't need to be considered in the wave function collapse algorithm which uses these rulesets. However,
the addition to the "any ruleset" file results in the neighbouring tile of the new sprite to be empty
(`ObjectName::Empty`). Without this, you'll see errors in the wave function collapse algorithm.

#### How to use cargo-flamegraph

- Run the command below to generate a flame graph
    - Linux:
      ```shell
      CARGO_PROFILE_RELEASE_DEBUG=true RUSTFLAGS='-C force-frame-pointers=y' cargo flamegraph -c "record -g" --package=procedural-generation-2 --bin=procedural-generation-2
      ```
    - Windows:
      ```pwsh
      $env:CARGO_PROFILE_RELEASE_DEBUG = "true"; $env:RUSTFLAGS = "-C force-frame-pointers=y"; cargo flamegraph -c "record -g" --package=procedural-generation-2 --bin=procedural-generation-2
      ````
- This should run the application - once you close it, a `flamegraph.svg` will be generated at the root of the
  repository
- Open it in your browser to see the flame graph

#### Run configurations

The `.run` folder contains a few run configurations for RustRover. Alternatively, you may want to consider creating:

- A run configuration with environment variable `RUST_LOG=procedural_generation_2=debug` for debug logs
- A run configuration that also appends
  `,procedural_generation_2::generation::object=trace,procedural_generation_2::generation::path=trace` to `RUST_LOG` for
  WFC and pathfinding trace logs
- A run configuration with environment variable `RUST_LOG=bevy_ecs=debug` to see Bevy ECS logs (e.g. which system
  caused an `error[B0003]`)

procedural-generation-2

procedural-generation-2 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

procedural-generation-2

procedural-generation-2 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README