https://github.com/IS4Code/YALP

Yet Another Lua Plugin for SA-MP
https://github.com/IS4Code/YALP

lua pawn-package sa-mp

Last synced: about 2 months ago
JSON representation

Yet Another Lua Plugin for SA-MP

• Host: GitHub
• URL: https://github.com/IS4Code/YALP
• Owner: IS4Code
• License: mit
• Created: 2018-08-16T00:08:04.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-28T16:25:30.000Z (5 months ago)
• Last Synced: 2024-06-29T16:42:11.026Z (5 months ago)
• Topics: lua, pawn-package, sa-mp
• Language: C++
• Size: 431 KB
• Stars: 14
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
YALP v1.1

==========

_YALP_, short for _Yet Another Lua Plugin_, aims to be a simple yet extendable SA-MP plugin allowing to use [Lua](https://www.lua.org/) for SA-MP server programming.

Compared to older Lua plugins, _YALP_ doesn't export any of the SA-MP natives or callbacks directly. Instead, it exposes a set of functions to interact with the server via a virtual filterscript, mimicking calls to AMX functions. The actual server API can be ported entirely with Lua, which removes the need to update the plugin for new versions of SA-MP and maintain all functions, and also allows the use of other plugins.

## Installation

Download the latest [release](//github.com/IllidanS4/YALP/releases/latest) for your platform to the "plugins" directory and add "YALP" (or "YALP.so" on Linux) to the `plugins` line in server.cfg.

Include [YALP.inc](pawno/include/YALP.inc) to create and control Lua machines on-the-fly.

## Building

Use Visual Studio to build the project on Windows, or `make` on Linux.

## Example

```lua

local interop = require "interop"

local native = interop.native

local commands = {}

function commands.lua(playerid, params)

  -- no need to import native functions, simply call them! 

  native.SendClientMessage(playerid, -1, "Hello from Lua!")

  return true

end

function commands.setpos(playerid, params)

  -- even a function from any plugin can be used

  local fail, x, y, z = interop.vacall(native.sscanf, interop.asboolean, params, "fff")(0.0, 0.0, 0.0)

  -- return values can be easily specified

  if fail then

    return native.SendClientMessage(playerid, -1, "Wrong arguments!")

  end

  native.SetPlayerPos(playerid, x, y, z)

  return true

end

function interop.public.OnPlayerCommandText(playerid, cmdtext)

  -- properly convert values to Lua (YALP cannot determine their types)

  playerid = interop.asinteger(playerid)

  cmdtext = interop.asstring(cmdtext)

  

  -- take advantage of everything Lua has to offer

  local ret

  cmdtext:gsub("^/([^ ]+) ?(.*)$", function(cmd, params)

    local handler = commands[string.lower(cmd)]

    if handler then

      ret = handler(playerid, params)

    end

  end)

  return ret

end

```

## Credits

* [Zeex](//github.com/Zeex) for creating [subhook](//github.com/Zeex/subhook), the backbone of this plugin.

* The creators of Lua.