About

This is a Python cffi port of libtcod.

This library is hosted on GitHub.

Any issues you have with this module can be reported at the GitHub issue tracker.

Usage

This module was designed to be backward compatible with the original libtcodpy module distributed with libtcod. If you had code that runs on libtcodpy then you can use this library as a drop-in replacement. This installs a libtcodpy module so you’ll only need to delete the libtcodpy/ folder that’s usually bundled in an older libtcodpy project.

Guides and Tutorials for libtcodpy should work with the tcod module.

The latest documentation can be found here.

Installation

The recommended way to install is by using pip. Older versions of pip will have issues installing tcod, so make sure it’s up-to-date.

Windows / MacOS

To install using pip, use the following command:

> python -m pip install tcod

If you get the error “ImportError: DLL load failed: The specified module could not be found.” when trying to import tcod/tdl then you may need the latest Microsoft Visual C runtime.

Linux

On Linux python-tcod will need to be built from source. Assuming you have Python, pip, and apt-get, then you’ll run these commands to install python-tcod and its dependencies to your user environment:

$ sudo apt-get install gcc python-dev python3-dev libsdl2-dev libffi-dev libomp5
$ pip2 install tcod
$ pip3 install tcod

Requirements

  • Python 3.5+
  • Windows, Linux, or MacOS X 10.9+.
  • On Windows, requires the Visual C++ runtime 2015 or later.
  • On Linux, requires libsdl2 (2.0.5+) and libomp5 to run.

License

python-tcod is distributed under the Simplified 2-clause FreeBSD license.