wfc4j - The Wave Function Collapse library for Java

The wfc4j library is a Java library that provides an implementation of the wave function collapse algorithm for procedural generation of content. This library can be used to generate a wide variety of content, such as tile maps, textures, and patterns.

Installation

To use the wfc4j library in your Java project, you can include the library as a dependency in your build configuration. Here's an example of how to do it with Maven:

<!-- https://mvnrepository.com/artifact/eu.irzinfante/wfc4j -->
<dependency>
    <groupId>eu.irzinfante</groupId>
    <artifactId>wfc4j</artifactId>
    <version>0.2.0</version>
</dependency>

Alternatively, you can download the library JAR file manually and add it to your project's classpath.

Examples

Here are some examples that demonstrate the usage of the different API of the library:

• 1-dimensional:
  • Euclidean (linear grid)
  • Toroidal (cyclic grid)
• 2-dimensional:
  • Euclidean (planar grid)
  • Toroidal (toroidal grid)

Contributing

Contributions to the wfc4j library are welcome! If you encounter any issues or have ideas for improvements, please submit them in the issue tracker of the repository.

If you want to contribute code, please fork the repository, create a new branch for your changes, and submit a pull request when you're ready.

License

Copyright (C) 2023 Iker Ruiz de Infante Gonzalez iker@irzinfante.eu

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

LICENSE contains a copy of the full GPLv3 licensing conditions.

Acknowledgments

The wfc4j library is inspired on Dan Shiffman's Coding Challenge 171: Wave Function Collapse video, which is based on the original Wave Function Collapse Algorithm developed by Maxim Gumin.