https://github.com/pusewicz/wave-function-collapse-ruby

Tiled Wave Function Collapse model implemented in Ruby and rendered using Gosu
https://github.com/pusewicz/wave-function-collapse-ruby

game-dev game-development gamedev gosu ruby wave-function-collapse

Last synced: 3 months ago
JSON representation

Tiled Wave Function Collapse model implemented in Ruby and rendered using Gosu

• Host: GitHub
• URL: https://github.com/pusewicz/wave-function-collapse-ruby
• Owner: pusewicz
• License: mit
• Created: 2024-05-06T10:39:34.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-08-13T10:57:55.000Z (5 months ago)
• Last Synced: 2024-10-13T18:46:49.434Z (3 months ago)
• Topics: game-dev, game-development, gamedev, gosu, ruby, wave-function-collapse
• Language: Ruby
• Homepage:
• Size: 1.34 MB
• Stars: 12
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Wave Function Collapse in Ruby

This repository is an example implementation of the [Wave Function Collapse](https://github.com/mxgmn/WaveFunctionCollapse) algorithm using [Ruby](https://www.ruby-lang.org/) and [Gosu](https://www.libgosu.org/).

The algorithm is used to generate the entire map using tiles based on the rules. Rules are defined using the [Tiled](https://www.mapeditor.org/) program and read by the Ruby program from the [TSJ](https://github.com/pusewicz/wave-function-collapse-ruby/blob/main/assets/map.tsj) file.

![Wave Function Collapse in Ruby](assets/screenshot.png)

## Objective

Build the Wave Function Collapse algorithm in Ruby that's fast enough to iterate in a game on each frame.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

Run `bin/run` to run the example.

## Benchmark

Run `bin/benchmark` to see how fast the algorithm is.

#### f8157d0: Apple M3 Max 64GB (2023): 1.09s

        ruby 3.3.0 (2023-12-25 revision 5124f9ac75) [arm64-darwin23]

        Run #1: Benchmark for Model(grid=20x20 entropy=188)… Finished in 1.17s

        Run #2: Benchmark for Model(grid=20x20 entropy=188)… Finished in 1.02s

        Run #3: Benchmark for Model(grid=20x20 entropy=188)… Finished in 1.07s

        Average time: 1.0883400000069134

        Slowest time: 1.1748530000040773

        Fastest time: 1.020996000006562

        Result: 1.09s

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pusewicz/wave-function-collapse-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/pusewicz/wave-function-collapse-ruby/blob/main/CODE_OF_CONDUCT.md).

## Contributors

	

		

            

                

                    

                    


                    Piotr Usewicz

                

            

            

                

                    

                    


                    Cyberarm

                

            

		

	

## Others

- [Wave Function Collapse in DragonRuby](https://github.com/pusewicz/wave-function-collapse-dragonruby)

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Credits

Tileset: https://opengameart.org/content/consolidated-hard-vacuum-terrain-tilesets