Compare commits
3 commits
leg-py1.5.
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| ee14d51d35 | |||
| 3b3cfa9d8a | |||
| b6e0405538 |
3 changed files with 640 additions and 3 deletions
338
LICENSE
Normal file
338
LICENSE
Normal file
|
|
@ -0,0 +1,338 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 2, June 1991
|
||||||
|
|
||||||
|
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
||||||
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The licenses for most software are designed to take away your
|
||||||
|
freedom to share and change it. By contrast, the GNU General Public
|
||||||
|
License is intended to guarantee your freedom to share and change free
|
||||||
|
software--to make sure the software is free for all its users. This
|
||||||
|
General Public License applies to most of the Free Software
|
||||||
|
Foundation's software and to any other program whose authors commit to
|
||||||
|
using it. (Some other Free Software Foundation software is covered by
|
||||||
|
the GNU Lesser General Public License instead.) You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
this service if you wish), that you receive source code or can get it
|
||||||
|
if you want it, that you can change the software or use pieces of it
|
||||||
|
in new free programs; and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to make restrictions that forbid
|
||||||
|
anyone to deny you these rights or to ask you to surrender the rights.
|
||||||
|
These restrictions translate to certain responsibilities for you if you
|
||||||
|
distribute copies of the software, or if you modify it.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must give the recipients all the rights that
|
||||||
|
you have. You must make sure that they, too, receive or can get the
|
||||||
|
source code. And you must show them these terms so they know their
|
||||||
|
rights.
|
||||||
|
|
||||||
|
We protect your rights with two steps: (1) copyright the software, and
|
||||||
|
(2) offer you this license which gives you legal permission to copy,
|
||||||
|
distribute and/or modify the software.
|
||||||
|
|
||||||
|
Also, for each author's protection and ours, we want to make certain
|
||||||
|
that everyone understands that there is no warranty for this free
|
||||||
|
software. If the software is modified by someone else and passed on, we
|
||||||
|
want its recipients to know that what they have is not the original, so
|
||||||
|
that any problems introduced by others will not reflect on the original
|
||||||
|
authors' reputations.
|
||||||
|
|
||||||
|
Finally, any free program is threatened constantly by software
|
||||||
|
patents. We wish to avoid the danger that redistributors of a free
|
||||||
|
program will individually obtain patent licenses, in effect making the
|
||||||
|
program proprietary. To prevent this, we have made it clear that any
|
||||||
|
patent must be licensed for everyone's free use or not licensed at all.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||||
|
|
||||||
|
0. This License applies to any program or other work which contains
|
||||||
|
a notice placed by the copyright holder saying it may be distributed
|
||||||
|
under the terms of this General Public License. The "Program", below,
|
||||||
|
refers to any such program or work, and a "work based on the Program"
|
||||||
|
means either the Program or any derivative work under copyright law:
|
||||||
|
that is to say, a work containing the Program or a portion of it,
|
||||||
|
either verbatim or with modifications and/or translated into another
|
||||||
|
language. (Hereinafter, translation is included without limitation in
|
||||||
|
the term "modification".) Each licensee is addressed as "you".
|
||||||
|
|
||||||
|
Activities other than copying, distribution and modification are not
|
||||||
|
covered by this License; they are outside its scope. The act of
|
||||||
|
running the Program is not restricted, and the output from the Program
|
||||||
|
is covered only if its contents constitute a work based on the
|
||||||
|
Program (independent of having been made by running the Program).
|
||||||
|
Whether that is true depends on what the Program does.
|
||||||
|
|
||||||
|
1. You may copy and distribute verbatim copies of the Program's
|
||||||
|
source code as you receive it, in any medium, provided that you
|
||||||
|
conspicuously and appropriately publish on each copy an appropriate
|
||||||
|
copyright notice and disclaimer of warranty; keep intact all the
|
||||||
|
notices that refer to this License and to the absence of any warranty;
|
||||||
|
and give any other recipients of the Program a copy of this License
|
||||||
|
along with the Program.
|
||||||
|
|
||||||
|
You may charge a fee for the physical act of transferring a copy, and
|
||||||
|
you may at your option offer warranty protection in exchange for a fee.
|
||||||
|
|
||||||
|
2. You may modify your copy or copies of the Program or any portion
|
||||||
|
of it, thus forming a work based on the Program, and copy and
|
||||||
|
distribute such modifications or work under the terms of Section 1
|
||||||
|
above, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) You must cause the modified files to carry prominent notices
|
||||||
|
stating that you changed the files and the date of any change.
|
||||||
|
|
||||||
|
b) You must cause any work that you distribute or publish, that in
|
||||||
|
whole or in part contains or is derived from the Program or any
|
||||||
|
part thereof, to be licensed as a whole at no charge to all third
|
||||||
|
parties under the terms of this License.
|
||||||
|
|
||||||
|
c) If the modified program normally reads commands interactively
|
||||||
|
when run, you must cause it, when started running for such
|
||||||
|
interactive use in the most ordinary way, to print or display an
|
||||||
|
announcement including an appropriate copyright notice and a
|
||||||
|
notice that there is no warranty (or else, saying that you provide
|
||||||
|
a warranty) and that users may redistribute the program under
|
||||||
|
these conditions, and telling the user how to view a copy of this
|
||||||
|
License. (Exception: if the Program itself is interactive but
|
||||||
|
does not normally print such an announcement, your work based on
|
||||||
|
the Program is not required to print an announcement.)
|
||||||
|
|
||||||
|
These requirements apply to the modified work as a whole. If
|
||||||
|
identifiable sections of that work are not derived from the Program,
|
||||||
|
and can be reasonably considered independent and separate works in
|
||||||
|
themselves, then this License, and its terms, do not apply to those
|
||||||
|
sections when you distribute them as separate works. But when you
|
||||||
|
distribute the same sections as part of a whole which is a work based
|
||||||
|
on the Program, the distribution of the whole must be on the terms of
|
||||||
|
this License, whose permissions for other licensees extend to the
|
||||||
|
entire whole, and thus to each and every part regardless of who wrote it.
|
||||||
|
|
||||||
|
Thus, it is not the intent of this section to claim rights or contest
|
||||||
|
your rights to work written entirely by you; rather, the intent is to
|
||||||
|
exercise the right to control the distribution of derivative or
|
||||||
|
collective works based on the Program.
|
||||||
|
|
||||||
|
In addition, mere aggregation of another work not based on the Program
|
||||||
|
with the Program (or with a work based on the Program) on a volume of
|
||||||
|
a storage or distribution medium does not bring the other work under
|
||||||
|
the scope of this License.
|
||||||
|
|
||||||
|
3. You may copy and distribute the Program (or a work based on it,
|
||||||
|
under Section 2) in object code or executable form under the terms of
|
||||||
|
Sections 1 and 2 above provided that you also do one of the following:
|
||||||
|
|
||||||
|
a) Accompany it with the complete corresponding machine-readable
|
||||||
|
source code, which must be distributed under the terms of Sections
|
||||||
|
1 and 2 above on a medium customarily used for software interchange; or,
|
||||||
|
|
||||||
|
b) Accompany it with a written offer, valid for at least three
|
||||||
|
years, to give any third party, for a charge no more than your
|
||||||
|
cost of physically performing source distribution, a complete
|
||||||
|
machine-readable copy of the corresponding source code, to be
|
||||||
|
distributed under the terms of Sections 1 and 2 above on a medium
|
||||||
|
customarily used for software interchange; or,
|
||||||
|
|
||||||
|
c) Accompany it with the information you received as to the offer
|
||||||
|
to distribute corresponding source code. (This alternative is
|
||||||
|
allowed only for noncommercial distribution and only if you
|
||||||
|
received the program in object code or executable form with such
|
||||||
|
an offer, in accord with Subsection b above.)
|
||||||
|
|
||||||
|
The source code for a work means the preferred form of the work for
|
||||||
|
making modifications to it. For an executable work, complete source
|
||||||
|
code means all the source code for all modules it contains, plus any
|
||||||
|
associated interface definition files, plus the scripts used to
|
||||||
|
control compilation and installation of the executable. However, as a
|
||||||
|
special exception, the source code distributed need not include
|
||||||
|
anything that is normally distributed (in either source or binary
|
||||||
|
form) with the major components (compiler, kernel, and so on) of the
|
||||||
|
operating system on which the executable runs, unless that component
|
||||||
|
itself accompanies the executable.
|
||||||
|
|
||||||
|
If distribution of executable or object code is made by offering
|
||||||
|
access to copy from a designated place, then offering equivalent
|
||||||
|
access to copy the source code from the same place counts as
|
||||||
|
distribution of the source code, even though third parties are not
|
||||||
|
compelled to copy the source along with the object code.
|
||||||
|
|
||||||
|
4. You may not copy, modify, sublicense, or distribute the Program
|
||||||
|
except as expressly provided under this License. Any attempt
|
||||||
|
otherwise to copy, modify, sublicense or distribute the Program is
|
||||||
|
void, and will automatically terminate your rights under this License.
|
||||||
|
However, parties who have received copies, or rights, from you under
|
||||||
|
this License will not have their licenses terminated so long as such
|
||||||
|
parties remain in full compliance.
|
||||||
|
|
||||||
|
5. You are not required to accept this License, since you have not
|
||||||
|
signed it. However, nothing else grants you permission to modify or
|
||||||
|
distribute the Program or its derivative works. These actions are
|
||||||
|
prohibited by law if you do not accept this License. Therefore, by
|
||||||
|
modifying or distributing the Program (or any work based on the
|
||||||
|
Program), you indicate your acceptance of this License to do so, and
|
||||||
|
all its terms and conditions for copying, distributing or modifying
|
||||||
|
the Program or works based on it.
|
||||||
|
|
||||||
|
6. Each time you redistribute the Program (or any work based on the
|
||||||
|
Program), the recipient automatically receives a license from the
|
||||||
|
original licensor to copy, distribute or modify the Program subject to
|
||||||
|
these terms and conditions. You may not impose any further
|
||||||
|
restrictions on the recipients' exercise of the rights granted herein.
|
||||||
|
You are not responsible for enforcing compliance by third parties to
|
||||||
|
this License.
|
||||||
|
|
||||||
|
7. If, as a consequence of a court judgment or allegation of patent
|
||||||
|
infringement or for any other reason (not limited to patent issues),
|
||||||
|
conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot
|
||||||
|
distribute so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you
|
||||||
|
may not distribute the Program at all. For example, if a patent
|
||||||
|
license would not permit royalty-free redistribution of the Program by
|
||||||
|
all those who receive copies directly or indirectly through you, then
|
||||||
|
the only way you could satisfy both it and this License would be to
|
||||||
|
refrain entirely from distribution of the Program.
|
||||||
|
|
||||||
|
If any portion of this section is held invalid or unenforceable under
|
||||||
|
any particular circumstance, the balance of the section is intended to
|
||||||
|
apply and the section as a whole is intended to apply in other
|
||||||
|
circumstances.
|
||||||
|
|
||||||
|
It is not the purpose of this section to induce you to infringe any
|
||||||
|
patents or other property right claims or to contest validity of any
|
||||||
|
such claims; this section has the sole purpose of protecting the
|
||||||
|
integrity of the free software distribution system, which is
|
||||||
|
implemented by public license practices. Many people have made
|
||||||
|
generous contributions to the wide range of software distributed
|
||||||
|
through that system in reliance on consistent application of that
|
||||||
|
system; it is up to the author/donor to decide if he or she is willing
|
||||||
|
to distribute software through any other system and a licensee cannot
|
||||||
|
impose that choice.
|
||||||
|
|
||||||
|
This section is intended to make thoroughly clear what is believed to
|
||||||
|
be a consequence of the rest of this License.
|
||||||
|
|
||||||
|
8. If the distribution and/or use of the Program is restricted in
|
||||||
|
certain countries either by patents or by copyrighted interfaces, the
|
||||||
|
original copyright holder who places the Program under this License
|
||||||
|
may add an explicit geographical distribution limitation excluding
|
||||||
|
those countries, so that distribution is permitted only in or among
|
||||||
|
countries not thus excluded. In such case, this License incorporates
|
||||||
|
the limitation as if written in the body of this License.
|
||||||
|
|
||||||
|
9. The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the Program
|
||||||
|
specifies a version number of this License which applies to it and "any
|
||||||
|
later version", you have the option of following the terms and conditions
|
||||||
|
either of that version or of any later version published by the Free
|
||||||
|
Software Foundation. If the Program does not specify a version number of
|
||||||
|
this License, you may choose any version ever published by the Free Software
|
||||||
|
Foundation.
|
||||||
|
|
||||||
|
10. If you wish to incorporate parts of the Program into other free
|
||||||
|
programs whose distribution conditions are different, write to the author
|
||||||
|
to ask for permission. For software which is copyrighted by the Free
|
||||||
|
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||||
|
make exceptions for this. Our decision will be guided by the two goals
|
||||||
|
of preserving the free status of all derivatives of our free software and
|
||||||
|
of promoting the sharing and reuse of software generally.
|
||||||
|
|
||||||
|
NO WARRANTY
|
||||||
|
|
||||||
|
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||||
|
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||||
|
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||||
|
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||||
|
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||||
|
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||||
|
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||||
|
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||||
|
REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||||
|
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||||
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||||
|
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||||
|
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||||
|
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||||
|
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||||
|
POSSIBILITY OF SUCH DAMAGES.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
convey the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software; you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation; version 2 of the License.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program; if not, write to the Free Software
|
||||||
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program is interactive, make it output a short notice like this
|
||||||
|
when it starts in an interactive mode:
|
||||||
|
|
||||||
|
Gnomovision version 69, Copyright (C) year name of author
|
||||||
|
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, the commands you use may
|
||||||
|
be called something other than `show w' and `show c'; they could even be
|
||||||
|
mouse-clicks or menu items--whatever suits your program.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or your
|
||||||
|
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||||
|
necessary. Here is a sample; alter the names:
|
||||||
|
|
||||||
|
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||||
|
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||||
|
|
||||||
|
<signature of Ty Coon>, 1 April 1989
|
||||||
|
Ty Coon, President of Vice
|
||||||
|
|
||||||
|
This General Public License does not permit incorporating your program into
|
||||||
|
proprietary programs. If your program is a subroutine library, you may
|
||||||
|
consider it more useful to permit linking proprietary applications with the
|
||||||
|
library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License.
|
||||||
132
README.md
Normal file
132
README.md
Normal file
|
|
@ -0,0 +1,132 @@
|
||||||
|
# mcfreecell
|
||||||
|
|
||||||
|
`mcfreecell` is a terminal-native FreeCell game with a systems-theme twist.
|
||||||
|
|
||||||
|
It has two flavors:
|
||||||
|
|
||||||
|
- a modern curses build with Linux-themed suits and richer terminal rendering
|
||||||
|
- a legacy branch aimed at very old Python and curses environments, including Python 1.5.2-era machines
|
||||||
|
|
||||||
|
The project started as a novelty FreeCell prototype and grew into a playable, keyboard-driven curses card game with legal multi-card moves, visual stack selection, and lightweight move hints.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- FreeCell rules with 8 tableau columns, 4 free cells, and 4 foundations
|
||||||
|
- legal multi-card tableau moves with proper FreeCell move-capacity limits
|
||||||
|
- keyboard-driven play in a curses interface
|
||||||
|
- visual stack selection mode
|
||||||
|
- lightweight `?` hint system for suggesting a good next move
|
||||||
|
- responsive layout for wider terminals
|
||||||
|
- legacy branch compatible with old machines and older Python/curses behavior
|
||||||
|
|
||||||
|
## Controls
|
||||||
|
|
||||||
|
- `Arrow keys` / `h j k l` - move cursor
|
||||||
|
- `v` - enter or exit tableau selection mode
|
||||||
|
- `y` - pick up selected card or stack
|
||||||
|
- `p` - drop held card or stack
|
||||||
|
- `Enter` / `Space` - alternate pick up / drop
|
||||||
|
- `u` - undo the last completed move
|
||||||
|
- `?` - show a suggested move
|
||||||
|
- `f` - quick move selected card to a free cell
|
||||||
|
- `d` - quick move selected card to foundation
|
||||||
|
- `Esc` - cancel selection or restore held cards
|
||||||
|
- `q` - quit
|
||||||
|
|
||||||
|
## Branches
|
||||||
|
|
||||||
|
### Main branch
|
||||||
|
|
||||||
|
The main branch targets modern Python 3 and modern terminals.
|
||||||
|
|
||||||
|
This version includes:
|
||||||
|
|
||||||
|
- Linux distro themed suits
|
||||||
|
- modern curses layout and highlighting
|
||||||
|
- Nerd Font-oriented suit glyphs
|
||||||
|
- richer visual presentation
|
||||||
|
|
||||||
|
Current main-branch suits:
|
||||||
|
|
||||||
|
- Debian
|
||||||
|
- Gentoo
|
||||||
|
- Arch
|
||||||
|
- Slackware
|
||||||
|
|
||||||
|
These are split into two alternating-color groups for FreeCell rules:
|
||||||
|
|
||||||
|
- red group: Debian, Gentoo
|
||||||
|
- black group: Arch, Slackware
|
||||||
|
|
||||||
|
The main branch uses special glyphs for suit rendering. If your terminal or font does not display them well, Nerd Fonts can be downloaded for free at `https://www.nerdfonts.com/font-downloads`.
|
||||||
|
|
||||||
|
### `leg-py1.5.2` branch
|
||||||
|
|
||||||
|
The `leg-py1.5.2` branch is a backport for very old systems.
|
||||||
|
|
||||||
|
This version is written in a Python-1.5.2-friendly style and avoids relying on modern Python features or modern terminal niceties.
|
||||||
|
|
||||||
|
This branch includes:
|
||||||
|
|
||||||
|
- ASCII-only suit tags
|
||||||
|
- compatibility fallbacks for weak or incomplete curses implementations
|
||||||
|
- visible ASCII cursor and hint markers for monochrome terminals
|
||||||
|
|
||||||
|
Legacy-branch suits:
|
||||||
|
|
||||||
|
- Debian (`Deb`)
|
||||||
|
- Red Hat (`RHt`)
|
||||||
|
- Solaris (`Sol`)
|
||||||
|
- HP-UX (`HPx`)
|
||||||
|
|
||||||
|
These are split into the two FreeCell color groups as:
|
||||||
|
|
||||||
|
- red group: Debian, Red Hat
|
||||||
|
- black-equivalent group: Solaris, HP-UX
|
||||||
|
|
||||||
|
On legacy terminals, the non-red group may render as blue, cyan, or plain monochrome depending on curses support.
|
||||||
|
|
||||||
|
## Running
|
||||||
|
|
||||||
|
### Modern branch
|
||||||
|
|
||||||
|
Run with Python 3:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python3 linux-freecell.py
|
||||||
|
```
|
||||||
|
|
||||||
|
### Legacy branch
|
||||||
|
|
||||||
|
On the legacy branch, run with whatever Python interpreter is available on the target machine:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python linux-freecell.py
|
||||||
|
```
|
||||||
|
|
||||||
|
For very old systems, terminal and curses support may vary. The legacy branch tries to fall back gracefully when color, standout attributes, or newer curses APIs are missing.
|
||||||
|
|
||||||
|
## Suit Theme Notes
|
||||||
|
|
||||||
|
`mcfreecell` is not trying to be a generic casino card game. The suit sets are themed around operating systems and Unix history.
|
||||||
|
|
||||||
|
The modern branch leans into playful terminal-native Linux theming.
|
||||||
|
|
||||||
|
The legacy branch uses a more period-appropriate late-1990s / early-2000s mix of Linux and proprietary Unix systems to better fit older hardware and software environments.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is released under the GNU General Public License, version 2 only.
|
||||||
|
|
||||||
|
See `LICENSE` for the full license text.
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
This is a small personal curses game project, but it is playable and actively being shaped into both:
|
||||||
|
|
||||||
|
- a fun modern terminal FreeCell
|
||||||
|
- a practical legacy-machine FreeCell
|
||||||
|
|
||||||
|
## Possible Future Work
|
||||||
|
|
||||||
|
- packaged releases for modern and legacy branches
|
||||||
|
|
@ -10,6 +10,7 @@ Arrow keys / h j k l : Move cursor
|
||||||
v : Enter / exit tableau visual selection
|
v : Enter / exit tableau visual selection
|
||||||
y : Pick up selected card / stack
|
y : Pick up selected card / stack
|
||||||
p : Drop held card / stack
|
p : Drop held card / stack
|
||||||
|
u : Undo the last completed move
|
||||||
? : Show a suggested move
|
? : Show a suggested move
|
||||||
Space or Enter : Pick up / drop a card or stack
|
Space or Enter : Pick up / drop a card or stack
|
||||||
f : Quick move selected card to a free cell
|
f : Quick move selected card to a free cell
|
||||||
|
|
@ -27,6 +28,7 @@ Notes
|
||||||
|
|
||||||
import curses
|
import curses
|
||||||
import random
|
import random
|
||||||
|
import time
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from typing import List, Optional, Tuple
|
from typing import List, Optional, Tuple
|
||||||
|
|
||||||
|
|
@ -109,6 +111,17 @@ class HintMove:
|
||||||
score: int
|
score: int
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class MoveRecord:
|
||||||
|
"""Describes one completed move that can be undone."""
|
||||||
|
|
||||||
|
source_type: str
|
||||||
|
source_index: int
|
||||||
|
dest_type: str
|
||||||
|
dest_index: int
|
||||||
|
cards: Tuple[Card, ...]
|
||||||
|
|
||||||
|
|
||||||
class FreeCellGame:
|
class FreeCellGame:
|
||||||
"""Holds the state and rules for a small FreeCell prototype."""
|
"""Holds the state and rules for a small FreeCell prototype."""
|
||||||
|
|
||||||
|
|
@ -118,6 +131,7 @@ class FreeCellGame:
|
||||||
self.foundations: List[List[Card]] = [[] for _ in range(4)]
|
self.foundations: List[List[Card]] = [[] for _ in range(4)]
|
||||||
self.held: Optional[HeldCards] = None
|
self.held: Optional[HeldCards] = None
|
||||||
self.hint_move: Optional[HintMove] = None
|
self.hint_move: Optional[HintMove] = None
|
||||||
|
self.move_history: List[MoveRecord] = []
|
||||||
self.visual_mode = False
|
self.visual_mode = False
|
||||||
self.visual_row = 0
|
self.visual_row = 0
|
||||||
|
|
||||||
|
|
@ -128,12 +142,107 @@ class FreeCellGame:
|
||||||
self.cursor_index = 0
|
self.cursor_index = 0
|
||||||
|
|
||||||
self.status = "Arrow keys move, v selects a stack, ? shows a hint."
|
self.status = "Arrow keys move, v selects a stack, ? shows a hint."
|
||||||
|
self.start_time = time.monotonic()
|
||||||
|
self.finished_time_seconds: Optional[int] = None
|
||||||
self._deal_new_game()
|
self._deal_new_game()
|
||||||
|
|
||||||
|
def elapsed_time_seconds(self) -> int:
|
||||||
|
"""Return elapsed play time, freezing it after a win."""
|
||||||
|
if self.finished_time_seconds is not None:
|
||||||
|
return self.finished_time_seconds
|
||||||
|
|
||||||
|
elapsed = int(time.monotonic() - self.start_time)
|
||||||
|
if self.is_won():
|
||||||
|
self.finished_time_seconds = elapsed
|
||||||
|
return self.finished_time_seconds
|
||||||
|
return elapsed
|
||||||
|
|
||||||
def clear_hint(self) -> None:
|
def clear_hint(self) -> None:
|
||||||
"""Drop the currently remembered hint highlight."""
|
"""Drop the currently remembered hint highlight."""
|
||||||
self.hint_move = None
|
self.hint_move = None
|
||||||
|
|
||||||
|
def record_move(
|
||||||
|
self,
|
||||||
|
source_type: str,
|
||||||
|
source_index: int,
|
||||||
|
dest_type: str,
|
||||||
|
dest_index: int,
|
||||||
|
cards: List[Card],
|
||||||
|
) -> None:
|
||||||
|
"""Remember one completed move so it can be undone later."""
|
||||||
|
self.move_history.append(
|
||||||
|
MoveRecord(
|
||||||
|
source_type=source_type,
|
||||||
|
source_index=source_index,
|
||||||
|
dest_type=dest_type,
|
||||||
|
dest_index=dest_index,
|
||||||
|
cards=tuple(cards),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
def _remove_cards_from_destination(self, move: MoveRecord) -> bool:
|
||||||
|
"""Remove the recorded cards from a move destination during undo."""
|
||||||
|
cards = list(move.cards)
|
||||||
|
|
||||||
|
if move.dest_type == "col":
|
||||||
|
column = self.columns[move.dest_index]
|
||||||
|
if len(column) < len(cards) or column[-len(cards) :] != cards:
|
||||||
|
return False
|
||||||
|
del column[-len(cards) :]
|
||||||
|
return True
|
||||||
|
|
||||||
|
if move.dest_type == "free":
|
||||||
|
if self.freecells[move.dest_index] != cards[0]:
|
||||||
|
return False
|
||||||
|
self.freecells[move.dest_index] = None
|
||||||
|
return True
|
||||||
|
|
||||||
|
foundation = self.foundations[move.dest_index]
|
||||||
|
if not foundation or foundation[-1] != cards[0]:
|
||||||
|
return False
|
||||||
|
foundation.pop()
|
||||||
|
return True
|
||||||
|
|
||||||
|
def _restore_cards_to_source(self, move: MoveRecord) -> None:
|
||||||
|
"""Put cards back at the recorded move source during undo."""
|
||||||
|
cards = list(move.cards)
|
||||||
|
|
||||||
|
if move.source_type == "col":
|
||||||
|
self.columns[move.source_index].extend(cards)
|
||||||
|
return
|
||||||
|
|
||||||
|
self.freecells[move.source_index] = cards[0]
|
||||||
|
|
||||||
|
def undo_last_move(self) -> None:
|
||||||
|
"""Undo the most recent completed move."""
|
||||||
|
if self.held is not None:
|
||||||
|
self.status = "Drop or cancel the held cards before undoing a move."
|
||||||
|
return
|
||||||
|
|
||||||
|
if not self.move_history:
|
||||||
|
self.status = "Nothing to undo."
|
||||||
|
return
|
||||||
|
|
||||||
|
move = self.move_history[-1]
|
||||||
|
if not self._remove_cards_from_destination(move):
|
||||||
|
self.status = (
|
||||||
|
"Undo failed because the board no longer matches the last move."
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
self.move_history.pop()
|
||||||
|
|
||||||
|
self._restore_cards_to_source(move)
|
||||||
|
self.clear_hint()
|
||||||
|
if self.visual_mode:
|
||||||
|
self.exit_visual_mode()
|
||||||
|
|
||||||
|
move_count = len(move.cards)
|
||||||
|
if move_count == 1:
|
||||||
|
self.status = f"Undid move of {move.cards[0].short_name()}."
|
||||||
|
else:
|
||||||
|
self.status = f"Undid move of {move_count} cards."
|
||||||
|
|
||||||
def _deal_new_game(self) -> None:
|
def _deal_new_game(self) -> None:
|
||||||
"""Build and shuffle a standard 52-card deck, then deal to 8 columns."""
|
"""Build and shuffle a standard 52-card deck, then deal to 8 columns."""
|
||||||
deck: List[Card] = [Card(rank, suit) for suit in SUITS for rank in RANKS]
|
deck: List[Card] = [Card(rank, suit) for suit in SUITS for rank in RANKS]
|
||||||
|
|
@ -684,6 +793,13 @@ class FreeCellGame:
|
||||||
if self.can_place_stack_on_column(cards, self.cursor_index):
|
if self.can_place_stack_on_column(cards, self.cursor_index):
|
||||||
self.clear_hint()
|
self.clear_hint()
|
||||||
self.columns[self.cursor_index].extend(cards)
|
self.columns[self.cursor_index].extend(cards)
|
||||||
|
self.record_move(
|
||||||
|
self.held.source_type,
|
||||||
|
self.held.source_index,
|
||||||
|
"col",
|
||||||
|
self.cursor_index,
|
||||||
|
cards,
|
||||||
|
)
|
||||||
if moving_count == 1:
|
if moving_count == 1:
|
||||||
self.status = f"Placed {moving_top.short_name()} on column {self.cursor_index + 1}."
|
self.status = f"Placed {moving_top.short_name()} on column {self.cursor_index + 1}."
|
||||||
else:
|
else:
|
||||||
|
|
@ -702,6 +818,13 @@ class FreeCellGame:
|
||||||
if self.freecells[self.cursor_index] is None:
|
if self.freecells[self.cursor_index] is None:
|
||||||
self.clear_hint()
|
self.clear_hint()
|
||||||
self.freecells[self.cursor_index] = moving_top
|
self.freecells[self.cursor_index] = moving_top
|
||||||
|
self.record_move(
|
||||||
|
self.held.source_type,
|
||||||
|
self.held.source_index,
|
||||||
|
"free",
|
||||||
|
self.cursor_index,
|
||||||
|
cards,
|
||||||
|
)
|
||||||
self.status = f"Placed {moving_top.short_name()} in free cell {self.cursor_index + 1}."
|
self.status = f"Placed {moving_top.short_name()} in free cell {self.cursor_index + 1}."
|
||||||
self.held = None
|
self.held = None
|
||||||
else:
|
else:
|
||||||
|
|
@ -717,6 +840,13 @@ class FreeCellGame:
|
||||||
self.clear_hint()
|
self.clear_hint()
|
||||||
foundation = self.foundation_for_suit(moving_top.suit.name)
|
foundation = self.foundation_for_suit(moving_top.suit.name)
|
||||||
foundation.append(moving_top)
|
foundation.append(moving_top)
|
||||||
|
self.record_move(
|
||||||
|
self.held.source_type,
|
||||||
|
self.held.source_index,
|
||||||
|
"foundation",
|
||||||
|
SUITS.index(moving_top.suit),
|
||||||
|
cards,
|
||||||
|
)
|
||||||
self.status = f"Moved {moving_top.short_name()} to foundation."
|
self.status = f"Moved {moving_top.short_name()} to foundation."
|
||||||
self.held = None
|
self.held = None
|
||||||
else:
|
else:
|
||||||
|
|
@ -745,7 +875,9 @@ class FreeCellGame:
|
||||||
self.status = "Quick freecell move uses only the bottom card."
|
self.status = "Quick freecell move uses only the bottom card."
|
||||||
return
|
return
|
||||||
self.clear_hint()
|
self.clear_hint()
|
||||||
self.freecells[free_idx] = col.pop()
|
moved_card = col.pop()
|
||||||
|
self.freecells[free_idx] = moved_card
|
||||||
|
self.record_move("col", self.cursor_index, "free", free_idx, [moved_card])
|
||||||
self.status = f"Moved card to free cell {free_idx + 1}."
|
self.status = f"Moved card to free cell {free_idx + 1}."
|
||||||
return
|
return
|
||||||
|
|
||||||
|
|
@ -801,6 +933,10 @@ class FreeCellGame:
|
||||||
else:
|
else:
|
||||||
self.freecells[source[1]] = None
|
self.freecells[source[1]] = None
|
||||||
|
|
||||||
|
self.record_move(
|
||||||
|
source[0], source[1], "foundation", SUITS.index(card.suit), [card]
|
||||||
|
)
|
||||||
|
|
||||||
self.status = f"Moved {card.short_name()} to foundation."
|
self.status = f"Moved {card.short_name()} to foundation."
|
||||||
|
|
||||||
def is_won(self) -> bool:
|
def is_won(self) -> bool:
|
||||||
|
|
@ -1107,15 +1243,22 @@ def draw_help(stdscr, max_y: int) -> None:
|
||||||
y = max_y - 1
|
y = max_y - 1
|
||||||
stdscr.move(y, 0)
|
stdscr.move(y, 0)
|
||||||
stdscr.clrtoeol()
|
stdscr.clrtoeol()
|
||||||
help_text = "Move arrows/hjkl v select y/p/ENT/SPC move ? hint f freecell d foundation Esc cancel q quit"
|
help_text = "Move arrows/hjkl v select y/p/ENT/SPC move u undo ? hint f freecell d foundation Esc cancel q quit"
|
||||||
stdscr.addnstr(y, 2, help_text, max(0, curses.COLS - 4), curses.color_pair(1))
|
stdscr.addnstr(y, 2, help_text, max(0, curses.COLS - 4), curses.color_pair(1))
|
||||||
|
|
||||||
|
|
||||||
|
def format_elapsed_time(seconds: int) -> str:
|
||||||
|
"""Format elapsed seconds as MM:SS."""
|
||||||
|
minutes, seconds = divmod(max(0, seconds), 60)
|
||||||
|
return f"{minutes:02d}:{seconds:02d}"
|
||||||
|
|
||||||
|
|
||||||
def render(stdscr, game: FreeCellGame) -> None:
|
def render(stdscr, game: FreeCellGame) -> None:
|
||||||
"""Redraw the full screen."""
|
"""Redraw the full screen."""
|
||||||
stdscr.erase()
|
stdscr.erase()
|
||||||
max_y, max_x = stdscr.getmaxyx()
|
max_y, max_x = stdscr.getmaxyx()
|
||||||
layout = compute_board_layout(max_x)
|
layout = compute_board_layout(max_x)
|
||||||
|
elapsed_text = f"Time: {format_elapsed_time(game.elapsed_time_seconds())}"
|
||||||
|
|
||||||
title = "mcfreecell 0.1"
|
title = "mcfreecell 0.1"
|
||||||
if len(title) > max_x - 4:
|
if len(title) > max_x - 4:
|
||||||
|
|
@ -1129,6 +1272,16 @@ def render(stdscr, game: FreeCellGame) -> None:
|
||||||
curses.color_pair(1) | curses.A_BOLD,
|
curses.color_pair(1) | curses.A_BOLD,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
timer_x = max(2, max_x - len(elapsed_text) - 2)
|
||||||
|
if timer_x > title_x + len(title):
|
||||||
|
stdscr.addnstr(
|
||||||
|
0,
|
||||||
|
timer_x,
|
||||||
|
elapsed_text,
|
||||||
|
max(0, max_x - timer_x - 1),
|
||||||
|
curses.color_pair(1) | curses.A_BOLD,
|
||||||
|
)
|
||||||
|
|
||||||
if game.visual_mode:
|
if game.visual_mode:
|
||||||
visual_text = "-- VISUAL --"
|
visual_text = "-- VISUAL --"
|
||||||
visual_x = min(max_x - len(visual_text) - 2, title_x + len(title) + 3)
|
visual_x = min(max_x - len(visual_text) - 2, title_x + len(title) + 3)
|
||||||
|
|
@ -1144,7 +1297,14 @@ def render(stdscr, game: FreeCellGame) -> None:
|
||||||
draw_help(stdscr, max_y)
|
draw_help(stdscr, max_y)
|
||||||
|
|
||||||
if game.is_won():
|
if game.is_won():
|
||||||
stdscr.addstr(3, 2, "You won.", curses.color_pair(5) | curses.A_BOLD)
|
win_text = f"You won in {format_elapsed_time(game.elapsed_time_seconds())}."
|
||||||
|
stdscr.addnstr(
|
||||||
|
3,
|
||||||
|
2,
|
||||||
|
win_text,
|
||||||
|
max(0, max_x - 4),
|
||||||
|
curses.color_pair(5) | curses.A_BOLD,
|
||||||
|
)
|
||||||
|
|
||||||
stdscr.refresh()
|
stdscr.refresh()
|
||||||
|
|
||||||
|
|
@ -1239,6 +1399,10 @@ def handle_key(game: FreeCellGame, ch: int) -> bool:
|
||||||
game.drop()
|
game.drop()
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
if ch in (ord("u"), ord("U")):
|
||||||
|
game.undo_last_move()
|
||||||
|
return True
|
||||||
|
|
||||||
if ch == ord("?"):
|
if ch == ord("?"):
|
||||||
game.show_hint()
|
game.show_hint()
|
||||||
return True
|
return True
|
||||||
|
|
@ -1273,6 +1437,7 @@ def curses_main(stdscr) -> None:
|
||||||
"""Main UI entry point."""
|
"""Main UI entry point."""
|
||||||
curses.curs_set(0)
|
curses.curs_set(0)
|
||||||
stdscr.keypad(True)
|
stdscr.keypad(True)
|
||||||
|
stdscr.timeout(100)
|
||||||
|
|
||||||
init_colors()
|
init_colors()
|
||||||
|
|
||||||
|
|
@ -1281,6 +1446,8 @@ def curses_main(stdscr) -> None:
|
||||||
while True:
|
while True:
|
||||||
render(stdscr, game)
|
render(stdscr, game)
|
||||||
ch = stdscr.getch()
|
ch = stdscr.getch()
|
||||||
|
if ch == -1:
|
||||||
|
continue
|
||||||
if not handle_key(game, ch):
|
if not handle_key(game, ch):
|
||||||
break
|
break
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue