https://github.com/mpewsey/aycblok
Procedural generation of sliding ice block puzzles.
https://github.com/mpewsey/aycblok
procedural-generation puzzle puzzle-generator
Last synced: about 1 month ago
JSON representation
Procedural generation of sliding ice block puzzles.
- Host: GitHub
- URL: https://github.com/mpewsey/aycblok
- Owner: mpewsey
- License: bsd-3-clause
- Created: 2023-04-10T20:41:30.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-07T15:21:38.000Z (10 months ago)
- Last Synced: 2025-03-17T06:48:06.856Z (2 months ago)
- Topics: procedural-generation, puzzle, puzzle-generator
- Language: C#
- Homepage: https://mpewsey.github.io/Aycblok
- Size: 5.87 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Aycblok
[](https://github.com/mpewsey/Aycblok/actions/workflows/tests.yml)
[](https://mpewsey.github.io/Aycblok)
[](https://codecov.io/gh/mpewsey/Aycblok)
[](https://www.nuget.org/packages/MPewsey.Aycblok/)
## About
Aycblok (pronounced "ice block") provides a set of procedural generators for creating sliding ice block puzzles.
The aim of the puzzles is for a player character to slide all push blocks onto a goal tile. Once pushed, the push blocks slide until they are stopped by an obstacle: either a permanent stop block, a break block that is removed when hit, or another push block. The player can move freely within non-obstacle or non-player void tiles and must be positioned directly next to a push block in order to push it in one of the cardinal directions. A push block is assumed to disappear when it is pushed onto a goal tile. The puzzle is complete when all push blocks have been pushed onto goal tiles.
The following is a move-by-move report as generated for one such puzzle:
```
Start board: Move 1: Move 2: Key:
. . . . . . . . . . . . . . . . . . . . . . . . . . . o = Push Block
. . . . . . . . . . . . . . . . . . . . . . . . . . . % = Break Block
. . . . . . . . . . . . . . . . . . . . . . . . . . . # = Stop Block
. o . . . . . # . . . . . . . . # . . . . . . . . # . $ = Goal
. . . . $ . . . . . . . . $ . . . . . . . . $ . . . . * = Push Block at Goal
. . . . . . . % . . . . . . . . % . . . . . . . . % .
. . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . # . o . . . . . . # . . . . . . . o #
. # . . . . . . . . # . . . . . . . . # . . . . . . .
Move 3: Move 4: Move 5:
. . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . # . . . . . . . . # . . . . . . . . # .
. . . . $ . . . . . . . . $ . . o . . . . . * . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . o . . . . . . . . . . . . . . . . . . .
. . . . . . . . # . . . . . . . . # . . . . . . . . #
. # . . . . . . . . # . . . . . . . . # . . . . . . .
```
## Features
* Ice push block puzzle generation for a specified tile area.
* Input tile areas can have their tiles flagged to apply confining geometry to add challenge or visual interest.
* Support of multiple push blocks in a single puzzle area, which can interact and stop or block each other.
* Support of area obstacles such a holes by means of void tiles, which disallow traversal of a tile by the player, the push blocks, or both.
* Includes a random garbage block generator to clutter the area and make the solution less obvious.
* Customizable parameters for generation steps to help adjust the feel and difficulty of puzzles.
* Persistence of results through JSON and XML via Data Contract serialization.
## Generation Pipeline Example
The generation pipeline provides a way for multiple generation steps to be chained together. This is often easier than making manual calls to each generation step.
```GenerationPipeline.cs
// Create a dictionary of arguments to be passed to each pipeline step.
var inputs = new Dictionary
{
{ "PuzzleArea", new Array2D(20, 20) },
{ "RandomSeed", new RandomSeed(12345) },
};
// Create a pipeline
var pipeline = new Pipeline(
new PuzzleGoalGenerator(goalSize: new Vector2DInt(2, 2)),
new PuzzleMoveGenerator(pushBlockCount: 3, targetPushCount: 20),
new PuzzleGarbageGenerator(targetDensity: 0.1f, breakBlockChance: 0.5f),
);
// Run the pipeline and retrieve an output
var results = pipeline.Run(inputs);
var layout = results.GetOutput("PuzzleLayout");
```