Metadata-Version: 1.1
Name: sokoenginepy
Version: 0.5.3
Summary: Sokoban and variants game engine
Home-page: https://github.com/tadams42/sokoenginepy
Author: Tomislav Adamic
Author-email: tomislav.adamic@gmail.com
License: GPLv3
Description: sokoenginepy - Sokoban and variants game engine
        ***********************************************
        
        
        
        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
        - reading and writing level collections
            - fully compatible with `SokobanYASC`_ .sok file format and variants (.xsb, .tsb, .hsb, .txt)
        - Optional C++ native bindings using `pybind11`_ and `Boost.Graph`_ for ultimate speed
        
        sokoenginepy was inspired by `SokobanYASC`_, `JSoko`_, MazezaM
        
        Installing
        ----------
        
        Installing sokoenginepy should be as simple as
        
        .. code-block:: sh
        
            pip install sokoenginepy
        
        There is optional C++ native extension that is built automatically with ``pip
        install`` if all dependencies are met. It relies on `Boost.Graph`_ and `pybind11`_. `Boost.Graph`_ needs to be installed on system, everything else is pulled automatically:
        
        .. code-block:: sh
        
            sudo apt install python3-dev libboost-graph-dev
        
        Using
        -----
        
        - For quick glance of features and usage check the `Tutorial`_.
        - For in-depth docs of whole package see `API Reference`_.
        - For C++ library API docs see `C++ API Reference`_
        
        
        .. _pybind11: http://pybind11.readthedocs.io/en/stable/index.html
        .. _NetworkX: https://networkx.github.io/
        .. _Boost.Graph: http://www.boost.org/doc/libs/1_61_0/libs/graph/doc/index.html
        .. _SokobanYASC: https://sourceforge.net/projects/sokobanyasc/
        .. _JSoko: https://www.sokoban-online.de/
        .. _Sokobano: http://sokobano.de/en/index.php
        .. _Sokoban for Windows: http://www.sourcecode.se/sokoban/
        .. _Tutorial: https://sokoenginepy.readthedocs.io/en/latest/tutorial.html
        .. _API reference: https://sokoenginepy.readthedocs.io/en/latest/api.html
        .. _C++ API Reference: http://tadams42.github.io/sokoenginepy/
        
        Changelog
        =========
        
        0.5.3 (2018-02-24)
        ------------------
        * Documentation and build fixes
        
        
        0.5.2 (2017-09-03)
        ------------------
        * Improved native extension build cofiguration process.
        * Upgraded to pybind11 v2.2.0
        
        
        0.5.1 (2017-08-31)
        ------------------
        * Switched from Boost.Python to pybind11 in C++ extension
        
        
        0.5.0 (2017-08-25)
        ------------------
        * added optional C++ native extension (Boost.Graph, Boost.Python)
        
Keywords: game,sokoban,hexoban,octoban,trioban
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Games/Entertainment :: Puzzle Games
