Skip to main content

Scripts

Scripts are self-contained folders that contain two primary entrypoints for code execution in LJE:

  • preinit.lua: This file runs before init.lua runs. Nothing else runs in this file other than other LJE scripts. Anything is safe in this file. However, the GMod Lua API is unavailable, functions defined in Lua will not exist.
  • main.lua: This file runs after init.lua runs. Servers can ship custom code which will already have executed at this point. Be aware and cautious when accessing or running things in this stage.

Generally, you want to create detours in preinit.lua, and general hooks in main.lua. Detours in main.lua risk having scripts caching the old function, there is basically no reason to detour in main.lua, unless you're going after a Lua function which is ill-advised.

Structure​

You can structure your LJE scripts any way you want. lje.require and lje.include searches at the root of the script folder no matter what for simplicity.

This is how the average LJE script may look:

--- hax/
---    detours/
---       capture.lua
---    utils/
---       foo.lua
--- main.lua
--- preinit.lua
--- info.toml

In either main.lua or preinit.lua, this script would require files like so:

-- For running a detour:
lje.require("detours/capture.lua")
-- For getting foo:
local foo = lje.require("utils/foo.lua")

info.toml​

Every script folder requires an info.toml file declaring its name, version, author, and dependencies. See the info.toml reference for the full format.