Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ww92030-storage/witness_clone

Clone of The Witness as a portable interface.
https://github.com/ww92030-storage/witness_clone

protogen puzzlegame thewitness witness

Last synced: about 1 month ago
JSON representation

Clone of The Witness as a portable interface.

Awesome Lists containing this project

README 

        
# WITNESS_CLONE

- Clone of The Witness by Thekla Inc. as a portable interface. C++ and Python.

- This repo attempts to add as much of the puzzle mechanics as possible.

  


- This is currently a work in progress.

- But one thing will remain certain: this is an interface. If you wish to attach this to some display you will have to figure that part out on your own.

- **THIS REPOSITORY CONTAINS SPOILERS FOR THE WITNESS.**



# FEATURES



- Polynomino region checker (supports fixed and arbitrary rotations but not subtractive regions).

- Hexagon dots + colored blobs + triangles + stars + cancellations

- Verification of a given path - Checks if a path is solved.

- Game interface - Wrapper class for grids that can process inputs. (You will have to provide the inputs yourself.)

- Grid solver - Automatically solves puzzle grids. Be warned that the current algorithm takes a long time to solve boards (grid cells) larger than 4x4.

- Random puzzle generator - Choose among certain presets.



# DEFINITIONS



- The grid is composed of Lines and enclosed Cells in a rectangular formation.

- The solution line/curve is denoted as the Path. The Path will partition the grid into one or more Regions.

- A Region is a set of grid Cells connected along the cardinal directions such that no two adjacent Cells have the Path as a border.

- The Path must begin at a Starting Point (usually denoted by a circle) and end at an End Point (usually denoted by a rounded protrusion from the grid).

- We will assume that the start point is on the edge of the Grid until further notice. (If you wish to place the start point somewhere else you must make Solver::validateRegion always return true.)



# THE RULES



- 【HEXAGON DOTS】- The Path must intersect every one.

- 【COLORED BLOBS】- The Region containing the blob cannot have any blobs of a different color.

- 【COLORED STARS】- The Region containing the star must have exactly one other object of the star's color. Other colors are disregarded.

- 【POLYOMINOS】- The Region's shape (i.e. the shape of the Cells) must be composed exactly of the Polyominos contained within. No overlaps or excess Cells.

- 【TRIANGLES】- The number of triangles denotes the number of sides of the Cell the symbol lies in that must be traversed by the Path.

- 【CANCELLATION】- A Region containing N cancellations must contain exactly N symbols that would render the solution invalid otherwise. Cancellations cannot nullify each other. Dots are considered symbols if they lie inside the same Region as a cancellation.



# INTERNAL REPRESENTATION



- The grid is internally represented as a (2n + 1) ⋅ (2m + 1) array, where the grid cells are n rows and m columns.

- All points with both coordinates odd cannot have paths and must be empty or contain symbols instead.

- Polyominoes are checked by reducing the region and the constituents into the Exact Cover problem and then using Knuth's DLX algorithm.



# DEPENDENCIES



- The Python version uses PIL/Pillow for rendering the images.

- The C++ version uses only the standard libraries.

- Files marked as "_esp32" are slightly modified versions of the core files that are better suited for the ESP32.



# IMPORTANT



- YOU MUST CREDIT ME (WW92030-STORAGE/WW92030/NORMALEXISTING) WHENEVER YOU USE THIS CODE.



# TO DO【IN NO PARTICULAR ORDER】



- Implement subtractive blocks.

- Make the random puzzle generator more customizable.

---



![Example!](examples/triangles.jpg?raw=true)