GoreBox Lua Modding

GoreBox v16 addons are Lua scripts running inside the game's sandbox runtime — not legacy DLL injections or unsupported pre-v16 hack packs. F²Games publishes the official GoreBox Modding API documenting spawn registration, input hooks, entity manipulation, and Workshop packaging rules. The canonical documentation lives at gorebox-modding.github.io — bookmark it alongside this wiki's console basics and Command Lookup tool when building your first addon.

Lua addons load from the Mods folder on PC at AppData/LocalLow/F2Games/GoreBox/Mods or from mod.io subscriptions synced automatically. Each addon exposes an entry script executed at map load. Authors register custom entities — GoreDolls, weapons, props — that appear in spawn menus when registration succeeds. Failed scripts log errors viewable through /openConsole after enabling Creator Mode from our Creator Mode guide.

Start a new addon folder with a clear name matching your mod.io listing. Include the entry Lua file defined in the official template — typically registering callbacks for game events such as map load, player spawn, and tick updates. Asset files — textures, audio, mesh bundles — sit beside scripts in predictable subfolders documented on gorebox-modding.github.io.

Use the API's spawn registration functions to add GoreDolls and weapons without overwriting vanilla IDs — duplicate IDs conflict with other subscribed addons from our Workshop ecosystem. Hook player input sparingly; mobile builds expose different touch events than PC keyboard scans. Test cross-platform if you plan to publish Android-compatible listings on mod.io.

Reference vanilla behavior from wiki catalogs — GoreDolls, weapons, and vehicles — when mirroring official stats in custom entities. Reality Crusher interactions may require special casing documented in advanced API sections.

Enable Creator Mode, copy your work-in-progress folder into the Mods directory following our PC installation guide, and launch a lightweight map like Legacy. Open /openConsole immediately to catch load-time exceptions — stack traces cite line numbers in your entry script. Iterate quickly by editing Lua in VS Code or Cursor, saving, and restarting the map without full game reboots when possible.

Use /navgenerate after spawning custom static props so GoreDoll NPCs path on addon geometry — see all commands. Record reproduction clips with motion commands from our motion recording guide when reporting bugs to F²Games or mod.io authors.

Android testing requires ZArchiver deployment from our Android install page — never assume PC-only success implies mobile compatibility.

When your addon passes local testing, package the folder per gorebox-modding.github.io publishing checklist — manifest metadata, preview images, and platform tags. Upload through the mod.io developer portal linked from F²Games community resources. Write clear descriptions listing dependencies, Creator Mode requirements, and whether your script adds custom / commands documented for players on our host and creator commands page.

Update listings promptly after GoreBox patches break API surface areas — subscribers receive notifications when you push new versions. Pair releases with tutorial videos on our custom GoreDolls guide or Map Editor basics when your addon targets those workflows.

Join community Discord servers where F²Games moderators share API change notes faster than wiki updates during rapid patch cycles. Respect asset licenses when bundling third-party textures — DMCA takedowns on mod.io harm the entire ecosystem.

Version your addon folder names during development — append _v1, _v2 suffixes in local test copies so you never confuse which build produced a bug report screenshot. Semantic versioning in mod.io release notes helps players know when breaking API changes require resubscribing after a GoreBox major patch.