robiningelbrecht/puzzle-generator

dev-master 2023-03-14 18:17 UTC

This package is auto-updated.

Last update: 2024-10-14 22:09:39 UTC


README

Slim

CI Codecov.io License PHPStan Enabled PHP

This is a PHP library intended to render Rubik's cube puzzles as SVG images. The idea is to do this by navigating to https://puzzle-generator.robiningelbrecht.be/cube and provide query parameters to configure the desired cube.

It's heavily inspired by visualcube and PuzzleGen. Thanks to tdecker91 for providing these!

Documentation

The full documentation is available on https://puzzle-generator.robiningelbrecht.be

Some examples

Default

https://puzzle-generator.robiningelbrecht.be/cube

default

Scrambled

https://puzzle-generator.robiningelbrecht.be/cube?cube[algorithm]=M2 E2 S2

scrambled

Development

Feel free to fork and make changes to your needs. Consider giving it a ⭐ when you do.

Clone repository

> git clone git@github.com:robiningelbrecht/puzzle-generator.git

Build Docker containers

> docker-compose up --build -d

Install dependencies

> docker-compose run --rm php-cli composer install

Navigate to http://localhost:9090