Skip to content

Commit 475eca9

Browse files
committed
Added algorithm flowchart to readme
1 parent 57d04bd commit 475eca9

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,27 @@ This Unity example project utilizes the wave-function-collapse algorithm to proc
66
## About this project
77
Using Unity version `2019.1.14f1`.
88

9-
### [Try it out!](https://www.atalantus.de/projects/games/wfc/index.html)
9+
### [Try it out here!](https://www.atalantus.de/projects/games/wfc/index.html)
10+
11+
12+
### The Algorithm
13+
14+
**Note:**
15+
This implementation of the WFC-algorithm is not complete and it might resolve adjacent modules which edge types aren't actually fitting!
16+
Im still experimenting with this algorithm and currently developing a free Unity-tool for using WFC.
17+
18+
If you have any further questions always feel free to hit me up on [twitter](https://twitter.com/atalanthus).
19+
20+
21+
![WFC Flowchart](./images/wfc-flowchart.svg)
22+
1023

1124
## Resources
1225
Special credits to [Oskar Stålberg](https://twitter.com/OskSta) for [his talk](https://www.youtube.com/watch?v=0bcZb-SsnrA) about this algorithm and it's implementation in the game Bad North.
1326
If you want to learn more about the algorithm go check it out.
1427

1528
Other helpful resources about WFC:
29+
- https://github.com/mxgmn/WaveFunctionCollapse
1630
- http://oskarstalberg.com/game/wave/wave.html
1731
- https://robertheaton.com/2018/12/17/wavefunction-collapse-algorithm/
1832

images/wfc-flowchart.svg

Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)