lume
A lightweight Lua utility library providing essential functions for game development and general programming.
What is lume?
Lume is a lightweight utility library for Lua, specifically geared towards game development. It provides a comprehensive set of functions for common tasks such as math operations, vector calculations, table manipulation, string processing, and functional programming patterns. It solves the problem of reinventing basic utilities by offering a single, well-tested module that enhances Lua's standard library.
Lua developers, particularly those working on game projects (e.g., with LÖVE, PICO-8, or other Lua-based game engines), as well as general Lua scripters who need robust utility functions.
Developers choose Lume for its simplicity, performance, and game-dev focus—it's a single-file library with no dependencies, offering a rich API that fills gaps in Lua's standard library while being easy to integrate and use.
Overview
Lua functions geared towards gamedev
Use Cases
Best For
- Adding common math utilities (clamp, lerp, round) to Lua game projects
- Manipulating and transforming tables (arrays/dictionaries) in Lua scripts
- Implementing vector and geometric calculations for 2D game mechanics
- Writing concise functional-style code with map, filter, and reduce in Lua
- Handling string operations and data serialization in Lua applications
- Live-reloading Lua modules during game development for faster iteration
Not Ideal For
- Projects requiring advanced 3D math or physics simulations beyond basic 2D vectors
- Teams already using comprehensive Lua frameworks like LÖVE that have overlapping utility modules
- Environments with extreme memory constraints where even a single additional file is prohibitive
- Developers needing built-in support for custom data structures like queues, stacks, or sets
Pros & Cons
Pros
Includes clamping, linear interpolation, and vector operations essential for game physics and animations, with clear examples like lume.lerp for smooth transitions.
Supports map, filter, reduce, and chainable operations via lume.chain, enabling expressive data transformation pipelines as demonstrated in the README.
Features lume.hotswap for reloading Lua modules without restarting, speeding up iteration during game development with error handling for failures.
A single Lua file with no dependencies, making it trivial to drop into any project by requiring it, as per the straightforward installation instructions.
Cons
Only handles basic Lua types like booleans, numbers, strings, and tables; lacks utilities for custom objects or advanced structures such as sets or queues.
Error handling is minimal, with functions like lume.randomchoice raising errors on empty tables without configurable fallbacks or robust recovery options.
Missing utilities for networking, file I/O, or advanced math like 3D vectors or matrices, which might require additional libraries for complex game projects.
Frequently Asked Questions
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.