> For the complete documentation index, see [llms.txt](https://vypxl.gitbook.io/scar/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vypxl.gitbook.io/scar/master.md).

# The scar game library

THIS BOOK IS OUTDATED. A new version is WIP, but for now, use this book as a guide through the library, but not as an implementation guide. For that, please refer to the [reference](https://vypxl.github.io/scar/).

This crystal library aims to offer a simple interface for game programming with less boilerplate code. It is built on top of [CrSFML](https://github.com/oprypin/crsfml). I mainly create it for my own games, for my own education and of course for the fun.

Code reference, installation, issues and more are hosted on [github](https://github.com/vypxl/scar).

In this book I will explain the concept of this library and the use of the builtin features. For more detail on builtin classes, functions, etc, please refer to the [reference](https://vypxl.github.io/scar/) or even the [source](https://github.com/vypxl/scar). You can find examples in the [examples](https://github.com/vypxl/scar_examples) repository.

If anything I mention is ambigous, poorly explained or not explained at all, or if you think that any section should be revised/corrected or contains an error, please [open a github issue](https://github.com/vypxl/scar/issues/new).