bevy_eidolon 0.2.0

Generic instanced material for the bevy game engine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

# 👾 bevy_eidolon 

[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/NicoZweifel/bevy_eidolon?tab=readme-ov-file#license)
[![Crates.io](https://img.shields.io/crates/v/bevy_eidolon.svg)](https://crates.io/crates/bevy_eidolon)
[![Downloads](https://img.shields.io/crates/d/bevy_eidolon.svg)](https://crates.io/crates/bevy_eidolon)
[![Docs](https://docs.rs/bevy_eidolon/badge.svg)](https://docs.rs/bevy_eidolon/)
[![CI](https://github.com/nicozweifel/bevy_eidolon/workflows/CI/badge.svg)](https://github.com/NicoZweifel/bevy_eidolon/actions)

> *"Reality is illusion"*

This is a generic instanced material, mostly for grass, foliage assemblies but could be used for
fur or particles and as a high-performance replacement for gizmos when writing debugging tools in the future.

I am planning to use this as a base for other instanced materials, similar to the `Material` and `MaterialExtension` in Bevy.

> [!CAUTION]
> This package is in early development.

## What is this for? 


Drawing a lot of instances (millions) that require GPU-driven rendering with no transparency/alpha masking and that need some variation in scale, color, etc.,
but can't be reasonably done with the default material pipeline. 

Examples include grass, assemblies for foliage/trees and tools to debug them, as well as related systems (scattering, height mapping, obstacles).

## Scope & Philosophy


The standard implementation only supports simple colors and basic features.

> [!IMPORTANT]
> **I don't want this to become a monster material that supports everything.** 

However, there is an example on how to use the standard PBR lighting, and I don't mind adding specific examples if the API is a bit more mature.

I want to focus on composability and declarativity to make it as simple as possible to write new features as custom materials.

## License


Dual-licensed:

- MIT License ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))

## Notes


- Uses a custom pipeline for the `VisibilityRange` because of conflicting indices with the standard pipeline. Might also be replaced by something else in the future.
- This is work in progress, I am open to discussions about the API (cover some shapes, simple cases), for now it's just a proof of concept.