https://github.com/libtcod/python-tcod
A high-performance Python port of libtcod. Includes the libtcodpy module for backwards compatibility with older projects.
https://github.com/libtcod/python-tcod
field-of-view libtcod libtcodpy pathfinding pypy pypy3 python python-library python-tcod python3
Last synced: 8 months ago
JSON representation
A high-performance Python port of libtcod. Includes the libtcodpy module for backwards compatibility with older projects.
- Host: GitHub
- URL: https://github.com/libtcod/python-tcod
- Owner: libtcod
- License: bsd-2-clause
- Created: 2015-03-14T02:26:43.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2025-05-04T12:31:47.000Z (8 months ago)
- Last Synced: 2025-05-04T13:31:20.007Z (8 months ago)
- Topics: field-of-view, libtcod, libtcodpy, pathfinding, pypy, pypy3, python, python-library, python-tcod, python3
- Language: Python
- Homepage:
- Size: 25.6 MB
- Stars: 425
- Watchers: 21
- Forks: 35
- Open Issues: 7
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
.. contents::
:backlinks: top
========
Status
========
|VersionsBadge| |ImplementationBadge| |LicenseBadge|
|PyPI| |RTD| |Codecov| |Pyup| |CommitsSinceLastRelease|
=======
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:
https://python-tcod.readthedocs.io/en/latest/
==============
Installation
==============
Detailed installation instructions are here:
https://python-tcod.readthedocs.io/en/latest/installation.html
For the most part it's just::
pip3 install tcod
==============
Requirements
==============
* Python 3.8+
* Windows, Linux, or MacOS X 10.9+.
* On Linux, requires libsdl2 (2.0.10+).
===========
Changelog
===========
You can find the most recent changelog
`here `_.
=========
License
=========
python-tcod is distributed under the `Simplified 2-clause FreeBSD license
`_.
.. _LICENSE.txt: https://github.com/libtcod/python-tcod/blob/master/LICENSE.txt
.. _python-tdl: https://github.com/libtcod/python-tcod/
.. _cffi: https://cffi.readthedocs.io/en/latest/
.. _numpy: https://docs.scipy.org/doc/numpy/user/index.html
.. _libtcod: https://github.com/libtcod/libtcod
.. _pip: https://pip.pypa.io/en/stable/installing/
.. |VersionsBadge| image:: https://img.shields.io/pypi/pyversions/tcod.svg?maxAge=2592000
:target: https://pypi.python.org/pypi/tcod
.. |ImplementationBadge| image:: https://img.shields.io/pypi/implementation/tcod.svg?maxAge=2592000
:target: https://pypi.python.org/pypi/tcod
.. |LicenseBadge| image:: https://img.shields.io/pypi/l/tcod.svg?maxAge=2592000
:target: https://github.com/HexDecimal/tcod/blob/master/LICENSE.txt
.. |PyPI| image:: https://img.shields.io/pypi/v/tcod.svg?maxAge=10800
:target: https://pypi.python.org/pypi/tcod
.. |RTD| image:: https://readthedocs.org/projects/python-tcod/badge/?version=latest
:target: http://python-tcod.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |Codecov| image:: https://codecov.io/gh/libtcod/python-tcod/branch/master/graph/badge.svg
:target: https://codecov.io/gh/libtcod/python-tcod
.. |Issues| image:: https://img.shields.io/github/issues/libtcod/python-tcod.svg?maxAge=3600
:target: https://github.com/libtcod/python-tcod/issues
.. |Pyup| image:: https://pyup.io/repos/github/libtcod/python-tcod/shield.svg
:target: https://pyup.io/repos/github/libtcod/python-tcod/
:alt: Updates
.. |CommitsSinceLastRelease| image:: https://img.shields.io/github/commits-since/libtcod/python-tcod/latest
:target: https://github.com/libtcod/python-tcod/blob/main/CHANGELOG.md