index.md

OrbisProxy Lua API

Version: 1.0.0

Welcome to the official Lua API documentation for OrbisProxy.
This API allows you to create powerful plugins that integrate directly into the proxy runtime.

Available Modules

• proxy
• scheduler
• http
• json
• os

Available Events

See full documentation in: events.md

Player Object

See full documentation in: player_object.md

Example Plugin

proxy:on("session_connect", function()
    print("Players online:", proxy:getPlayerCount())
end)

Hot Reload Support

Lua plugins are fully hot-reload capable.

Changes to a plugin file are detected automatically and the plugin is reloaded without restarting the proxy. This allows rapid development and live adjustments in production environments.

API Versioning

You can check the Lua API version via:

print(proxy:getApiVersion())

If breaking changes occur, the API version will increment accordingly.