FC-SOLVE(6) | FC-SOLVE(6) |
NAME¶
fc-solve - automated solver for Freecell and related Solitiare variantsINTRODUCTION¶
This is Freecell Solver version 3.12.x, a program that automatically solves most layouts of Freecell, and similar Solitaire variants as well as those of Simple Simon.BUILDING¶
Read the file INSTALL.txt for information on how to do that.USAGE¶
The program is called "fc-solve". You invoke it like this:fc-solve board_file
4C 2C 9C 8C QS 4S 2H 5H QH 3C AC 3H 4H QD QC 9S 6H 9H 3S KS 3D 5D 2S JC 5C JH 6D AS 2D KD 10H 10C 10D 8D 7H JS KH 10S KC 7C AH 5S 6S AD 8H JD 7S 6C 7D 4D 8S 9D
KD JH 5H 7D 9H KC 9D 3H JD 5D 8H QH 7H 2D 4D 3S QC 3C 6S QS KS 10C 9S 6D 9C QD 8S 10D 10S 8C 7S 10H 2C AS 8D AC AH 4H JC 4C 6H 7C 4S 5S 5C JS AD KH 6C 2H 3D 2S
FC: 3H QC
Founds: H-5 C-A S-0 D-K
THE BOARD GENERATION PROGRAMS¶
Several programs which can generate the initial boards of various Freecell implementations can be found in the "board_gen/" sub-directory. Read the README.txt file there for details on how they can be compiled and used.THE PROGRAMS¶
Most command-line switches have two versions:•A short POSIX one which is a dash
followed by a letter or a few. This option must come standalone and not
clustered: -sam is not equivalent to specifying -s, -a and -m.
•A long switch which is two dashes
followed by the command string. For example: --prelude, --st-name.
GETTING HELP¶
-h , --helpThis option displays a help text on the screen. This help gives a help display summarizing some ways to use the program and get more help. --version
--help-configs¶
Some help on the various configurations of Freecell Solver.--help-options¶
A help screen giving an overview of all available options.--help-real-help¶
Explains how to change the default help screen to a different one.--help-short-sol¶
How to generate shorter solutions.--help-summary¶
The default help screen.OUTPUT OPTIONS¶
-p , --parseable-output¶
This option will display the columns in a format that can be more easily manipulated by text-processing programs such as grep or perl. Namely, The freecells will be displayed in one line, and the foundations in a separate line. Plus, Each column will be displayed horizontally, in its own line, while beginning with a :.-t , --display-10-as-t¶
This option will display the 10 cards as a capital T +instead of a +10. Thus, the cards will be more properly aligned.$ pi-make-microsoft-freecell-board 24 | fc-solve -p -t -=-=-=-=-=-=-=-=-=-=-=- Foundations: H-0 C-0 D-0 S-0 Freecells: : 4C 2C 9C 8C QS 4S 2H : 5H QH 3C AC 3H 4H QD : QC 9S 6H 9H 3S KS 3D : 5D 2S JC 5C JH 6D AS : 2D KD TH TC TD 8D : 7H JS KH TS KC 7C : AH 5S 6S AD 8H JD : 7S 6C 7D 4D 8S 9D ==================== Foundations: H-0 C-0 D-0 S-A Freecells: : 4C 2C 9C 8C QS 4S 2H : 5H QH 3C AC 3H 4H QD : QC 9S 6H 9H 3S KS 3D : 5D 2S JC 5C JH 6D : 2D KD TH TC TD 8D : 7H JS KH TS KC 7C : AH 5S 6S AD 8H JD : 7S 6C 7D 4D 8S 9D
-c , --canonized-order-output¶
Freecell Solver re-arranges the stacks and freecells in a given state according to their first card. It keeps their actual position in a separate place, but internally it uses their canonized place. Use this option, if you want Freecell Solver to display them in that order. One should be warned that that way the place of a given stack in the board will not be preserved throughout the solution.-m , --display-moves¶
This option will display the moves instead of the intermediate states. Each move will be displayed in a separate line, in a format that is human-readable, but that can also be parsed and analyzed by a computer program with some effort on the programmer’s part.$ pi-make-microsoft-freecell-board 24 | fc-solve -m | head -30 -=-=-=-=-=-=-=-=-=-=-=- Move a card from stack 3 to the foundations ==================== Move a card from stack 6 to freecell 0 ==================== Move a card from stack 6 to freecell 1
-sn , --standard-notation¶
This option will display the moves in standard notation in which every move consists of two characters and there are ten moves in a line. Naturally, this option will only become apparent if the display moves is specified. (it does not implicitly specify it, though).-snx , --standard-notation-extended¶
This option is similar to the previous one, except that when a sequence move is made to an empty stack with more than one card in the sequence, the move will be followed with "v" and the number of cards moved in hexadecimal.-sam , --display-states-and-moves¶
This option will display both the intermediate states and the moves that are needed to move from one to another. The standard notation option applies to it to.$ pi-make-microsoft-freecell-board 24 | fc-solve -sam -p -t | head -50 -=-=-=-=-=-=-=-=-=-=-=- Foundations: H-0 C-0 D-0 S-0 Freecells: : 4C 2C 9C 8C QS 4S 2H : 5H QH 3C AC 3H 4H QD : QC 9S 6H 9H 3S KS 3D : 5D 2S JC 5C JH 6D AS : 2D KD TH TC TD 8D : 7H JS KH TS KC 7C : AH 5S 6S AD 8H JD : 7S 6C 7D 4D 8S 9D ==================== Move a card from stack 3 to the foundations Foundations: H-0 C-0 D-0 S-A Freecells: : 4C 2C 9C 8C QS 4S 2H : 5H QH 3C AC 3H 4H QD : QC 9S 6H 9H 3S KS 3D : 5D 2S JC 5C JH 6D : 2D KD TH TC TD 8D : 7H JS KH TS KC 7C : AH 5S 6S AD 8H JD : 7S 6C 7D 4D 8S 9D ==================== Move a card from stack 6 to freecell 0 Foundations: H-0 C-0 D-0 S-A Freecells: JD : 4C 2C 9C 8C QS 4S 2H : 5H QH 3C AC 3H 4H QD : QC 9S 6H 9H 3S KS 3D : 5D 2S JC 5C JH 6D : 2D KD TH TC TD 8D : 7H JS KH TS KC 7C : AH 5S 6S AD 8H : 7S 6C 7D 4D 8S 9D ==================== Move a card from stack 6 to freecell 1
-pi , --display-parent-iter¶
This option (assuming the -s and -i options are specified) will also display the iteration index of the state from which the current state was derived. This is especially useful for BeFS (so-called a-star) or BFS scans.-o [filename] , --output [filename]¶
Outputs to a file instead of standard output. So for example:$ fc-solve -o 2405.solution.txt 2405.board
$ fc-solve --output 2405.solution.txt 2405.board
-sel , --show-exceeded-limits¶
This option will display a different status message ("Iterations count exceeded.") instead of "I could not solve this game." in case the iterations count was exceeded. This is recommended because the "I could not solve this game." message can also mean that the entire game graph was fully traversed (within the limitations of the specified moves' types) and so no solution is possible.GAME VARIANTS OPTIONS¶
--freecells-num [Number of Freecells]¶
This option specifies the number of freecells which are available to the program. Freecell Solver can use any number of freecells as long as it does not exceed its maximal number.--stacks-num [Number of Stacks]¶
This option specifies the number of stacks present in the board. Again, this number cannot exceed the maximal number of stacks, which can be specified in the file config.h during compile-time of Freecell Solver.--decks-num [Number of Decks]¶
This options specifies how many decks are found in the board. This number cannot exceed the maximal number of decks, which can be specified by the Freecell Solver build system.--sequences-are-built-by {suit|alternate_color|rank}¶
This option specifies whether a card sequence is built by suit or by alternate colour or by rank regardless of suit.--sequence-move {limited|unlimited}¶
This option specifies whether the sequence move is limited by the number of freecells or vacant stacks or not.--empty-stacks-filled-by {kings|none|all}¶
Specifies which cards can fill an empty stack.--game [game] , --preset [game] , -g [game]¶
Specifies the type of game. Each preset implies several of the settings options above and sometimes even the tests order below. The default configuration is for Freecell.bakers_dozen | Baker’s Dozen |
bakers_game | Baker’s Game |
beleaguered_castle | Beleaguered Castle |
citadel | Citadel |
cruel | Cruel |
der_katz | Der Katzenschwanz |
die_schlange | Die Schlange |
eight_off | Eight Off |
fan | Fan |
forecell | Forecell |
freecell | Freecell (default) |
good_measure | Good Measure |
ko_bakers_game | Kings' Only Baker’s Game |
relaxed_freecell | Relaxed Freecell |
relaxed_sehaven | Relaxed Seahaven Towers |
seahaven | Seahaven Towers |
simple_simon | Simple Simon |
streets_and_alleys | Streets and Alleys |
Examples¶
To solve PySol Eight Off game No. 1,000 type:$ make_pysol_freecell_board.py 1000 eight_off | fc-solve -g eight_off
$ make_pysol_freecell_board.py 50 bakers_game | fc-solve -g bakers_game
$ fc-solve -g freecell --sequences-are-built-by rank --sequence-move unlimited
5. SOLVING ALGORITHM OPTIONS¶
-mi [Iterations num] , --max-iters [Iterations num]¶
This parameter limits the maximal number of states to check. This will give a rough limit on the time spent to solve a given board.-md [Maximal depth] , --max-depth [Maximal depth]¶
Freecell Solver recurses into the solution. This parameter specifies a maximal recursion depth. Generally speaking, it’s not a good idea to set it, because that way several important intermediate states may become inaccessible.-mss [num] , --max-stored-states [num]¶
Limits the number of the states stored by the program in the computer’s memory. This differs from the maximal number of iterations in the sense, that it is possible that a stored state was not checked yet.-tmss [num] , --trim-max-stored-states [num]¶
This also limits the number of trimmed stored states, but this time will try to trim them once the limit has been reached (which is time consuming and may cause states to be traversed again in the future).-to [Test’s Order] , --tests-order [Test’s Order]¶
This option specifies the order in which Freecell Solver will try the different types of moves that it can perform. Each move is specified by one character, and they are performed in the order in which they appear in the parameter string. You can omit tests by not including their corresponding characters in the string.Freecell Tests: | |
0 | put top stack cards in the foundations. |
1 | put freecell cards in the foundations. |
2 | put freecell cards on top of stacks. |
3 | put non-top stack cards in the foundations. |
4 | move stack cards to different stacks. |
5 | move stack cards to a parent card on the same stack. |
6 | move sequences of cards onto free stacks. |
7 | put freecell cards on empty stacks. |
8 | move cards to a different parent. |
9 | empty an entire stack into the freecells. |
Atomic Freecell Tests: | |
A | move a stack card to an empty stack. |
B | move a stack card to a parent on a different stack. |
C | move a stack card to a freecell. |
D | move a freecell card to a parent. |
E | move a freecell card to an empty stack. |
Simple Simon Tests: | |
a | move a full sequence to the foundations. |
b | move a sequence to a true parent of his. |
c | move a whole stack sequence to a false parent (in order to clear the stack) |
d | move a sequence to a true parent that has some cards above it. |
e | move a sequence with some cards above it to a true parent. |
f | move a sequence with a junk sequence above it to a true parent that has some cards above it. |
g | move a whole stack sequence to a false parent which has some cards above it. |
h | move a sequence to a parent on the same stack. |
i | move any sequence to a false parent (using it may make the solution much slower). |
-dto [Min Depth],[Tests' Order] , --depth-tests-order [Min Depth],[Tests' Order]¶
Sets the Tests' order starting from the minimal depth onwards. This way, if a Soft-DFS scan recurses deeply into the game, it will use a different tests' order.-to 0123456789 -dto 30,0138924567
-to 0123457 -dto 10,750123 -dto 25,710235
-me [Solving Method] , --method [Solving Method]¶
This option specifies the solving method that will be used to solve the board. Currently, the following methods are available:•
a-star - A Best-First-Search scan (not "A*" as it was once thought to
be)
•
bfs - A Breadth-First Search (or BFS) scan
•
dfs - A Depth-First Search (or DFS) scan
•
random-dfs - A randomized DFS scan
•
soft-dfs - A "soft" DFS scan
-asw [BeFS Weights] , --a-star-weight [BeFS Weights]¶
Specify weights for the a-star (= "Best-First Search") scan, assuming it is used. The parameter should be a comma-separated list of numbers, each one is proportional to the weight of its corresponding test. 1.The number of cards out.
2.The maximal sequence move.
3.The number of cards under sequences.
4.The length of the sequences which are found
over renegade cards.
5.The depth of the board in the
solution.
-seed [Seed Number]¶
Specifies a seed to be used by Freecell Solver’s internal random number generator. This seed may alter the behaviour and speed of the random-dfs scan.--set-pruning [Pruning] , -sp [Pruning]¶
This option sets the pruning algorithm for the soft thread. Current valid values are only the empty string ("") for no pruning and r:tf (short for "Run: to foundations") for Horne’s rule. See:-opt , --optimize-solution¶
This option instructs Freecell Solver to try and optimize the solution path so it will have a smaller number of moves.-opt-to [tests order] , --optimization-tests-order [tests order]¶
This argument specifies the test order for the optimization scan, in case it should be different than an order that contains all the tests that were used in all the normal scans.--reparent-states¶
This option specifies that states that were encountered whose depth in the states graph can be improved should be reparented to the new parent. This option can possibly make solutions shorter.--calc-real-depth¶
This option becomes effective only if --reparent-states is specified. What it does, is explicitly calculate the depth of the state by tracing its path to the initial state. This may make depth consideration more accurate.RUNNING SEVERAL SCANS IN PARALLEL¶
Starting from Version 2.4.0, Freecell Solver can run several scans in parallel on the same state collection. Each scan resides in its own "Soft Thread". By specifying several soft threads on the command line one can create use several parallel scans. Once one of the scans reaches a solution, the solution will be displayed.-nst , --next-soft-thread¶
This option creates a new soft-thread and makes the following scan-specific options initialize it. For example:$ fc-solve --method a-star -nst --method soft-dfs -to 0123467 myboard.txt
-step [Step] , --soft-thread-step [Step]¶
This option will set the number of iterations with which to run the soft thread before switching to the next one. By specifying a larger step, one can give a certain scan a longer run-time and a higher priority.-nht , --next-hard-thread¶
This argument lets one initialize the next hard thread. If Freecell Solver was compiled with such support, then it is possible to run each hard thread in its own system thread. Each hard-thread contains one or more soft threads.--st-name [soft thread name]¶
This argument sets the name used to identify the current soft thread. This name can later be used to construct the prelude (see below).--prelude [i1@st1{,i2@st2{,i3@st3...}}]¶
Sets the prelude for the hard thread. At the beginning of the search, the hard thread plays a static sequence of iterations at each of the soft threads specified in the prelude, for the number of iterations specified.--prelude 500@foo,1590@bar,100@foo,200@rin
--scans-synergy {none|dead-end-marks}¶
Specifies the synergy between the various scans, or how much they cooperate between themselves. none means they do not cooperate and only share the same memory resources. dead-end-marks means they try to mark states that they have withdrawn from, and states whose all their derived states are such, as "dead ends". This may or may not improve the speed of the solution.-ni , --next-instance¶
This option allows to run two or more separate solvers one after the other. If the first one returned an unsolvable verdict, then the second one would run and so on. One use of it is to run an atomic moves scan after a meta-moves scan, so we will always get an accurate verdict and still enjoy some of the speed of the meta-moves scan.-nf , --next-flare¶
Each instance contains several flares. Flares are various alternative scans, that are ran one after another, as specified in the --flares-plan below or defaulting to running only the first flare (which isn’t very useful). Out of all the flares that are successful in solving a board, Freecell Solver picks the one with the shortest solution.--flare-name [flare name]¶
This is a name that identifies the flare for use in the flares' plan.--flares-plan [flare plan]¶
This instance-wide parameter gives a plan for the flares as a big string. Here are some examples:--flares-plan "RunIndef:FlareyFlare"
--flares-plan "Run:500@MyFlare,Run:2000@FooFlare"
--flares-plan "Run:500@dfs,Run:1500@befs,CP:,Run:10000@funky"
--cache-limit [cache limit]¶
This is a numeric limit to the LRU cache which only matters if Freecell Solver was compiled with FCS_RCS_STATES enabled. This value should be a positive integer and the higher it is, the more quickly it is likely that Freecell Solver will run, but it will also consume more memory. (The entire point of FCS_RCS_STATES is to conserve memory).META-OPTIONS¶
--reset¶
This option resets the program to its initial state, losing all the configuration logic that was inputted to it up to that state. Afterwards, it can be set to a different configuration, again.--read-from-file [num_skip,]filename¶
This option will read the configuration options from a file. The format of the file is similar to that used by the UNIX Bourne Shell. (i.e: spaces denote separate arguments, double-quotes encompass arguments, backslash escapes characters).-l [preset] , --load-config [preset]¶
Reads the configuration specified by [preset] and configures the solver accordingly. A preset is a set of command line arguments to be analyzed in the place of this option. They are read from a set of presetrc files : one installed system-wide, the other at $HOME/.freecell-solver/presetrc and the third at the path specified by the FREECELL_SOLVER_PRESETRC environment variable. You can add more presets at any of these places. (refer to http://groups.yahoo.com/group/fc-solve-discuss/message/403 for information about their format)abra-kadabra | a meta-moves preset |
blue-yonder | a meta-moves preset generated by a quota optimization algorithm. |
children-playing-ball | a meta-moves and flare-based preset that tends to yield very short solution, but is very slow (solves only 3 boards per second on a Pentium 4 2.4GHz). |
cool-jives | a meta-moves preset |
crooked-nose | an atomic-moves preset (guarantees an accurate verdict) |
enlightened-ostrich | a meta-moves preset (that depends on Freecell Solver 3.4.0 and above) that yields solutions faster on average than foss-nessy. |
fools-gold | an atomic-moves preset |
foss-nessy | a meta-moves preset (that depends on Freecell Solver 3.2.0 and above) that yields solutions faster on average than the-iglu-cabal. |
good-intentions | runs "cool-jives" and then "fools-gold" |
gooey-unknown-thing | a meta-moves preset that aims to minimise the outcome solution’s length. |
hello-world | a meta-moves preset |
john-galt-line | a meta-moves preset |
maliciously-obscure | a meta-moves and flare-based preset that tends to yield very short solutions (even in comparison to children-playing-ball ) but is slow. |
rin-tin-tin | a meta-moves preset |
sand-stone | an atomic-moves preset that aims to minimise the outcome solution’s length. |
slick-rock | run "gooey-unknown-thing" and then "sand-stone" |
sentient-pearls | a meta-moves and flares based preset with short solutions. Much faster than children-playing-ball but yields less optimal solutions. |
tea-for-two | a meta-moves preset optimized for two-freecells' Freecell games (although it can work on other Freecell-like games as well). |
the-iglu-cabal | a meta-moves preset that yields faster solutions on average than blue-yonder. |
the-last-mohican | a preset for solving Simple Simon. Yields less false negatives than the default one, but might be slower. |
three-eighty | a meta-moves preset (that depends on Freecell Solver 3.4.0 and above) that yields solutions faster on average than enlightened-ostrich. |
toons-for-twenty-somethings | an atomic-moves preset that solves more boards efficiently than "fools-gold". |
yellow-brick-road | a meta-moves preset |
RUN-TIME DISPLAY OPTIONS¶
-i , --iter-output¶
This option tells fc-solve to print the iteration number and the recursion depth of every state which is checked, to the standard output. It’s a good way to keep track of how it’s doing, but the output slows it down a bit.-s , --state-output¶
This option implies -i. If specified, this option outputs the cards and formation of the board itself, for every state that is checked. "fc-solve -s" yields a nice real-time display of the progress of Freecell Solver, but you usually cannot make what is going on because it is so fast.SIGNAL COMBINATIONS¶
If you are working on a UNIX or a similar system then you can set some run-time options in "fc-solve" by sending it some signal combinations.AUTHOR¶
Shlomi Fish <shlomif@cpan.org>Author.
2009-08-29 | $Id$ |