- Notifications
You must be signed in to change notification settings - Fork0
metayeti/Lime
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
v1.1.0
Lime is a set of tools for data and asset packing intended for C++ game development. It depends onzlib for compression. The Lime datafileformat allows for fast random access.
To create Lime datafiles, build theLime utility in/lime/. You can find the build instructions in the build.txt file.
To unpack datafiles, copy the source file in/unlime/ into your own project and use the provided classes to extract game data from a Lime datafile. Don't forget to linkzlib to your project.
To build the demo, read the build instructions in/demo/.
For a quick tutorial on usage, seeHOWTO.md.
Ideally, Lime should be used for small datafiles but large datafiles (2GB and beyond) are fully supported. Packing enormous (individual) resource files is not recommended as Unlime expands each queried resource fully into memory (streaming is not supported). Packing lots of small resources is fine but packing may take a while when using compression.
You are advised to useunlime_phony.h during development (reads data directly from files but uses the same API asunlime.h). See the demo project's code for documentation (it is commented extensively).
Copyright (c) 2024 Danijel Durakovic
Licensed under the terms of theMIT license