Skip to content

Commit db937cd

Browse files
committed
Add tcod and libtcod to the glossary.
1 parent 655e4f9 commit db937cd

File tree

2 files changed

+18
-5
lines changed

2 files changed

+18
-5
lines changed

.vscode/settings.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@
8888
"devel",
8989
"DHLINE",
9090
"dlopen",
91+
"Doryen",
9192
"DTEEE",
9293
"DTEEN",
9394
"DTEES",

docs/glossary.rst

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@ Glossary
1010

1111
These have been deprecated since version `8.5`.
1212

13+
tcod
14+
`tcod` on its own is shorthand for both :term:`libtcod` and all of its bindings including :term:`python-tcod`.
15+
16+
It originated as an acronym for the game the library was first created for:
17+
`The Chronicles Of Doryen <http://www.roguebasin.com/index.php/Doryen>`_
18+
19+
libtcod
20+
This is the original C library which contains the implementations and algorithms used by C programs.
21+
22+
:term:`python-tcod` includes a statically linked version of this library.
23+
1324
libtcod-cffi
1425
This is the `cffi` implementation of libtcodpy, the original was
1526
made using `ctypes` which was more difficult to maintain.
@@ -19,8 +30,10 @@ Glossary
1930
implemented.
2031

2132
python-tcod
22-
`python-tcod` is a superset of the :term:`libtcodpy` API. The major
23-
additions include class functionality in returned objects, no manual
33+
`python-tcod` is the main Python port of :term:`libtcod`.
34+
35+
Originally a superset of the :term:`libtcodpy` API. The major
36+
additions included class functionality in returned objects, no manual
2437
memory management, pickle-able objects, and `numpy` array attributes
2538
in most objects.
2639

@@ -38,14 +51,13 @@ Glossary
3851
This left it impractical for any real use as a roguelike library.
3952

4053
Currently no new features are planned for `tdl`, instead new features
41-
are added to `libtcod` itself and then ported to :term:`python-tcod`.
54+
are added to :term:`libtcod` itself and then ported to :term:`python-tcod`.
4255

4356
:term:`python-tdl` and :term:`libtcodpy` are included in installations
4457
of `python-tcod`.
4558

4659
libtcodpy
47-
`libtcodpy` is more or less a direct port of `libtcod`'s C API to
48-
Python.
60+
:term:`libtcodpy` is more or less a direct port of :term:`libtcod`'s C API to Python.
4961
This caused a handful of issues including instances needing to be
5062
freed manually or else a memory leak would occur, and many functions
5163
performing badly in Python due to the need to call them frequently.

0 commit comments

Comments
 (0)