sokoenginepy 0.5.4

Sokoban and variants game utilities

sokoenginepy - Sokoban and variants

This project implements various utilities for Sokoban:

• board representation for Sokoban, Hexoban, Trioban and Octoban variants with support for Sokoban+ and Multiban for all four variants
• movement implementation
• reading and writing of level collections in .sok, .xsb, .tsb, .hsb and .txt file formats

It provides two almost identical implementations:

• sokoneginepy - Python implementation and package
• libsokoengine - C++ library with API that is 99.99% identical to Python

On Linux, Python package can also be optionally built with native extensions so that it utilizes libsokoengine for raw speed.

libsokoengine can be built completely independently, and consumed by native C++ clients.

Why?

• experimenting with Boost.Graph in C++ and NetworkX in Python
• experimenting with pybind11
• playing with Sokoban file formats; conversion and validation, especially for Hexoban variant
• ...

Install

sokoenginepy package from [PyPi]:

pip install sokoenginepy

• libsokoengine can be built from source code, details are in README.libsokoengine.md
• sokoenginepy can be optionally built with native C++ extensions, details are in INSTALL.md

Documentation

• Python usage tutorial
• Python docs
• C++ docs