REPOSITORY OVERVIEW

Live repository statistics

★ 554Stars

⑂ 118Forks

◯ 114Open issues

◉ 554Watchers

README preview

PySol Fan Club edition

This is an open source and portable (Windows, Linux and Mac OS X) collection of Card Solitaire/Patience games written in Python. Its homepage is https://pysolfc.sourceforge.io/.

The maintenance branch of PySol FC on GitHub by Shlomi Fish and by some other people, has gained official status, ported the code to Python 3, and implemented some other enhancements.

Call for Contributors

Shlomi Fish, who adopted PySol FC, and maintained it for several years, has stepped down as its primary maintainer due to the fact he no longer plays PySol, or other computer card games too much and that it has been a time sink for him. (Also see this Twitter discussion ). We are looking for other contributors and there are still some large-scale features that can be implemented.

Screenshots

Screenshot of PySol FC

Requirements.

Python (3.7 or later)
Tkinter (Tcl/Tk 8.4 or later)
For sound support (optional)
- PySol-Sound-Server fork: https://github.com/shlomif/pysol-sound-server (mp3, wav, tracker music)
- (or: ) PyGame (or PyGame CE): https://www.pygame.org/ (mp3, ogg, wav, midi, tracker music)
Other packages (optional):
- Pillow (Python Imaging Library): https://pillow.readthedocs.io/
- TTKThemes: https://ttkthemes.readthedocs.io/
- Accessible Output 2: https://accessible-output2.readthedocs.io/
- Freecell Solver: https://fc-solve.shlomifish.org/
- Black Hole Solitaire Solver

Installation.

We provide an installer for Windows (requires Windows XP SP3 or higher) as well as an Android package on F-droid.

Running from source without installation.

You can run from the source directory:

python pysol.py

After following steps similar to these (on Mageia Linux ):

Step 1 - install the dependencies

On Fedora you can do:

sudo dnf builddep PySolFC

On Mageia you can do:

sudo urpmi git make pygtk2 pygtk2.0-libglade gnome-python-canvas tkinter

On Debian / Ubuntu / etc. you can do:

sudo apt-get install cpanminus make perl python3-setuptools python3-tk

Step 2 - build PySol.

You can try running:

python3 scripts/linux-install.py

git clone https://github.com/shlomif/PySolFC.git
cd PySolFC
# Now make sure you have installed the dependencies.
gmake test
gmake rules
ln -s data/images images
tar -xvf PySolFC-Cardsets-3.0.tar.bz2 # Needs to be downloaded from sourceforge
mkdir -p ~/.PySolFC
rmdir ~/.PySolFC/cardsets
ln -s "`pwd`/PySolFC-Cardsets-3.0" ~/.PySolFC/cardsets
python pysol.py

Note! If you are using a Debian derivative (e.g: Debian, Ubuntu, or Linux Mint) and you are getting an error of "No cardsets were found !!! Main data directory is [insert dir here] Please check your PySol installation.", then you likely installed the cardsets package which has removed some files that are needed by pysol from source (without the debian modifications).

Please uninstall that package and use the cardsets archive from sourceforge.net per the instructions above.

Installing from source and running in a python venv (virtual environment)

At the moment, this only works on POSIX (Linux, FreeBSD and similar) systems. Windows and Mac users - you'll need to chip in with a script for your system.

1 - Install build prerequisite: pysol-cards

This is kind of stupid and maybe it can be fixed in the future, but for now:

pip install pysol-cards

You may want to use your OS distribution package system instead, for example:

sudo apt-get install python3-pysol-cards

For Pillow compilation, libjpeg headers and libraries need to be available:

sudo apt-get install libjpeg-dev

2 - Clone the source from version control

git clone git://github.com/shlomif/PySolFC.git
cd PySolFC

3 - Create your virtual environment.

PKGTREE=/usr/local/packages/PySolFC # or whatever
export PKGTREE
mkdir -p "$PKGTREE"
( cd "$PKGTREE" && python -m venv ./env )

4 - Run the install script

./contrib/install-pysolfc.sh

5 - Put cardsets into place as above.

6 - Enjoy playing

"$PKGTREE"/env/bin/pysol.py

Alternate toolkit.

Kivy
Features:
- Sound support integrated.
- Android apk build support.
Running from source without installation:

python pysol.py --kivy

Android App

On the basis of Kivy an Android App is also available. You may build your own using appropriate build instructions in README.android and in Directory buildozer.

Some versions will also be published on F-droid.

Configuring Freecell Solver

If you want to use the solver, you should configure freecell-solver ( https://fc-solve.shlomifish.org/ ) by passing the following options to its CMake-based build-system: -DMAX_NUM_FREECELLS=8 -DMAX_NUM_STACKS=20 -DMAX_NUM_INITIAL_CARDS_IN_A_STACK=60.

Install Extras.

Music
Copy some music files (in mp3 format for example) to ~/.PySolFC/music/
Original PySol music can be downloaded from: https://sourceforge.net/projects/pysolfc/files/PySol-Music/
Cardsets
Copy cardsets to ~/.PySolFC/cardsets
Additional cardsets can be downloaded from the PySolFC project page: https://sourceforge.net/projects/pysolfc/files/

Chat

To facilitate coordination about contributing to PySol, please join us for a real time Internet chat on the ##pysol chat room on Freenode (note the double octothorpe/hash-sign/pound-sign). We may set up chat rooms on different services in the future.

In addition, we set up a Google Group for discussing open source card games which will also be used for discussing PySol. Feel free to subscribe or post!