simple_wfc 0.1.0-alpha.7

A simple implementation of wave-function collapse for procedural generation
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

# Simple WFC

[![Crates.io](https://img.shields.io/crates/v/simple_wfc.svg?label=simple_wfc)](https://crates.io/crates/simple_wfc) [![docs.rs](https://docs.rs/simple_wfc/badge.svg)](https://docs.rs/simple_wfc/)

This crate is a simple implementation of [Wave Function Collapse](https://github.com/mxgmn/WaveFunctionCollapse) a.k.a. [Model Synthesis](https://paulmerrell.org/model-synthesis/).

## Features

- [x] 2D
- [x] 3D
- [ ] Custom collapse order
- [ ] Periodic coordinate wrapping
- [x] Determinism (via custom `rand::Rng`)
- [x] Simple tiles
- [x] Overlapping tiles
  - [x] Custom pattern size
  - [x] Custom symmetry
- [ ] Error reporting

## Example (3x3 overlapping patterns)

```
____________________
__+---+__+---+______
__|+++|__|***|______
__|+++|__|***+---+__
__|+++|__|*******|__
__|+++|__|*******|__
__|+++|__|*******|__
__+---+__+-------+__
____________________
```

```
__________________________________________________
__________________________________________________
_+---+_________________________________+--+_______
_|***|______+-----+______+---------+___|**|_______
_|***|______|+++++|______|*********|___|**+----+__
_|***|______|+++++|______|*********|___|*******|__
_|***|______+-----+______+--+******|___|*******|__
_|***|______________________|******|___+-------+__
_+---+______________________+------+______________
_________+-----------+____________________________
_________|***********|_____________________+---+__
_+-------+***********|_____________+---+___|***|__
_|**************+----+_____+--+____|***|___|***|__
_|**************|__________|**|____|***|___|***|__
_+--------------+__________|**|____|***|___|***|__
____________________+---+__|**|____+---+___+---+__
____________________|***|__|**|___________________
____________________|***|__|**|___________________
____________________+---+__+--+___________________
__________________________________________________
```

## Acknowledgements

This is a simplified and extended fork of [`kahuna`](https://crates.io/crates/kahuna).

## License

Licensed under either of:

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

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.