diff --git a/README.md b/README.md index dd29fef..e070b06 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,34 @@ Plugin for handle commands from client chat or server console. **Installation**\ Copy `CommandEngine` dir to `Resources/Server/` -* 1 -* 2 -* 3 +**Add command to engine** + +```lua + +-- Plugin body + +function onInit() + + -- Plugin init then + + -- Firstly: Wait to mod initialization + log("Wait CommandEngine init..") + local isCommandEngineReady = false + while not isCommandEngineReady do + local Future = MP.TriggerGlobalEvent("CE_isReady") + while not Future:IsDone() do MP.Sleep(100) end + local result = Future:GetResults() + if result[1] == true then isCommandEngineReady = true end + end + + -- Secondary: Register commands + MP.TriggerGlobalEvent("CE_addCommand", { + ban = { "banUser", "a", { "ban [reason]", "Ban user." }}, + unban = { "unbanUser", "a", { "unban ", "Unban user." }}, + banlist = { "seeBanList", "a", "See ban list on server."} + } + ) + +end +``` +This is real example from [AdminTools](https://github.com/SantaSpeen/AdminTools-BeamMP/blob/master/Resources/Server/AdminTools/AdminTools.lua#L41)