# SDL_ttf 3.0

This is the SDL3 wiki. SDL2 is [over here](/SDL2_ttf)!

## What is it?

This library is a wrapper around the FreeType and Harfbuzz libraries, allowing you to use TrueType fonts to render text in SDL applications.

This library is distributed under the [zlib license](https://www.libsdl.org/license.php). This license allows you to use it freely in any software.

This library also uses the following libraries:
- FreeType, licensed under the [FTL](https://gitlab.freedesktop.org/freetype/freetype/-/blob/master/docs/FTL.TXT)
- HarfBuzz, licensed under the [MIT license](https://github.com/harfbuzz/harfbuzz/blob/main/COPYING)
- PlutoSVG, licensed under the [MIT license](https://github.com/sammycage/plutosvg/blob/master/LICENSE)
- PlutoVG, licensed under the [MIT license](https://github.com/sammycage/plutovg/blob/master/LICENSE)

Please follow the licenses of any fonts you include in your application, as many of them are copyrighted. The Microsoft fonts, for example, are not freely redistributable.

## Getting and installing SDL_ttf

- The latest preview release is available on [GitHub](https://github.com/libsdl-org/SDL_ttf/releases/preview-3.1.0).
- [Installation](https://github.com/libsdl-org/SDL_ttf/blob/main/INSTALL.md): How to install SDL_ttf on your platform of choice
  and link your program against it.

## API Documentation

- [API quick reference](QuickReference)
- [Complete API index](CategoryAPI)
- [Hello World](https://github.com/libsdl-org/SDL_ttf/blob/main/docs/hello.c) example, with build instructions for your development environment in the [installation instructions](https://github.com/libsdl-org/SDL_ttf/blob/main/INSTALL.md)

## Other sources of information

- [SDL 2.0 Migration Guide](https://github.com/libsdl-org/SDL_ttf/blob/main/docs/README-migration.md)
- [Forums/mailing lists](https://discourse.libsdl.org/) and of course [a Discord server](https://discord.gg/BwpFGBWsv8). Both are great places
  to keep up with the latest news, help other users out, and ask questions.

## Other stuff

We hope you find everything you are looking for and enjoy using SDL_ttf!

If anything is not addressed somewhere here, feel free to
[open an issue](https://github.com/libsdl-org/SDL_ttf/issues) or
[submit a pull request](https://github.com/libsdl-org/SDL_ttf/pulls).

**Enjoy!**