pandemonium_engine/modules/wfc/README.md

1.3 KiB

fast-wfc

https://github.com/math-fehr/fast-wfc

An implementation of Wave Function Collapse with a focus on performance. It was called fast-wfc because at the time it introduced optimizations improving the execution time by an order of magnitude.

Rust bindings

Requirements

You need a C++-17 compatible compiler, and CMake installed.

Install the library

git clone https://github.com/math-fehr/fast-wfc && cd fast-wfc/
cmake .
make install

will install the library fastwfc and fastwfc_static using CMake:

Run the examples

cd example/
cmake .
make
./wfc_demo

will execute WFC on the examples defined in example/samples.xml, and will put the results in example/results.

Third-parties library

The files in example/src/include/external/ come from:

Image samples

The image samples come from https://github.com/mxgmn/WaveFunctionCollapse

Licence

Copyright (c) 2018-2019 Mathieu Fehr and Nathanaël Courant.

MIT License, see LICENSE for further details.