Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erthium/hashiwokakero
Generator and solver algorithm repertoire for the logic puzzle Hashiwokakero.
https://github.com/erthium/hashiwokakero
cpp puzzle puzzle-generator puzzle-solver pygame python sdl2
Last synced: about 1 month ago
JSON representation
Generator and solver algorithm repertoire for the logic puzzle Hashiwokakero.
- Host: GitHub
- URL: https://github.com/erthium/hashiwokakero
- Owner: erthium
- License: gpl-3.0
- Created: 2023-12-04T06:11:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-27T10:48:30.000Z (10 months ago)
- Last Synced: 2024-06-04T00:00:02.053Z (7 months ago)
- Topics: cpp, puzzle, puzzle-generator, puzzle-solver, pygame, python, sdl2
- Language: Python
- Homepage:
- Size: 205 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hashiwokakero Puzzle
Generator and solver algorithm repertoire for the Japanese logic puzzle Hashiwokakero - aka Hashi - created by Nikoli.
The project is still being worked on, check [issues](https://github.com/ErtyumPX/hashiwokakero/issues) and [milestones](https://github.com/ErtyumPX/hashiwokakero/milestones) for the process.
## License
This project is licensed under the [GNU GPL-3.0](https://github.com/ErtyumPX/hashiwokakero/blob/main/LICENSE) license.
Main purpose is to provide a free and open-source software for puzzle enthusiasts. Feel free to use the source code. Referring to the repository would be very much appreciated.
## Setup
The project is written in Python 3.11.6, although should work on any Python Interpreter above 3.5.x.
Apart from built-in packages, only third party package is PyGame 2.5.2 with SDL 2.28.2.
For easy setup, create a python virtual environment and run:
```bash
make init
```
Mass puzzle generation scrips are currently being worked on, see [ISSUE#3](https://github.com/ErtyumPX/hashiwokakero/issues/3).
You can easily clone or fork the project, see below to find how to use source scripts.
## Puzzle
Simplyfied rules from [Wikipedia](https://en.wikipedia.org/wiki/Hashiwokakero).
Played in rectangular grid. Encircled cells are islands numbers from 1 to 8 inclusive. The rest of the cells are empty.
The goal is to connect all of the islands by drawing a series of bridges between the islands.
The bridges must follow certain criteria:
- All islands must be connected.
- Bridged cannot cross.
- Bridges are only established orthogonally, never diagonally.
- At most two bridges connect a pair of islands.
- An island must hold bridges that mathces it's own number.
Plot-twist is that there may not be only 1 solution. Sometimes the structure of the board allows to have 2 different ways to go and still fulfill all the rules.
## General Structure
### Terminology
**Generator**
Full Grid: A grid that satisfies given w and h dimensions and has no empty edges.
Cycle Step: Iteration count of the generator algorithm. Since generation is random,
it may not reach that iteration count. Still is important if the user wants to stop
generating at some point
Max Puzzle: A puzzle which cannot be extended anymore, which has no node that could
potentially have another bridge in an empty direction.
**Solver**
Completed Grid: A grid that is completely solved.
Solving by Rules: Solving the puzzle by using the rules of the game, without any brute force method.
Solving by Brute Force: Solving the puzzle by trying all possible combinations of bridges. This method is used after solving by rules method is tried but the puzzle is still not completed. This occures because of the nature of Hashi, sometimes there could be more than 1 way to go and the rules are not enough to solve the puzzle.
### Generator Algorithm
Will be written soon...
### Solver Algorithm
Will be written soon...
### Difficulty Precision and Mass Generation
Will be written soon...