https://github.com/mbarbin/cubzzle

Solver for a wooden cube puzzle
https://github.com/mbarbin/cubzzle

Last synced: 4 months ago
JSON representation

Solver for a wooden cube puzzle

• Host: GitHub
• URL: https://github.com/mbarbin/cubzzle
• Owner: mbarbin
• License: mit
• Created: 2022-05-08T10:10:14.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2026-03-24T12:03:45.000Z (4 months ago)
• Last Synced: 2026-03-25T12:16:13.712Z (4 months ago)
• Language: OCaml
• Homepage: https://mbarbin.github.io/cubzzle/
• Size: 1010 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: COPYING.HEADER
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# cubzzle

[![CI Status](https://github.com/mbarbin/cubzzle/workflows/ci/badge.svg)](https://github.com/mbarbin/cubzzle/actions/workflows/ci.yml)

[![Coverage Status](https://coveralls.io/repos/github/mbarbin/cubzzle/badge.svg?branch=main)](https://coveralls.io/github/mbarbin/cubzzle?branch=main)

This is a toy project implementing a brute force solver for a small wooden puzzle that I use to have at home.

## What's the puzzle ?

There are 6 wooden pieces made of small cubes that can fit into a 3x3x3 box.

![The puzzle](images/puzzle.png)

## What does the solver do ?

The solver finds a solution and displays it in a Graphics window.

![The cube](images/cube.png)

So that one can see exactly how the pieces fit, the display allows for inspecting pieces individually.

![The cube help](images/cube-help.png)

## Other shapes

You can assemble the same pieces into other shapes as well, such as a Dog:

![The dog](images/dog.png)

or a Tower, etc.

![The tower](images/tower.png)

## Install

Releases for this project are published to a custom opam-repo. To add it to your current opam switch, run:

```sh

opam repo add mbarbin https://github.com/mbarbin/opam-repository.git

```

Then you can install `cubzzle` using a normal opam workflow.

```sh

opam install cubzzle

```

## Running the code

The following command will open an OCaml Graphics window and run the solver:

```bash

$ cubzzle run

```

A few shapes are available (Cube, Dog, Tower, etc.). To solve a different shape, provide the option `--shape`. You can also draw the box during the brute force search, to see the solver run through all permutations interactively.

```bash

$ cubzzle run --shape=Tower --draw-box-during-search=true

```

## Motivations

I wanted to have a small code sample using OCaml Graphics on GitHub.

## Code Documentation

The code documentation of the latest release is built with `odoc` and published to `GitHub` pages [here](https://mbarbin.github.io/cubzzle).