Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tlinden/wfcldtk
wave function collapse 2D level generator for LDTK
https://github.com/tlinden/wfcldtk
command-line game-development generator golang ldtk level-generator wfc
Last synced: 4 days ago
JSON representation
wave function collapse 2D level generator for LDTK
- Host: GitHub
- URL: https://github.com/tlinden/wfcldtk
- Owner: TLINDEN
- License: gpl-3.0
- Created: 2024-04-29T15:09:37.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-09T17:53:41.000Z (8 months ago)
- Last Synced: 2024-06-19T05:03:29.276Z (7 months ago)
- Topics: command-line, game-development, generator, golang, ldtk, level-generator, wfc
- Language: Go
- Homepage:
- Size: 4.81 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wave Function Collapse 2D level generator for LDTK
## Introduction
This little tool aims to generate levels using the wave function
collapse algorithm. It takes its input from a level in a LDTK project
file.
So just create a new LDTK project, add a tileset, a tileset layer and
add a level. Give it a name and add all the tiles you wish to use for
generated levels. If you want a increase the probability, that a
particular tile appears, just add it multiple times to the level. The
tiles in this level don't need to match together.
The tool is work in progress.
## Example
This level has been generated using [this
tileset](https://github.com/TLINDEN/wfcldtk/blob/main/images/inputtilemap.png)
and [this LDTK project](https://github.com/TLINDEN/wfcldtk/blob/main/images/demo.ldtk)
The commandline to generate it was:
```shell
./wfcldtk -p images/demo.ldtk -l Input_1 images/output.png -W 24 -H 12 && display images/output.png
```
## TODO
- add LDTK project file writing
- add another Populate() function to be able to pre-populate the output map using an LDTK level
- add weight to tiles in slot
## Usage
```default
This is wfcldtk, a WFC level generator for LDTK.
Usage: gfn [-vd] -p -l [-W -H ] []
Options:
-p --project Read data from LDTK file
-l --level Use level as example for overlap mode
-W --width Width in number of tiles (not pixel!)
-H --height Height
-d --debug Show debugging output
-v --version Show program version
```
## Installation
You will need the Golang toolchain in order to build from source. GNU
Make will also help but is not strictly neccessary.
If you want to compile the tool yourself, use `git clone` to clone the
repository. Then execute `go mod tidy` to install all
dependencies. Then just enter `go build` or - if you have GNU Make
installed - `make`.
To install after building either copy the binary or execute
`sudo make install`.
# Report bugs
[Please open an issue](https://github.com/TLINDEN/gfn/issues). Thanks!
# License
This work is licensed under the terms of the General Public Licens
version 3.
# Author
Copyleft (c) 2024 Thomas von Dein