Metadata-Version: 2.1
Name: twn-solitaire
Version: 0.1.1
Summary: Generic version of 2048 Solitaire. Simple, fun and satisfying game.
Home-page: https://github.com/geckon/2-n_solitaire
Author: Tomáš Heger
Requires-Python: >=3.6,<4.0
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: pygame (>=1.9.6,<2.0.0)
Requires-Dist: toml (>=0.10.0,<0.11.0)
Description-Content-Type: text/markdown

<pre>
  ___  _ __     _____       _ _ _        _
 |__ \| '_ \   / ____|     | (_) |      (_)
    ) |_| |_| | (___   ___ | |_| |_ __ _ _ _ __ ___
   / /         \___ \ / _ \| | | __/ _` | | '__/ _ \
  / /_         ____) | (_) | | | || (_| | | | |  __/
 |____|       |_____/ \___/|_|_|\__\__,_|_|_|  \___|

</pre>

[![Build Status](https://travis-ci.com/geckon/2-n_solitaire.svg?branch=master)](https://travis-ci.com/geckon/2-n_solitaire)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/37d712df43e44d6487bb35e015c27c47)](https://app.codacy.com/app/geckon/2-n_solitaire?utm_source=github.com&utm_medium=referral&utm_content=geckon/2-n_solitaire&utm_campaign=Badge_Grade_Dashboard)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/geckon/2-n_solitaire.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/geckon/2-n_solitaire/alerts/)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/geckon/2-n_solitaire.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/geckon/2-n_solitaire/context:python)
[![Updates](https://pyup.io/repos/github/geckon/2-n_solitaire/shield.svg)](https://pyup.io/repos/github/geckon/2-n_solitaire/)

2<sup>n</sup> Solitaire (or TWN Solitaire) is a simple game inspired by
2048 Solitaire (but more generic) which is inspired by 2048 (but instead of
tiles in a grid you collect cards here). I find the game fun and
satisfying and thus I decided to try and implement it using Pygame. Here we are.

The goal of the game is to stack an endless row of cards into limited-size
columns. Each time you stack two cards of the same value one on the other,
the two cards are replaced by one of double the value and your score grows.
Cards with the maximum value (configurable, see below) will disappear.
The game ends once all the columns are full and so no more cards can be played.

### Controls

![Screenshot](https://github.com/geckon/2-n_solitaire/blob/master/docs/screenshot.png)

This is what the game looks like. At the top you can see your current score,
below that is the main board where the cards are stacked. In the bottom part you
can see two next cards that will come to the game. You can use `1`, `2`, `3` and
`4` keys to place the next upcoming card to the respective column.

That's it. Simple, eh?

### Configuration

There are some configurable options - see
the [default config file](.2-n_solitaire.conf). All options should be described
there including default values which will be used if not specified otherwise.
The game will search for the configuration file in the following locations
(in this order):

-   current working directory

-   home directory

-   directory specified by TWN_SOLITAIRE_CONF_DIR environment
    variable

### Current state

The game works but doesn't do anything fancy or look fancy yet.

### Future plans

-   High score recording
-   Special cards?
-   Limited swapping *next cards*?
-   Limited discarding *next cards*?
-   Saving game state on exit?
-   Better *graphics*?
-   Mouse support?

See/add issues if interested in anything particular.

