Metadata-Version: 2.1
Name: AEI
Version: 1.3.0
Summary: Arimaa Engine Interface tools
Home-page: https://arimaa.janzert.com/aei
Author: Janzert
Author-email: janzert@janzert.com
License: UNKNOWN
Project-URL: Source Code, https://github.com/janzert/aei
Keywords: Arimaa
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Topic :: Games/Entertainment :: Board Games
Requires-Python: >=2.7
Description-Content-Type: text/x-rst

==========
AEI Readme
==========

This package provides a specification for the Arimaa Engine Interface (AEI).
It also includes some tools for using engines that implement AEI. Including an
interface to the arimaa.com gameroom. A full description of AEI can be found in
the file ``aei-protocol.txt``.

The scripts included for working with an AEI engine are:

``analyze``
  A simple script that runs an engine and has it search a given position or
  move sequence.
``gameroom``
  AEI controller that connects to the arimaa.com gameroom and plays a game.
``postal_controller``
  Keeps a bot making moves as needed in any postal games it is a participant
  in.
``roundrobin``
  Plays engines against each other in a round robin tournament.
``simple_engine``
  Very basic AEI engine, just plays random step moves.

Basic examples of using the scripts can be found in the file ``usage.rst``.

The pyrimaa package also includes modules implementing the controller side of
the AEI protocol (``aei.py``), the Arimaa position representation (as bitboards
in ``board.py`` and x88 in ``x88board.py``), and a few utility functions for
handling Arimaa timecontrols (``util.py``).

If you have python2 and pip on your machine you can install the latest
release with::

    pip install aei

On an operating system with a system supplied python you probably want to keep
the aei install separate from your system installed packages. To accomplish
that you can use either a virtualenv or user install.  A user install is done
simply by adding the ``--user`` option::

    pip install --user aei

AEI may also be built and installed with

    python setup.py install


