search

libtcod / python-tcod

A high-performance Python port of libtcod. Includes the libtcodpy module for backwards compatibility with older projects.
BSD 2-Clause "Simplified" License
410 stars 36 forks source link

Question: Is TDL now abandoned? #33

Closed gcmartinelli closed 6 years ago

gcmartinelli commented 6 years ago

The new documentation linked in this repo states TDL is now a legacy API. Meanwhile some of the examples still use import tdl

HexDecimal commented 6 years ago

The https://python-tdl.readthedocs.io/en/latest/ documentation isn't really new. It's been the main documentation since https://pythonhosted.org/tdl/ no longer accepts documentation updates (that one's permanently stuck on tdl v1.5.2 from May, 2016.) It probably wasn't clear before since you had to click on the 'docs badge' to get to the new documentation until I added another link to it recently.

If you're using the tdl modules and you're not having any performance issues, then you shouldn't worry about converting your code to the new API. You could also mix the API's since there isn't anything equivalent to tdl.event in the new API yet. The tdl API isn't going away, it just hasn't been the focus for a long time.

Things might have been more clear if libtcod-cffi was called tdl2, but it ended up having it's own history and now it's stuck with a silly name. I still update tdl, but it's mostly bug-fixes and pointing tdl functions at the new API. You can still raise suggestions here if there's anything you specifically want from tdl.

gcmartinelli commented 6 years ago

Got it! Thanks for clarifying

nightblade9 commented 6 years ago

So TDL is deprecated? This is confusing. I googled for libtcod-cffi and ended up on a GitHub project page that points back to this project.

HexDecimal commented 6 years ago

I can understand how it's all confusing. Currently the latest versions of libtcodpy, libtcod-cffi, and tdl are in this repository.

libtcod-cffi was split off of this repository, and then latter re-merged back into it. The HexDecimal/libtcod-cffi repository is no longer used and will tell you to come back here.

Deprecation in tdl is per-function. If the function is deprecated then the documentation should point out what you are recommended to use instead (like how the tdl.map and tdl.noise modules will tell you to use tcod.path, tcod.map, and tcod.noise.) If there's no viable replacement for a function then it shouldn't be deprecated.