libtcod-cffi 2.1.0

A Python cffi port of libtcod.

Contents

• Status

• About

• Installation

• Usage

• Requirements

  • Extra requirements when installing directly from source

• License

• Changelog

  • 2.1.0 - 2017-02-16

  • 2.0.0 - 2017-02-11

  • 2.0a4 - 2017-01-09

  • 2.0a3 - 2017-01-02

  • 2.0a2 - 2016-10-30

  • 2.0a1 - 2016-10-16

  • 2.0a0 - 2016-10-05

  • 1.0 - 2016-09-25

  • 0.3 - 2016-09-24

  • 0.2.12 - 2016-09-16

  • 0.2.11 - 2016-09-16

  • 0.2.10 - 2016-09-13

  • 0.2.9 - 2016-09-01

  • 0.2.8 - 2016-03-11

  • 0.2.7 - 2016-01-21

  • 0.2.6 - 2015-10-28

  • 0.2.5 - 2015-10-28

  • 0.2.4 - 2015-10-28

  • 0.2.3 - 2015-07-13

  • 0.2.2 - 2015-07-01

  • 0.2.1 - 2015-06-29

  • 0.2.0 - 2015-06-27

  • 0.1.0 - 2015-06-22

Status

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.

The latest documentation can be found here.

This project was spun off from the python-tdl project, and is now it’s own module.

Installation

The recommended way to install is by using pip.

With Python installed, run the following command to install libtcod-cffi:

python -m pip install libtcod-cffi

This is good enough for most Python installations. See the requirements section if you’re building from source.

Usage

This module was designed to be backward compatible with the original libtcod module that is distributed with libtcod. If you had code that runs on the original module you can use this library as a drop-in replacement like this:

import tcod as libtcod

Guides and Tutorials for the original library should also work with this one.

Requirements

• Python 2.7+, Python 3.3+, or PyPy 5.4+

• Windows, Linux, or Mac OS X

• Linux requires the libsdl2 package

Extra requirements when installing directly from source

• MinGW must be on Windows path for use with pycparser. An equivalent C parser must be installed on other OS’s

• Linux requires the packages: libsdl2-dev, libffi-dev, and python-dev

• SDL2 is installed automatically on Windows and Mac OS X

License

libtcod-cffi is distributed under the Simplified 2-clause FreeBSD license. Read LICENSE.txt for more details.

Changelog

2.1.0 - 2017-02-16

Added

• The root Console instance can now be used as a context manager. Closing the graphical window when the context exits.

• Ported libtcod functions: sys_clipboard_get and sys_clipboard_set.

2.0.0 - 2017-02-11

Added

• Random instances can be copied and pickled.

• Map instances can be copied and pickled.

• The Map class now has the transparent, walkable, and fov attribues, you can assign to these as if they were numpy arrays.

• Pathfinders in tcod.path can be given a numpy array as a cost map.

Changed

• Color instances can now be compared with any standard sequence.

Deprecated

• You might see a public cdata attribute on some classes, this attribute will be renamed at anytime.

Removed

• Console.print_str is now Console.print_

• Some Console methods have been merged together.

• All litcod-cffi classes have been moved to their own submodules.

• Random methods renamed to be more like Python’s standard random module.

• Noise class had multiple methods replaced by an implementation attribute.

• libtcod-cffi classes and subpackages are not included in the tcod namespace by default.

• Many redundant methods were removed from the Random class.

• Map methods set_properies, clear, is_in_fov, is_walkable, and is_transparent were remvoed.

• Pathfinding classmethod constructors are gone already. Not it’s just one constructor which accepts multiple kinds of maps.

Fixed

• Python 2 now uses the latin-1 codec when automatically coverting to Unicode.

2.0a4 - 2017-01-09

Added

• Console instances now have the fg,bg,ch attributes. These attributes are numpy arrays with direct access to libtcod console memory.

Changed

• Console default variables are now accessed using properties instead of method calls. Same with width and height.

• Path-finding classes new use special classmethod constructors instead of tradional class instancing.

Removed

• Color to string conversion reverted to its original repr behaviour.

• Console.get_char* methods removed in favor of the fg,bg,ch attributes.

• Console.fill removed. This code was redundant with the new additions.

• Console.get_default_*/set_default_* methods removed.

• Console.get_width/height removed.

Fixed

• Dijkstra.get_path fixed.

2.0a3 - 2017-01-02

• The numpy module is now required as a dependency.

• The SDL.h and libtcod_int.h headers are now included in the cffi back-end.

• Added the AStar and Dijkstra classes with simplified behaviour.

• Added the BSP class which better represents bsp data attributes.

• Added the Image class with methods mimicking libtcodpy behaviour.

• Added the Map class with methods mimicking libtcodpy behaviour.

• Added the Noise class. This class behaves similar to the tdl Noise class.

• Added the Random class. This class provides a large variety of methods instead of being state based like in libtcodpy.

• Color objects can new be converted into a 3 byte string used in libtcod color control operations.

• heightmap functions can now accept carefully formatted numpy arrays.

• Removed the keyboard repeat functions: console_set_keyboard_repeat and console_disable_keyboard_repeat.

2.0a2 - 2016-10-30

• FrozenColor class removed.

• Color class now uses a properly set up __repr__ method.

• Functions which take the fmt parameter will now escape the ‘%’ symbol before sending the string to a C printf call.

• Now using Google-Style docstrings.

• Console class has most of its relevant methods.

• Added the Console.fill function which needs only 3 numpy arrays instead of the usual 7 to cover all Console data.

2.0a1 - 2016-10-16

• The userData parameter was added back. Functions which use it are marked depreciated.

• Python exceptions will now propagate out of libtcod callbacks.

• Some libtcod object oriented functions now have Python class methods associated with them (only BSP for now, more will be added later.)

• Regression tests were added. Focusing on backwards compatibilty with libtcodpy. Several neglected functions were fixed during this.

• All libtcod allocations are handled by the Python garbage collector. You’ll no longer have to call the delete functions on each object.

• Now generates documentation for Read the Docs. You can find the latest documentation for libtcod-cffi here.

2.0a0 - 2016-10-05

• updated to compile with libtcod-1.6.2 and SDL-2.0.4

1.0 - 2016-09-25

• sub packages have been removed to follow the libtcodpy API more closely

• bsp and pathfinding functions which take a callback no longer have the userdata parameter, if you need to pass data then you should use functools, methods, or enclosing scope rules

• numpy buffer alignment issues on some 64-bit OS’s fixed

0.3 - 2016-09-24

• switched to using pycparser to compile libtcod headers, this may have included many more functions in tcod’s namespace than before

• parser custom listener fixed again, likely for good

0.2.12 - 2016-09-16

• version increment due to how extremely broken the non-Windows builds were (false alarm, this module is just really hard to run integrated tests on)

0.2.11 - 2016-09-16

• SDL is now bundled correctly in all Python wheels

0.2.10 - 2016-09-13

• now using GitHub integrations, gaps in platform support have been filled, there should now be wheels for Mac OSX and 64-bit Python on Windows

• the building process was simplified from a linking standpoint, most libraries are now statically linked

• parser module is broken again

0.2.9 - 2016-09-01

• Fixed crashes in list and parser modules

0.2.8 - 2016-03-11

• Fixed off by one error in fov buffer

0.2.7 - 2016-01-21

• Re-factored some code to reduce compiler warnings

• Instructions on how to solve pip/cffi issues added to the readme

• Official support for Python 3.5

0.2.6 - 2015-10-28

• Added requirements.txt to fix a common pip/cffi issue.

• Provided SDL headers are now for Windows only.

0.2.5 - 2015-10-28

• Added /usr/include/SDL to include path

0.2.4 - 2015-10-28

• Compiler will now use distribution specific SDL header files before falling back on the included header files.

0.2.3 - 2015-07-13

• better Color performance

• parser now works when using a custom listener class

• SDL renderer callback now receives a accessible SDL_Surface cdata object.

0.2.2 - 2015-07-01

• This module can now compile and link properly on Linux

0.2.1 - 2015-06-29

• console_check_for_keypress and console_wait_for_keypress will work now

• console_fill_foreground was fixed

• console_init_root can now accept a regular string on Python 3

0.2.0 - 2015-06-27

• The library is now backwards compatible with the original libtcod.py module. Everything except libtcod’s cfg parser is supported.

0.1.0 - 2015-06-22

• First version released