Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gregorias/rummikubsolver
A solver for the Rummikub board game
https://github.com/gregorias/rummikubsolver
haskell rummikub rummikub-solver
Last synced: about 1 month ago
JSON representation
A solver for the Rummikub board game
- Host: GitHub
- URL: https://github.com/gregorias/rummikubsolver
- Owner: gregorias
- License: gpl-3.0
- Created: 2015-07-05T17:41:07.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2023-12-25T16:34:09.000Z (about 1 year ago)
- Last Synced: 2023-12-26T16:09:13.643Z (about 1 year ago)
- Topics: haskell, rummikub, rummikub-solver
- Language: Haskell
- Homepage:
- Size: 206 KB
- Stars: 23
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🧩 Rummikub Solver
This is a solver for [Rummikub][rummikub].
Don't know whether there is a winning move? Someone can't finish, has made a
mess on board, and can't retrieve original sets? Don't worry! Rummikub Solver
automatically finds the solution.
Rummikub Solver uses integer linear programming to find the solution which
maximizes the number of tiles placed on the table from the rack. You just need
to provide the current description of the state of the game. Rummikub Solver
will display possible sets that are achievable and tiles that may be placed to
achieve them.
## Installation
This section explains how you can install this application. You have two options:
- Fetch a prebuilt package.
- Build from source.
### Prebuilt Package
For Linux & Windows, you may fetch a compiled package from
[the releases tab](https://github.com/gregorias/rummikubsolver/releases).
For Linux, you will additionally need to install GLPK (see the "GLPK" section
below) to execute the included binary. Windows comes with the necessary DLLs
bundled in the zip archive.
### Building from source
#### GLPK
Rummikub Solver requires
[GLPK](https://www.gnu.org/software/glpk/) for compilation and execution. Here
are package pointers to some selected platforms:
| OS | Package |
| -- | ------- |
| Ubuntu | [libglpk-dev](https://packages.ubuntu.com/lunar/libglpk-dev) |
| Arch Linux | [glpk](https://archlinux.org/packages/extra/x86_64/glpk/) |
| MacOS | [Homebrew GLPK](https://formulae.brew.sh/formula/glpk) |
| Windows (Msys2) | [mingw-w64-x86_64-glpk](https://packages.msys2.org/package/mingw-w64-x86_64-glpk) |
#### Build
Firstly, install a Haskell toolchain.
This can be easily done with [GHCup](https://www.haskell.org/ghcup/).
Secondly, use Stack to build & install the package with:
```bash
stack build
stack install
```
## Usage
Shortly, run `rummikubsolver` and go to `http://127.0.0.1:8080`.
Rummikub Solver has 2 UIs available: CLI and GUI. GUI is turned on by default
and uses [threepenny-gui](https://hackage.haskell.org/package/threepenny-gui)
to run a web interface. To use the GUI, visit `127.0.0.1:8080`.
You can run Rummikub Solver after installation by executing `rummikubsolver`.
Both interfaces use special syntax for adding or removing tiles from the table
or the rack. For example:
```plaintext
-lr1-3 // Remove (-) blue (l) and red (r) tiles of value from 1 to 3.
y10 // Add a yellow (y) 10 tile
j // Add a joker (j)
-j, b2 // Remove a joker (j) and add black (b) 2.
```
Formally the queries have following syntax:
```plaintext
QUERY ::= [-] (COLOR+ (VALUE | VALUE_RANGE) | j)
COLOR ::= [rlyb]
VALUE ::= 1-13
VALUE_RANGE ::= VALUE - VALUE
```
## Screenshot
## Acknowledgments
The solver in this software is based on
["Solving Rummikub Problems by Integer Linear Programming"
by D. Den Hertog and P. B. Hulshof](https://doi.org/10.1093/comjnl/bxl033).
## Final remarks
This program was done to train my Rummikub skills and as a helping tool for
board game nights.
[rummikub]: https://en.wikipedia.org/wiki/Rummikub