1
0
Fork 0
mirror of https://github.com/shlomif/PySolFC.git synced 2025-04-05 00:02:29 -04:00
PySolFC/README.md
Shlomi Fish 3541d467be Remove the urpmi lines.
They are not available on most systems and also see
https://github.com/shlomif/PySolFC/issues/81 - they are also mentioned
above.
2018-05-08 10:09:00 +03:00

160 lines
5.4 KiB
Markdown

# 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
http://pysolfc.sourceforge.net/ .
The maintenance branch of PySol FC on GitHub by [Shlomi
Fish](http://www.shlomifish.org/) and by some other
people, has gained official status, ported the code to Python 3,
and implemented some other enhancements.
- [![Build Status](https://travis-ci.org/shlomif/PySolFC.svg)](https://travis-ci.org/shlomif/PySolFC)
[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/04re7umgl3yuukmh?svg=true)](https://ci.appveyor.com/project/shlomif/pysolfc)
# Screenshots
![Image](<http://i.imgur.com/jQkTGwf.jpg>)
## Requirements.
- Python (2.7 or 3.x)
- 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: http://www.pygame.org/ (mp3, ogg, wav, midi, tracker music)
- Other packages (optional):
- Tile (ttk): http://tktable.sourceforge.net/tile/ (0.8.0 or later)
- PIL (Python Imaging Library): http://www.pythonware.com/products/pil
- Freecell Solver: http://fc-solve.shlomifish.org/ .
- [Black Hole Solitaire Solver](http://www.shlomifish.org/open-source/projects/black-hole-solitaire-solver/)
## Installation.
See: http://www.python.org/doc/current/inst/
### Running from source without installation.
You can run from the source directory:
```
python pysol.py
```
After following steps similar to these (on
[Mageia Linux](http://www.mageia.org/) ):
#### Step 1 - install the dependencies
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 -y ack-grep cpanminus libperl-dev make perl python-glade2 python-gnome2 python-gnome2-dev python-gtk2 python-setuptools python-tk
```
#### Step 2 - build PySol.
```
$ 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-2.0.tar.bz2 # Need to be downloaded from sourceforge
$ mkdir -p ~/.PySolFC
$ rmdir ~/.PySolFC/cardsets
$ ln -s "`pwd`/PySolFC-Cardsets-2.0" ~/.PySolFC/cardsets
$ python pysol.py
```
<b>Note!</b> If you are using a Debian derivative (e.g: Debian, Ubuntu, or
Linu 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.
## Alternate toolkit.
- Python2 (2.7 or later)
- Kivy (10.0 or later)
- Features:
- Sound support integrated.
- Android apk build support.
- Running from source without installation:
```
python2 pysol.py --kivy
```
### Configuring Freecell Solver
If you want to use the solver, you should configure freecell-solver
( http://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 (mp3 for example) to ~/.PySolFC/music/
- Original PySol music can be downloaded from:
ftp://ibiblio.org/pub/linux/games/solitaires/pysol-music-4.40.tar.gz
- Cardsets
- Copy cardsets to ~/.PySolFC/cardsets
- Additional cardsets can be downloaded from the PySolFC project page:
http://sourceforge.net/project/showfiles.php?group_id=150718
## Related repositories and links
- [PySol-Sound-Server fork](https://github.com/shlomif/pysol-sound-server)
- [Sources for the PySolFC web site](https://github.com/shlomif/pysolfc-website)
- [PySolFC Announcements Drafts](https://github.com/shlomif/pysolfc-announcements)
- [Extra mahjongg cardsets for PySolFC - originally for flowersol](https://github.com/shlomif/PySol-Extra-Mahjongg-Cardsets)
Related:
- [Freecell Solver](https://github.com/shlomif/fc-solve)
- [Black Hole Solver](https://github.com/shlomif/black-hole-solitaire)
Other open source solitaires:
- [solitaire.gg](https://github.com/KyleU/solitaire.gg) - web-based and written in Scala
- [Solitairey](https://github.com/shlomif/Solitairey/branches) - web-based written in JavaScript
- [KPat](https://games.kde.org/game.php?game=kpat) - desktop-based for KDE.
- [Aisleriot](https://wiki.gnome.org/Apps/Aisleriot) - desktop-based by the GNOME project with relatively limited functionality.
Screencasts:
- [Black Hole solving](https://github.com/shlomif/pysolfc-black-hole-solver--screencast)
- [Freecell solving using the qualified-seed-improved preset](https://bitbucket.org/shlomif/pysolfc-qualified-seed-improved-screencast)
## Chat
To facilitate coordination about contributing to PySol, please join us for a
real time Internet chat on
the <a href="irc://irc.freenode.net/##pysol">##pysol</a> chat room on
[Freenode](http://freenode.net/) (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](https://groups.google.com/forum/#!forum/foss-card-games)
which will also be used for discussing PySol. Feel free to subscribe or post!