BeamMP Server-Side Lua Plugins

How to create and install Lua plugins for server-side scripting on your BeamMP server.

BeamMP supports server-side Lua 5.3 plugins for custom logic, chat commands, events, and automation.

Plugin Structure

main.lua

Each folder in Resources/Server/ is a plugin. Lua files are loaded alphabetically.

function onPlayerJoining(id)
    MP.SendChatMessage(-1, "Welcome, player " .. id .. "!")
end

MP.RegisterEvent("onPlayerJoining", "onPlayerJoining")

Event	Fires when
`onInit`	Plugin loads
`onShutdown`	Server shutting down
`onPlayerAuth(name, role, isGuest, ids)`	Player authenticating (return string to deny)
`onPlayerJoining(id)`	Player joining after mods load
`onPlayerDisconnect(id)`	Player leaves
`onChatMessage(id, name, msg)`	Chat message (return "" to cancel)
`onVehicleSpawn(pid, vid, data)`	Vehicle spawned (return "" to cancel)
`onVehicleEdited(pid, vid, data)`	Vehicle modified

Function	Description
`MP.SendChatMessage(id, msg)`	Send chat (-1 = broadcast)
`MP.GetPlayers()`	Table of id → name
`MP.GetPlayerCount()`	Current player count
`MP.DropPlayer(id, reason)`	Kick player
`MP.RemoveVehicle(pid, vid)`	Delete a vehicle
`MP.GetPositionRaw(pid, vid)`	Get position/rotation/velocity
`MP.TriggerClientEvent(pid, event, data)`	Send event to client
`MP.CreateEventTimer(event, ms)`	Recurring timer

Use the lua console command to open a live Lua interpreter for any running plugin state.