Metadata-Version: 1.1
Name: sokoenginepy
Version: 0.3.0
Summary: Sokoban and variants game engine
Home-page: https://github.com/tadamic/sokoenginepy
Author: Tomislav Adamic
Author-email: tomislav.adamic@gmail.com
License: GPLv3
Description: .. sokoenginepy documentation master file, created by
           sphinx-quickstart on Fri Jul 24 19:41:54 2015.
           You can adapt this file completely to your liking, but it should at least
           contain the root `toctree` directive.
        
        sokoenginepy - Sokoban and variants game engine
        ***********************************************
        
        .. image:: https://img.shields.io/pypi/l/sokoenginepy.svg
            :target: http://opensource.org/licenses/GPL-3.0
            :alt: License
        
        .. image:: https://img.shields.io/pypi/v/sokoenginepy.svg
            :target: https://pypi.python.org/pypi/sokoenginepy
            :alt: PyPI Release
        
        .. image:: https://img.shields.io/pypi/pyversions/sokoenginepy.svg
            :target: https://pypi.python.org/pypi/sokoenginepy
            :alt: Supported Python versions
        
        .. image:: https://readthedocs.org/projects/sokoenginepy/badge/?version=latest
            :target: https://sokoenginepy.readthedocs.org/
            :alt: Documentation
        
        .. image:: https://travis-ci.org/tadamic/sokoenginepy.svg?branch=development
            :target: https://travis-ci.org/tadamic/sokoenginepy
            :alt: TravisCI status
        
        .. image:: https://api.codacy.com/project/badge/Coverage/492a7c08b97e4dbe991b0190dd3abf02
            :target: https://www.codacy.com/app/tomislav-adamic/sokoenginepy?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=tadamic/sokoenginepy&amp;utm_campaign=Badge_Coverage
            :alt: Tests coverage
        
        .. image:: https://api.codacy.com/project/badge/Grade/492a7c08b97e4dbe991b0190dd3abf02
            :target: https://www.codacy.com/app/tomislav-adamic/sokoenginepy?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=tadamic/sokoenginepy&amp;utm_campaign=Badge_Grade
            :alt: Code quality
        
        sokoenginepy is game engine for Sokoban and variants written in Python and
        loaded with features:
        
        - implements game logic for ``Sokoban``, ``Hexoban``, ``Trioban`` and ``Octoban`` variants
            - supports ``Sokoban+`` for all implemented variants
            - supports ``Multiban`` (muliple pushers on board) for all variants
        - two game engines implementations
            - fast and memory lightweight with single step undo/redo
            - somewhat slower and larger with unlimited movement undo/redo
        - reading and writing level collections
            - fully compatible with `SokobanYASC`_ .sok file format and variants (.xsb, .tsb, .hsb, .txt)
        
        sokoenginepy was inspired by `SokobanYASC`_, `JSoko`_, `MazezaM`_
        
        Install
        -------
        
        Installing sokoenginepy should be as simple as
        
        .. code-block:: sh
        
            pip install sokoenginepy
        
        Note that sokoenginepy requires Python 3.4 or newer.
        
        
        Development environment
        -----------------------
        
        .. code-block:: shell
        
            pyvenv .venv
            source .venv/bin/activate
            pip install --upgrade pip
            pip install --upgrade setuptools wheel twine
            pip install -e .[dev,test]
        
        
        .. _SokobanYASC: http://sourceforge.net/projects/sokobanyasc/
        .. _JSoko: http://www.sokoban-online.de/
        .. _MazezaM: http://webpages.dcu.ie/~tyrrelma/MazezaM/
        .. _Sokobano: http://sokobano.de/en/index.php
        .. _Sokoban for Windows: http://www.sourcecode.se/sokoban/
        
Keywords: game sokoban hexoban octoban trioban
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Games/Entertainment :: Puzzle Games
