aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 9d549b24b6ff8775156c28e4a39550a30534f243 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# LZR
Simple C/C++ game framework based on SDL2.
LZR is used in [my own games](https://kdx.re/games) as a base.
It should stay simple, flexible and easy to grasp at the core.

## dependencies
LZR depends on [SDL2](https://libsdl.org),
and has opt-out dependencies on
[SDL2_gfx](https://www.ferzkopp.net/wordpress/2016/01/02/sdl_gfx-sdl2_gfx/),
[SDL_image 2.0](https://github.com/libsdl-org/SDL_image), and
cmixer.

## usage
Drop lzr.c and lzr.h in a project, add flags for the dependencies
(see this project's Makefile for sane defaults).

Initialize LZR with `LZR_Init()`, quit and cleanup with `LZR_Quit()`.
Header is self documented, see `lzr.h`.

## license
LZR is under the MIT license, see [LICENSE](LICENSE) for details.