Repository files navigation

libtcod is a free, fast, portable and uncomplicated API for roguelike developers providing a true color console, pathfinding, field-of-view, and a few other utilities frequently used in roguelikes.

This is the easiest way to get the latest stable version of libtcod for any project.

Libtcod is included as a port inVcpkg.You can install libtcod via Vcpkg and then link the library using aCMake script as you normally do for that package manager.

This is the best option for testing the development versions of libtcod.

You can include libtcod in a project by adding the libtcod repository as asubmodule and then adding that directory to aCMake script.You will want to forkthis template project if you plan on starting a project with this setup.

It is expected that Vcpkg will be used, but libtcod's CMake script can be configured to compile without using Vcpkg for dependencies.SeeCONTRIBUTING.md for details on configuring dependencies.

This is not recommend as these releases are unwieldy, are more difficult to update, and are less cross-platform.Do not upload binary files to your projects source repository.

If you are programming in C or C++ thenWindows and MacOS binaries are available from theGitHub Releases page.

Various C/C++ sample projects are included withinthe repository which can be used as examples of various features.

Keep in mind that as a C++ library, you may need to distribute theappropriate runtime with your program such as theVisual Studio 2015 runtimesor else the program will fail to run.

For those who wish to program in Python you can install python-tcod usingthis installation guide.Once installed you can followthe Python 3 tutorialor you can find Python example scripts on thepython-tcod repository.

A alternative version of the Python library (libtcodpy) exists in the binarydownloads, but you should avoid using this version as it is not as wellmaintained.

This is only recommended for libtcod developers.SeeCONTRIBUTING.md.

The latest documentation ishere.Currently it's very incomplete, so most people will want to read the1.6.4 documentationinstead.Python users should use thepython-tcod documentation.

libtcod comes with a sample application, implementations of which are providedin each ofC (samples_c.c),C++ (samples_cpp.cpp),and Python (samples_py.py).This provides a decent overview of the basic features, in an interactivefashion.Each should be identical for the most part, so if you are using Windows,downloading the pre-compiled binaries and running the includedsamples.exewhich is compiled from the C source code, should be representative of the otherversions.

For reporting bugs or requesting features you should use theGitHub Issues page.For smaller questions or help with a tutorial or project you can join#libtcod on theRoguelikes Discord or on theLibera.​Chat IRC.

Sponsors donating $25 or more per month will have their names or logos listed here.

• q00u
• amaya30