Bump version
[raycastlib.git] / README.md
blob6115b7e6ed85363d6dcfdfd194310c76e6744523
1 # raycastlib
3 Ray Casting library for (not only) limited-resource computers.
5 eye-candy previews
6 ------------------
8 Pokitto:
10 ![](/media/pokitto1.gif)
11 ![](/media/pokitto2.gif)
12 ![](/media/pokitto3.gif)
14 SDL:
16 ![](/media/sdl.gif)
18 Arduboy:
20 ![](/media/arduboy.gif)
21 ![](/media/arduboy2.gif)
23 terminal:
25 ![](/media/terminal.gif)
27 features
28 --------
30 - Very fast, small and efficient.
31 - Uses only integer math.
32 - No dependencies (uses only stdint standard library).
33 - Single header, KISS.
34 - Advanced rendering of variable height floor and ceiling.
35 - Textured walls and floor.
36 - Depth information (for fog).
37 - Camera shearing (looking up/down).
38 - Camera movement with collisions.
39 - Support for opening door.
40 - Pure C, tested to run as C++ as well.
41 - Optional framework functions that handle the whole rendering.
42 - Still flexible -- pixels are left for you to draw in any way you want.
43 - Tested on multiple platforms (PC, Arduboy, Pokitto).
44 - Many compile-time options to tune the performance vs quality.
45 - Well commented code.
47 **NOTE**: Backwards compatibility isn't a goal of this libraray. It is meant to
48 be an as-is set of tools that the users is welcome to adjust for their
49 specific project. So new features will be preferred to keeping the same
50 interface.
52 TODO
53 ----
55 - Transparency (conditional ray passing through).
56 - Doors in the middle of squares.
57 - Rolling doors for `RCL_renderComplex`.
58 - Possibly merge all rendering functions into one.
60 license
61 -------
63 Everything is CC0 1.0. Please share your own software as free and open-source.