Lonelybot

Crates

Lonelybot is a library crate with #no_std support, and can be use in webassembly
Lonecli is a binary wrapper crate on lonelybot to provide the features through CLI

You'd probably want to use lonecli. To run it with cargo,

cd lonecli
cargo run --release -- help

Build mode

release: use lto (cargo build --release)
dev: thin lto + debug info => for easy profiling (cargo build --profile=dev)
release-with-debug: Release + debug info (cargo build --profile=release-with-debug)
debug: default rust debug (cargo build)
bench: For micro-benchmarking (cargo bench)

Seed

There are 7 seed types

default: using Rust rng
legacy: similar to default, for compatibility with older version of this engine
solvitaire: re-implementation of Solvitaire random
klondike-solver: re-implementation of Klondike-Solver random
greenfelt: re-implementation of Greenfelt based on Minimal-Klondike source code
exact: converting a 256-bit integer (< 52!) to exact corresponding 52-card permutation
microsoft: reverse-engineered seed from Microsoft Solitaire Collection (thanks to ShootMe).

To obtain the Microsoft Solitaire Collection seed, you can access the game's log file at

%LocalAppData%\Packages\Microsoft.MicrosoftSolitaireCollection_8wekyb3d8bbwe\LocalState\logs\solitaire.log

You'll find them on lines starting with SolitaireGameLogic::TryLoadGame or SolvableDeckAppComponent

To input your own game, you can use convert.py in script, to convert the Solvitaire json format into an exact seed, which then you can input into lonecli. Currently it only support convert the initial state of the game.

lonecli commands

Exact

Turn a seed into the exact permutation number

lonecli exact [seed_type] [seed]

Example run

lonecli exact solvitaire 22

Example output

75815935119064350470717521029623259780400326814603147288883495865917

Random

Do random roll-outs on 10000 different games from seed to seed + 10000 to see how many games it can win

lonecli random [seed_type] [seed] [draw_step]

Example run

lonecli random default 0 3

Example output

Total win 1109/10000

Print

lonecli print [seed_type] [seed]

This will print the board in json format (in solvitaire format)

lonecli print default 0

Example output

{"tableau piles": [
["KC"],
["6s","8C"],
["9s","Ah","5S"],
["5d","Js","5h","QD"],
["Ac","7c","Jc","7h","KD"],
["10c","3h","4d","4h","6c","QS"],
["7d","3c","6h","5c","10h","9c","3S"]
],"stock": ["JD","10D","7S","10S","AD","8S","JH","2D","AS","3D","9D","9H","6D","KS","QH","2H","2S","4S","4C","KH","2C","8H","8D","QC"],
"foundation": [[],[],[],[]]}

The format:

Card:
- Rank: A, 1..10, J, Q, K
- Suit: H (heart), D (diamond), C (club), S (spade)
- Upper case suit => face up card
- Lower case suit => face down card
Pile: An array of cards in order of top-down
Tableau piles: an array of piles in order of left-right
Stock: an array of cards in the dealing stock, dealing from the end.
Foundation: an array of 4 arrays (corresponding to the suits)

Bench

lonecli bench [seed_type] [seed] [draw_step]

Example input

lonecli bench default 25 3

Example output

3555 9858569.0515807 op/s

The first number is the number of move made. The second one is the rate of move making.

Solve

lonecli solve [seed_type] [seed] [draw_step]

First it will print the game. Then it will solve it.

Example run

lonecli solve default 41 3

Example impossible output

Run in 7.0111 ms
Statistic
Total visit: 77625
Transposition hit: 41124 (rate 0.5297777777777778)
Miss state: 36501
Max depth search: 32
Current progress: 1/1 5/5 5/5 6/6 4/4 2/2 3/3 2/2
Impossible

It will print the progress every 1 second.

You can early terminate the search by pressing ctrl-C

The progress consists of:

Total visit: the number of states visited
Transposition hit: the number of states skipped due to transposition hit and its ratio compare to total visit
Miss state: the number of states that don't hit transposition table (total visit - transposition hit)
Max depth search: the maximum number of move made in the search
Current progress: a list of first 8 current move position/total move in the current search path.

Example run

lonecli solve default 12 3

Example solved output

Run in 0.1811 ms
Statistic
Total visit: 119
Transposition hit: 0 (rate 0)
Miss state: 119
Max depth search: 88
Current progress: 0/1 0/5 0/1 0/5 0/4 0/4 0/4 0/3
Solvable in 89 moves

PS A♦, R 5♠, PS A♠, ....

A♣:5▸♣  2♣:5▸♣  8♥:1▸4

JC LK LE IG AH ...

There are three type of solution notation:

The first line is the specialized notation (explained bellow)
The second line is the standardized notation with the format as [card]:[source]▸[destination] or = if it's a drawing move .
The third line is the notation from Minimal-Klondike repo.

The source and destination is formatted as:

D: Deck (the stock)
1..7: Pile (the 1-indexed tableaus)
♥, ♦, ♣, ♠: Stack (the foundation stack)

Solve loop

lonecli rate [seed_type] [seed] [draw_step]

This will sequentially solve the random game generate from seed, seed+1,...

You can still terminate solving the current game by pressing ctrl-C.

To terminate the whole process, pressing ctrl-C twice in a short amount of time (< 500ms)

Example run

lonecli rate default 0 3

Example output

Run D-0 Solved: (1-0/1 ~ 0.2065<=1.0000<=1.0000) 99 99 95 in 0.19 ms.
Run D-1 Solved: (2-0/2 ~ 0.3424<=1.0000<=1.0000) 9319 6120 81 in 0.98 ms.
Run D-2 Solved: (3-0/3 ~ 0.4385<=1.0000<=1.0000) 35571 24661 100 in 3.19 ms.
Run D-3 Solved: (4-0/4 ~ 0.5101<=1.0000<=1.0000) 728 537 89 in 0.23 ms.
Run D-4 Solved: (5-0/5 ~ 0.5655<=1.0000<=1.0000) 101120 44681 92 in 9.97 ms.
Run D-5 Solved: (6-0/6 ~ 0.6097<=1.0000<=1.0000) 2136 1423 89 in 0.43 ms.
Run D-6 Solved: (7-0/7 ~ 0.6457<=1.0000<=1.0000) 11089 5651 87 in 1.08 ms.
Run D-7 Unsolvable: (7-0/8 ~ 0.5291<=0.8750<=0.9776) 3115 1859 28 in 0.43 ms.
...

Each row correspond to a game

Run [game_seed] [solve_result]: ([solvable]-[terminated]/[total] ~ [solvable_lb_95%]<=[solvable_rate]<=[solvable_ub_95%]) [total_states] [unique_states] [max_depth] in [run_time] ms.

Play

You can play out the game. Due the optimizations, the available actions are quite unusual, and performing them may result in weird results

One action can be equivalent to multiple actions combined in standard game
The result of the action is impossible but it is equivalent to the possible result in the standard game.
Missing some actions (should be inferior to the available actions)

lonecli play [seed_type] [seed] [draw_step]

Example run

lonecli play default 0 3

Example output

0 Q♣  1 8♦ >2 8♥  3 2♣  4 K♥ >5 4♣  6 4♠  7 2♠ >8 2♥  9 Q♥  10 K♠ >11 6♦  12 9♥  13 9♦ >14 3♦  15 A♠  16 2♦ >17 J♥  18 8♠  19 A♦ >20 10♠  21 7♠  22 10♦ >23 J♦
                1.   2.   3.   4.
5       6       7       8       9       10      11
K♣      **      **      **      **      **      **
        8♣      **      **      **      **      **
                5♠      **      **      **      **
                        Q♦      **      **      **
                                K♦      **      **
                                        Q♠      **
                                                3♠

0.R Q♠, 1.R Q♦, 2.DP 2♥, 3.DP J♥, 4.DP J♦,
Hash: 1729382259552616448
Move:

You enter the move number to move:

There are currently 5 types of move:

R card: Revealing the hidden card about the card
SP card: Moving the card from the foundation stack into the tableau (the pile in my term)
DP card: Moving the card from the stock (the deck in my term) to the tableau
DS card: Moving the card from the stock to the foundation stack
PS card: Moving the card from the tableau to the stack (potentially also do a reveal)

HOP solver

In this mode it will try to solve the game with no undo. (actually it is using something more like MCTS not HOP)

lonecli hop [seed_type] [seed] [draw_step]

Example run

lonecli hop default 0 3

Example output

R Q♠,
R Q♦,
DP 4♣,
...
Solved

Example run

lonecli hop default 6 3

Example output

DS A♠,
DP J♦,
DS 2♠,
...
Lost

HOP loop

lonecli hop-loop [seed_type] [seed] [draw_step]

In this mode it will try to solve the game with no undo from the given seed and moving on to the next seed Example run

lonecli hop-loop default 0 3

Example output

1/1 ~ 0.2065 < 1.0000 < 1.0000 in 4.0302814s
2/2 ~ 0.3424 < 1.0000 < 1.0000 in 2.6200513s
2/3 ~ 0.2077 < 0.6667 < 0.9385 in 3.7817279s
3/4 ~ 0.3006 < 0.7500 < 0.9544 in 2.1479847s
...

Graph

Create a game graph of the game from the seed

lonecli graph [seed_type] [seed] [draw_step] [file.csv]

Example run

lonecli graph klondike-solver 338 3 test.csv

Example output

Run in 13.5719 ms
Statistic
Total visit: 136217
Transposition hit: 57334 (rate 0.4209019432229457)
Miss state: 78883
Max depth search: 135
Current progress: 5/5 1/1 0/0 4/4 3/3 5/5 4/4 4/4
Graphed in 136219 edges
Save done

Output file

s,t,e,id
1729382259552616448,1729382259552550912,Reveal,0
1729382259552616448,1729382259505430528,Reveal,1
1729382259505430528,1729382259505364992,Reveal,2
1729382259505364992,1729382259458179072,Reveal,3
...
1693353462533652480,1693353462533586944,Reveal,136217

There are 4 columns:

s: The source id
t: The destination id
e: The move type (with more distinction between PileStack PileStackReveal)
id: The DFS ordering

Limitations

Cannot disallow worrying back (but can be supported in the future)
Not designed to find the shortest solution

Running results

As far as my knowledge goes, up to May 2024, this solver is the state of the art for checking solvability of a standard 3-card klondike game. I didn't test much on the general case of n-card game, but it is likely to be the best as well.

I cross-checked my package with Solvitaire (published result) using the Klondike-Solver seed from 0 to 50k, and with the 1M games with Solvitaire seed from 1 to 1M. And I also cross-checked between different versions of my own package up to much more games (at least 100k and can be up to 2M games).

However, due to having a lot of game-specific optimizations that haven't been rigorously proven (but I intended to make sure it's always correct, not just a "very good heuristic" but can be wrong in extremely few cases). So any wrong solvability result is a bug.

Thoughtful Klondike

Run with Solvitaire seed Run S-1071884 Solved: (878240-0/1071884 ~ 0.8186<=0.8193<=0.8201) 12711939 4517405 93 in 10356.75 ms.

Run with Klondike Solver seed Run K-5910578 Solved: (4843708-0/5910579 ~ 0.8192<=0.8195<=0.8198) 155 149 102 in 0.60 ms.

So this is the new state of the art result for solvability: 81.95 ± 0.03 (compared to the previous from Solvitaire 81.945 ± 0.084) at 95% confidence

This result is computed on 1 cpu core for a few days. With more resources, it can be easily improved.

One other notable thing is that there's no game that it can't decide in a reasonable amount of time that I'm aware of. The hardest instance I know can be solves in a few minutes

Random Klondike

So with my hop/MCTS solver, I also achieve the state of the art for random Klondike

7148/15024 ~ 0.4678 < 0.4758 < 0.4838 in 3.171500072s

So the solvability is 47.58 ± 0.80 (compared to the previous 36.97 ± 1.92 from this paper)

The average running time for one game is only a few seconds.

However due to the significant improvement, I think this needs more verification.

Method

It started from implementing the ideas from the Solvitaire paper in Rust (which is tagged as version 0.1). Then I figure out a suit symmetry in the game state, combining with more dominances (technical term in the Solvitaire paper) and move pruning. This allows me to vastly reduced the states (around an order of magnitude) compared to the original method, combining with highly optimized implementation (around 2 orders of magnitude faster in search rate). In total, it runs around 3 orders of magnitude faster. Also after a lot of move pruning, the game graph is now a DAG (when remove cycles of 2).

I will try to find some time to write a more detailed description of the method.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Lonelybot

Crates

Build mode

Seed

lonecli commands

Exact

Random

Print

Bench

Solve

Solve loop

Play

HOP solver

HOP loop

Graph

Limitations

Running results

Thoughtful Klondike

Random Klondike

Method

Files

README.md

Latest commit

History

README.md

File metadata and controls

Lonelybot

Crates

Build mode

Seed

lonecli commands

Exact

Random

Print

Bench

Solve

Solve loop

Play

HOP solver

HOP loop

Graph

Limitations

Running results

Thoughtful Klondike

Random Klondike

Method