Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robiningelbrecht/puzzle-generator

Generate Full 3D pictures of a Rubiks cube
https://github.com/robiningelbrecht/puzzle-generator

php rubiks-cube website

Last synced: 2 months ago
JSON representation

Generate Full 3D pictures of a Rubiks cube

Awesome Lists containing this project

README

        

Puzzle generator


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](https://puzzle-generator.robiningelbrecht.be)

## Some examples

### Default

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

![default](https://puzzle-generator.robiningelbrecht.be/cube)

### Scrambled

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

![scrambled](https://puzzle-generator.robiningelbrecht.be/cube?cube[algorithm]=M2%20E2%20S2)

## Development

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

Clone repository

```bash
> git clone [email protected]:robiningelbrecht/puzzle-generator.git
```

Build Docker containers

```bash
> docker-compose up --build -d
```

Install dependencies

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

Navigate to `http://localhost:9090`