leef-math-cd2025/README.md
David Briscoe b793d24e52 Switch build badge to github actions
We don't use travis anymore, so point the readme to the right badge.

(Missed in 84ff1b315e691069389ebbd7e1abcc054e1987ab.)
2022-03-27 01:11:29 -07:00

1.1 KiB

Cirno's Perfect Math Library

Build Status Coverage Status

Various useful bits of game math. 3D line intersections, ray casting, 2d/3d vectors, 4x4 matrices, quaternions, etc.

Intended to be used with LuaJIT and LÖVE (this is the backbone of LÖVE3D).

Online documentation can be found here or you can generate them yourself using ldoc -c doc/config.ld -o index .

Installation

Clone the repository and require it, or if you prefer luarocks: $ luarocks install --server=http://luarocks.org/dev cpml. Add --tree=whatever for a local install.

Versions

This library has a major compatibility break at version 1.0. Up to version 0.10, composition ab means "apply b, then a" for quaternions and "apply a, then b" for matrices. Now as of version 1.0, the two are consistent and matrix ab means "apply b, then a".