libtcod a.k.a. "The Doryen Library" is a smallish library designed for writing roguelikes. It provides a bunch of useful functionality such as:
- Text-based graphics API that doesn't suck as much as Curses or OpenGL
- Colours! (like, more than 16)
- Keyboard and mouse input
- Path finding
- Field of view
- Portable (works on linux, windows and mac)
- Lots of other stuff
This project provides Rust bindings for libtcod v1.6.3.
This project follows Semantic Versioning. Since we're
1.0.0 anything goes. The API can change at any time.
Indeed, it probably should change! If you have better ideas on how it make it safer or more familiar to Rust developers, please let us know.
rustdoc on every new commit:
But that's mostly useful for types, function signatures, etc. We don't have much in term of actual docs, but you can always check the official ones:
All raw tcod bindings are available via the
tcod-sys crate. In addition we
want to provide safe (and more in line with the Rust style) wrappers -- if you
can segfault outside of
unsafe blocks, that's a bug. The safe bindings are not
yet complete, however.
- Most of the System layer (FPS, time, fullscreen, screenshots)
- Field of view
- Path finding (both A* and Dijkstra)
- Pseudorandom number generator (prefer the
randcrate, except for places where the API requires the built-in generators)
- Name generator
- Image toolkit
- Line toolkit
- BSP toolkit
Probably Won't Ever Be Implemented Because Rust Provides This Already
- Filesystem utilities
- Compression toolkit (there will probably be a better Rust library for this)
Not Implemented Yet But Should Happen At Some Point In The Future
- Everything else!
How to use this
tcod-rs depends on
libtcod so you need to build or download the official
libtcod version known to work is bundled with
Cargo will build it for you, but you need the build dependencies installed.
Alternatively, you can provide the precompiled libtcod library to override the building process. See below.
tcod-rs, add this to your game's
[dependencies] tcod = "0.15"
Building on Linux
Run the equivalent of:
$ sudo apt-get install gcc g++ make libsdl2-dev $ cd yourgame $ cargo build --release $ cargo run --release
on your distro.
Building a dynamic library
tcod-rs will build the library statically on Linux as including
the code into the executable is usually more convenient. To build a dynamic
library specify the
dynlib feature for
[dependencies.tcod-sys] version = "*" features = ["dynlib"]
Building on Windows (with MSVC)
Make sure you have Visual Studio 2013 or later with the C++ tools option installed. You also need the "MSVC ABI" version of the Rust compiler (as opposed to the "GNU ABI" one).
Then, set up the compilation environment, make sure Rust is in your
PATH and run Cargo:
C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat amd64 set PATH=%PATH%;C:\Program Files (x86)\Rust\bin cd yourgame cargo build --release cargo run --release
Building on Windows (with MinGW)
You have to download and install MinGW. Then, add Rust's and MinGW's bin directories to your path and compile your game:
set PATH=%PATH%;C:\Program Files (x86)\Rust\bin;C:\MinGW\bin cd yourgame cargo build --release cargo run --release
Building on Mac OS X
- Install Homebrew
$ brew install pkg-config sdl2 $ cd yourgame $ cargo build --release $ cargo run --release
This is based on the instructions from Jared McFarland's roguelike tutorial.
To test this, you can clone this repository directly and run the one of the provided examples:
$ git clone https://github.com/tomassedovic/tcod-rs.git $ cd tcod-rs $ cargo run --example keyboard
Using existing binary distribution
If you don't want to build libtcod yourself, you can
instruct Cargo to override the build script. See
from the repository for an example.
NOTE: The official MinGW pre-built libraries (for Windows) don't seem to work with tcod-rs. We're not sure exactly why this is so we'd appreciate anyone's help!
The raw bindings were generated using
rust-bindgen and are located at
src/ffi.rs. The safe (hopefully?) wrapper was built on top of them at
This is far from done, patches to missing functionality wrappers, documentation and examples are very much appreciated. If your patch (any patch -- including typos) gets accepted, you'll get a commit access if you want it.
We accept GitHub as well as regular pull requests (i.e. emailing or tweeting the URL of your feature branch works).
You can regenerate the raw bindings by running:
bindgen -builtins -l tcod include/libtcod.h -o src/ffi.rs
- Bastien Léonard, @bastienleonard, email@example.com
- Darren Kaste, @dkaste, firstname.lastname@example.org
- Edu Garcia, @Arcnor, email@example.com
- Guillermo Galizzi firstname.lastname@example.org
- Gustorn email@example.com
- Jared McFarland, @jaredonline, firstname.lastname@example.org
- Jonny Gilchrist, @jgilchrist
- LaylConway email@example.com
- Moredread firstname.lastname@example.org
- Nikita Pekin
- Paul Sanford, @pmsanford, email@example.com
- Pranz, firstname.lastname@example.org
- Tomas Sedovic, @tomassedovic, email@example.com
- Tomasz Barański, firstname.lastname@example.org
tcod-rs is licensed under WTFPL v2. See
COPYING.txt for the full text of the license (don't worry -- it's really
short and to the point).