TopGit tracks djsime1/gluapack on GitHub. The project has 18 stars. 📦 Pack hundreds of Garry's Mod Lua files into just a handful
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
gluapack is a program that can pack hundreds of Garry's Mod Lua files into just a handful.
Features
Quick, easy and portable - perfect for a CI/CD pipeline
Requires no serverside or clientside binary module
Speeds up server joining times
Minimizes the impact of your addons to the Lua file limit
Supports server, shared and client realms
100% compatible with the file library, include and CompileFile
Works with relative path includes
Example
This is the result of packing 88 files!
How does it work?
gluapack will locate serverside, clientside and shared files in your addon, according to your configuration.
gluapack will then pack the addon into three parts - serverside, clientside and shared.
The clientside and shared packs will be commented out* and chunked into 64 KiB files.
The gluapack loader will be injected into your addon's autorun folder.
When the server/client loads/spawns in, the loader will unpack all the packed files into a virtual file system stored in garrysmod/data/gluapack/vfs/
Any calls to file library, include and CompileFile will additionally use this virtual file system, therefore seamlessly "injecting" your unpacked addon into the game.
* This is done because on the client the loader reads the clientside/shared chunks from the Lua cache (garrysmod/cache/lua). Lua files do not show up in here until they are compiled. Therefore, the entire file is commented out so that compiling the file triggers no Lua errors, and adds the file to the Lua cache so that gluapack can read it.
Usage
👨💻 CLI
The program has a simple CLI interface which you can view the help of with:
Unix
./gluapack --help
Windows
gluapack.exe --help
📦 Packing
To pack an addon, first (optionally) create a gluapack.json file in your addon's root, and configure gluapack to your needs.
Then, simply run the program with the pack command and the path to your addon's root (the folder containing lua/):
Unix
./gluapack pack "path/to/addon"
Windows
gluapack.exe pack "path/to/addon"
Move lua/gluapack (the packed files) and lua/autorun/*_gluapack_*.lua (the loader file) into your "production"/packed addon. Make sure to delete any files you have packed from your addons, including entry files. They are no longer needed!
📤 Unpacking
To unpack a packed addon, run the program with the unpack command and the path to the packed addon:
Unix
./gluapack unpack "path/to/packed-addon"
Windows
gluapack.exe unpack "path/to/packed-addon"
Configuration
{
// The "unique ID" of your addon.
// This can be any (non-empty) alphanumeric ASCII string.
// If not specified, a hash of your packed addon will be used instead.
"unique_id": null,
// File patterns you want to exclude from being packed.
"exclude": [],
// File patterns you want to pack.
"include_sh": [
"**/*.sh.lua",
"**/sh_*.lua",
],
"include_cl": [
"**/cl_*.lua",
"**/*.cl.lua"
],
"include_sv": [
"**/sv_*.lua",
"**/*.sv.lua"
],
// Entry files - these files will be executed immediately after being unpacked.
"entry_cl": [
"autorun/client/*.lua",
"vgui/*.lua",
"skins/*.lua",
"postprocess/*.lua"
],
"entry_sh": [
"autorun/*.lua"
],
"entry_sv": [
"autorun/server/*.lua"
]
}
Limitations
gluapack requires you to tell it what files should be sent to the client. It performs no analysis on your code to find AddCSLuaFile calls.
gluapack by default will include common file patterns (such as lua/**/sh_*.lua) for networked chunks. See Configuration for more information.
gluapack will cause the client to briefly freeze while spawning into the server to unpack files and build the virtual file system
gluapack requires you to specify entry file(s) (files that will be executed when the addon is unpacked).
gluapack by default will include common file patterns (such as lua/autorun/**.lua) as entry files. See Configuration for more information.
TopGit's last sync did not record any GitHub topics for djsime1/gluapack. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on djsime1/gluapack?
The most recent commit recorded on djsime1/gluapack was 5.2 years ago, based on the GitHub push timestamp. The repository has 11 forks — one of the better signals of community interest.
How many stars does djsime1/gluapack have?
djsime1/gluapack has 18 GitHub stars — refresh the page for the live number, or check github.com/djsime1/gluapack. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What is djsime1/gluapack?
djsime1/gluapack (djsime1/gluapack) is a multi-language project on GitHub. From the project's own README: 📦 Pack hundreds of Garry's Mod Lua files into just a handful
What language is djsime1/gluapack written in?
TopGit's last sync did not record a primary language for djsime1/gluapack. Open the repository on GitHub to see the full breakdown by file extension.
Read full README in the tab above.
Is gluapack worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of gluapack.