open.mp forum - Plugins

[VoiceChat] omp-voice

Sat, 13 Jun 2026 18:15:23 +0000

[RELEASE] omp-voice — Proximity + Radio/Phone Voice Chat for open.mp & SA-MP 0.3.7

What is omp-voice?
omp-voice is a full-featured, server-authoritative voice chat system for open.mp and SA-MP 0.3.7 R5. It brings proximity voice, radio channels, and phone calls to your server — all encrypted, low-latency, and scriptable via Pawn.
GitHub: https://github.com/staark-dev/omp-voice

Features
🎙️ Proximity Voice

Hear nearby players in 3D audio with logarithmic distance falloff and stereo panning
Occlusion support — voices are muffled through walls and closed vehicles
Three preset ranges: Whisper / Normal / Shout, or a custom range per player
Interior and virtual-world gating (you only hear players in the same dimension)

📻 Radio & Phone Channels

Radio filter: bandpass + squelch + half-duplex garble for that authentic feel
Phone filter: narrowband colouring for realistic call audio
Mixed per-listener on the server for perfect control
Speakerphone (
/vspeaker
) — let bystanders hear a phone call out loud

🔒 Security

Per-connect cryptographic token identity (not IP-based)
Every relay↔client datagram sealed with XChaCha20-Poly1305 AEAD encryption
Server is fully authoritative for position, flags, and channels — anti-spoof

🎧 Audio Quality

Opus codec — industry-standard, low-latency voice compression
RNNoise neural noise suppression (enable/disable per client)
Adaptive jitter buffer for smooth playback
Push-to-Talk or Voice Activation modes (exclusive per client)

🖥️ In-Game Client UI (ImGui)

Press INSERT to open the control panel: volumes, devices, PTT key rebind, noise suppression
"Who's talking" HUD (toggle with F8) — see active speakers on-screen
Optional floating labels above player heads while they talk
Per-player local mute and volume control

Architecture
omp-voice uses a hybrid mixing model:

Proximity audio is relayed per-speaker as raw Opus; the client spatialises it locally (lowest latency)
Radio/Phone buses are decoded, filtered, and mixed server-side per listener, then re-encoded and streamed

The system consists of six modules:
Module
Roleshared/
Wire protocol, crypto (libsodium), INI, UDP
core/
Routing engine: proximity, bus router, channels, mix policy
relay/
Standalone relay process — AEAD transport shell
samp/
SA-MP 0.3.7 plugin bridge (Pawn natives)
omp/
open.mp component bridge
client/
Windows
.asi
— WASAPI, Opus, RNNoise, ImGui panel

Installation
Server Side

Drop
plugins/VoiceChat.dll
(SA-MP) or the open.mp component into
components/
Place
voice_relay.exe
alongside the server executable
Copy
qawno/include/voicechat.inc
(+
voicechat_ui.inc
) for your gamemode
Add
voice.ini
(config file — annotated, comes with the release)
Add to
config.json
:
"legacy_plugins": ["VoiceChat"]
or to
server.cfg
for SA-MP

Client Side (each player)

Place
VoiceChat.asi
in the GTA SA folder (requires an ASI loader: SilentPatch, CLEO, etc.)
Edit
voicechat.ini
— set
relay_ip
to the server's IP address

Firewall
Open UDP port 7779 inbound on your server:
# Windows (admin)
netsh advfirewall firewall add rule name="VoiceChat 7779" dir=in action=allow protocol=UDP localport=7779

# Linux
sudo ufw allow 7779/udp

Pawn API (quick overview)

Code:
#include 

#include 

public OnGameModeInit() {

    gProximity = Voice_CreateChannel(VOICE_FILTER_NONE, false);

    return 1;

}

public OnPlayerConnect(playerid) {

    new ip[16]; GetPlayerIp(playerid, ip, sizeof ip);

    Voice_OnPlayerConnect(playerid, ip);

    Voice_AddToChannel(playerid, gProximity);

    Voice_SetPlayerRange(playerid, VOICE_RANGE_NORMAL);

    return 1;

}

public OnPlayerUpdate(playerid) {

    new Float:x, Float:y, Float:z;

    GetPlayerPos(playerid, x, y, z);

    new veh = GetPlayerVehicleID(playerid) ? VOICE_VEH_CLOSED : VOICE_ONFOOT;

    Voice_UpdatePosition(playerid, x, y, z,

        GetPlayerInterior(playerid), GetPlayerVirtualWorld(playerid), veh);

    return 1;

}

public OnPlayerStartTalking(playerid) { VoiceUI_OnStartTalking(playerid); return 1; }

public OnPlayerStopTalking(playerid)  { VoiceUI_OnStopTalking(playerid);  return 1; }

public OnPlayerDisconnect(playerid, reason) {

    Voice_OnPlayerDisconnect(playerid);

    return 1;

}

Key Natives

// Channel management

Voice_CreateChannel(filter, bool:positional, priority = 100);

Voice_AddToChannel(playerid, channelid);

Voice_RemoveFromChannel(playerid, channelid);

// Player control

Voice_SetPlayerRange(playerid, preset, Float:override = 0.0);

Voice_SetPlayerFlags(playerid, bool:muted, bool:deafen, bool:alive, bool:spectator);

Voice_SetMixPolicy(playerid, policy, Float:duckLevel = 0.5, Float:proximityFloor = 0.25);

Voice_MutePlayer(playerid, targetid, bool:mute = true);  // per-pair mute

Voice_SetSpeakerphone(playerid, bool:on = true);

// Lifecycle

Voice_OnPlayerConnect(playerid, const ip[]);

Voice_OnPlayerDisconnect(playerid);

Voice_ReloadConfig();  // reload voice.ini at runtime

In-Game Controls (Client)
Key Action:
B Proximity push-to-talk
N Radio/phone push-to-talk
F9 Self-mute
F8 Toggle "who's talking" HUD
INSERT Open settings panel

All keys are rebindable in the in-game panel.

Building from Source
One-shot Windows build:
powershell -ExecutionPolicy Bypass -File .\build.ps1

Manual CMake (production config, x86):
cmake -S . -B build -A Win32 -DVC_NO_SODIUM=OFF -DVC_WITH_OPUS=ON -DVC_BUILD_CLIENT=ON
cmake --build build --config Release

All third-party dependencies (libsodium, Opus, Dear ImGui, MinHook, RNNoise) are fetched and built automatically by CMake — no manual installs needed.
CI/CD via GitHub Actions builds and tests on every push. Tagged releases (v*) publish ready-to-use bundles automatically.

Current Status
Core engine and all major features are implemented and validated in-game (2-player proximity with occlusion + falloff, radio/phone channels, speakerphone, RNNoise, ImGui panel).
Remaining / planned:

AEC (Acoustic Echo Cancellation) — deferred; headphones avoid the issue for now
Linux 32-bit.so for SA-MP (relay and open.mp component already build on Linux x64)

Download
👉 GitHub Releases: https://github.com/staark-dev/omp-voice/releases

Bundles available:

voicechat-client-win32.zip
— client.asi + voicechat.ini
voicechat-server-win.zip
— server plugin + relay + includes + voice.ini
voicechat-relay-linux-x64.tar.gz
— relay binary for Linux servers

Each bundle includes an
INSTALL.txt.

License
MIT — free to use, modify, and distribute. See LICENSE.

Feedback, bug reports, and pull requests are welcome on GitHub!

MySQL for open.mp

Mon, 01 Jun 2026 21:17:55 +0000

omp-MySQL
A modern, secure MySQL database component for open.mp — clean-room, with an industry-standard API.

Repo: github.com/Mac-Andreas/omp-MySQL
Download (v1.0.0): Releases
Docs / wiki: Wiki

What is it?
A native open.mp component (drops into components/, not a legacy plugin) that lets your Pawn gamemode talk to MySQL — safely. It's inspired by the classic SA-MP-MySQL but rebuilt from scratch for modern MySQL and the open.mp Component SDK.

Why another MySQL plugin?
SA-MP-MySQL (BlueG / maddinat0r) was excellent — for its time. That time was the MySQL 5.x / SA-MP era, and it's been discontinued since ~2019. Modern MySQL changed a lot (default caching_sha2_password auth, mandatory-friendly TLS, utf8mb4), open.mp moved to a modern Component SDK, and security expectations rose. omp-MySQL is a clean-room project built for today's MySQL and open.mp: TLS is on by default, passwords are hashed for you, and player input is injection-safe by construction.

omp-MySQL vs SA-MP-MySQL (BlueG)

	SA-MP-MySQL (BlueG)	omp-MySQL
Plugs into	SA-MP plugin ABI	native open.mp Component SDK
MySQL era	5.x / MariaDB	modern 8.x / 9.x (also runs on 5.7)
Encryption	optional, often off	mandatory TLS, fail-closed (1.3/1.2)
Password hashing	none built in	Argon2id (mysql_hash / mysql_verify)
Injection safety	escape helpers	prepared statements + %e + multi-stmt off
API naming	SA-MP-MySQL specific	industry-standard (JDBC/DB-API style)
Secrets	usually in source	${ENV} expansion + optional obfuscation
Extras	cache, ORM	cache, models, VECTOR search, compression
Status	discontinued (~2019)	active, v1.0.0

Highlights

Mandatory TLS, fail-closed — TLS 1.3 (MySQL 8.0+) / TLS 1.2 (5.7); refuses to connect unencrypted. No plaintext path.
Prepared statements — bound parameters, injection-safe (plus %e escaping; multi-statements off by default).
Argon2id password hashing built in.
Fully async — one worker thread per connection; the main tick never blocks.
Self-contained — MariaDB Connector/C statically linked, OpenSSL bundled. No separate client install.
Result cache, active-record models, MySQL 9 VECTOR similarity search, ${ENV} secrets, opt-in rate/length guards.

Tested

Live MySQL: 5.7.44, 8.0.46, 8.4.9 LTS, 9.2.0 — TLS + queries + prepared statements + caching_sha2 all pass. VECTOR verified on 9.x (it's 9.0+ only).
Memory: clean under AddressSanitizer + UBSan; static leak/UAF/thread audit.
Pentested: SQL injection (login box, registration, command args), auth bypass (rejoin / slot reuse), persistent-login enforcement, privilege bootstrap. Details in the wiki's Security page.

Quick example

Code:
#include 

#include 

new MySQL:g_DB;

public OnGameModeInit()

{

    new MySQLConfig:cfg = mysql_config_create();

    mysql_config_set(cfg, SSL_MODE, SSL_MODE_REQUIRED);  // TLS on

    g_DB = mysql_connect("127.0.0.1", "user", "${OMP_DB_PASS}", "mydb", cfg);

    if (g_DB == MYSQL_INVALID_HANDLE) print("MySQL connection failed.");

    return 1;

}

Install

Windows: unzip the windows package — omp-mysql.dll into components/, and the bundled libssl-3.dll / libcrypto-3.dll next to omp-server.exe.
Linux: omp-mysql.so into components/.
Put omp-mysql.inc in qawno/include/ and #include .

A full login/register admin demo (mysql-admin) ships in the release.

Migrating from SA-MP-MySQL
Same concepts (connect → query → callback → read rows); modern/standard names. Most-used mappings:

SA-MP-MySQL	omp-MySQL
mysql_tquery	mysql_execute
mysql_pquery	mysql_execute_for
mysql_query	mysql_execute_sync
cache_get_value_name_int	mysql_rs_get_int_by
cache_num_rows	mysql_rs_row_count
cache_insert_id	mysql_rs_insert_id
mysql_get_ssl_cipher	mysql_get_tls_cipher
(none)	mysql_prepare / mysql_stmt_set_*
(none)	mysql_hash / mysql_verify
orm_*	mysql_model_*

Two convention changes: prepared-statement params are 1-based, and result values use the mysql_rs_* family. Full guide: Migration.

Docs
The wiki is a full book — from "what is a database?" (with diagrams) through installing MySQL, SQL basics, prepared statements, async patterns, the mysql-admin demo, building from source, and security. There's a one-page cheat sheet too.

Notes

Minimum MySQL 5.7 (first with default TLS). Recommended 8.4 LTS.
32-bit (i386) — the open.mp server arch.
MIT licensed (links the LGPL-2.1 MariaDB Connector/C). No code reused from SA-MP-MySQL.

Feedback, bug reports, and PRs welcome — issues.

omp-MySQL is an independent community project — not affiliated with or endorsed by open.mp or Oracle. "MySQL" is a trademark of Oracle; "open.mp" and "SA-MP" of their respective authors; used here only to describe compatibility.

FCNPC for open.mp - the classic FCNPC API, ported

Tue, 26 May 2026 01:26:27 +0000

FCNPC for open.mp - the classic FCNPC API, ported
Repo: https://github.com/Mac-Andreas/open.mp-FCNPC
Download (DLL + SO + INC + test script): releases/latest

What is this
Fully Controllable NPC - the classic FCNPC FCNPC_* Pawn API, re-implemented for open.mp.

The original FCNPC is a SA-MP plugin: it drives NPCs by patching the samp03svr binary at fixed memory addresses and injecting raw RakNet packets. That cannot work on open.mp - a different, open-source binary with a proper component SDK. open.mp instead ships a built-in NPC engine (INPCComponent).

This component is a compatibility layer: it re-exposes the FCNPC_* natives on top of INPCComponent, plus the remaining ~5% of FCNPC that open.mp's NPC engine does not provide. Existing FCNPC gamemodes run largely unmodified.

Status
All 182 FCNPC_* natives are declared in FCNPC.inc and implemented: 180 ported, 2 pending. Most call open.mp's INPC / INPCComponent / IPlayer directly; the features open.mp lacks are hand-rolled in this component. Full per-native breakdown is in port-status.md.

A couple of the gaps it fills (things bare INPCComponent does not do):

FCNPC_GoToPlayer - open.mp's moveToPlayer defaults autoRestart = false, so the NPC walks to the player's initial spot then stops. This port forces continuous re-tracking, so the NPC keeps chasing a moving player.
FCNPC_SetMoveMode (MAPANDREAS / COLANDREAS) - INPC::move does no terrain grounding (NPCs float / sit on roofs). The component samples ground Z each tick via the companion plugin while the NPC moves.

Nothing falls back to SA-MP.

Install

Download the latest release.
Put FCNPC.dll (Windows) / FCNPC.so (Linux) into your server's components/.
Put FCNPC.inc into your Pawn qawno/include/.
Make sure the NPC component is enabled in config.json (ships with open.mp).

Code:
#include 

#include 

public OnGameModeInit()

{

    new id = FCNPC_Create("Bot");

    FCNPC_Spawn(id, 0, 1958.33, 1343.12, 15.36);

    return 1;

}

public OnPlayerConnect(playerid)

{

    // walk every bot to the new player

    new npcs[100], count = FCNPC_GetValidArray(npcs);

    for (new i = 0; i < count; i++)

        FCNPC_GoToPlayer(npcs[i], playerid, FCNPC_MOVE_TYPE_RUN);

    return 1;

}

Test it in-game (and see exactly what is ported)
The release ships fcnpc_test.pwn (also in the repo under test/). It is two things at once: a feature test that drives every category of the API live, and a showcase of what this port adds over the bare open.mp engine - so you can verify, in-game, the parts of FCNPC that INPCComponent never implemented.

Load it as a filterscript and type /fcnpc for a dialog menu:

Commands - spawn / walk / run / sprint / follow (chase) / aim / shoot / melee / animation / enter+exit vehicle / move-path patrol / play node / invulnerable / kill / respawn / stop all / destroy. One button per native group, run on a demo NPC in front of you.
Config - live tunables (move type/mode/pathfinding/speed, weapon/ammo/reloading/fighting style/accuracy, skin/health/armour, plugin update+tick rate, global ColAndreas/raycast modes) with defaults shown + restore-to-defaults.
Ported features (INPC vs FCNPC) - the important one. It spawns a native INPC NPC and an FCNPC NPC side by side, labelled with floating 3D text ("INPC" / "FCNPC") so you can tell them apart, and lets you fire the same action at both to compare. Every test prints three lines in chat: the intended behaviour, what bare INPC does, and what FCNPC does. Current comparisons:
- Chase / autoRestart - INPC NPC_MoveToPlayer defaults autoRestart = false: it walks to your starting spot and stops, even as you move. FCNPC keeps re-tracking and chasing you. (This is the headline gap the port fills.)
- Rotation - SetAngleToPlayer on the native INPC vs the FCNPC NPC, so the facing/orientation behaviour is directly comparable.
This section is how the "remaining ~5% open.mp's NPC engine does not provide" stops being a claim and becomes something you watch happen.
Debug - on-screen HUD (state, health, weapon, moving, speed, distance to you).

Needs , and - no other dependencies.

Companion plugins
The collision / heightmap / surfing natives call the standalone plugins at runtime (the same companion-plugin model the original FCNPC used) - install the open.mp builds:

MapAndreas (heightmap Z) - Philip
ColAndreas (full map collision / raycasting) - Pottus, uL Chris42O, Slice
Streamer (dynamic objects, for FCNPC_*SurfingDynamicObject) - Incognito

Build from sourceopen.mp's Windows server is x86 and components must use the Microsoft C++ ABI. The repo includes a no-Visual-Studio cross-build (clang-cl + lld against the MSVC SDK via msvc-wine), a Windows CMake path, and a Linux .so path. CI builds FCNPC.dll + FCNPC.so and attaches them with FCNPC.inc to every tagged release.

Credits

Original FCNPC: OrMisicL (2013-2015), ziggi (2016-2024).
open.mp NPC engine (INPCComponent): the open.mp team.
open.mp port: Xyranaut.
Companion plugins: MapAndreas (Philip), ColAndreas (Pottus, uL Chris42O, Slice), Streamer (Incognito).

Bug reports / PRs welcome on the repo. Tested against open.mp 1.5.x.

mysql_samp

Tue, 10 Mar 2026 03:33:51 +0000

mysql_samp - Um plugin MySQL escrito em Rust

Criei esse plugin porque o R41-4 parou de funcionar no meu servidor.

O Problema Real

Em alguns ambientes Linux modernos (Debian 13, AlmaLinux), o socket do MySQL mudou de local. O socket não está mais em

Code:
/tmp/mysql.sock

. Quando tentava conectar com localhost, levava esse erro:

Code:
Conexão falhou — Can't connect to local MySQL server through socket '/tmp/mysql.sock' (2)

O R41-4 simplesmente não consegue encontrar o socket. E pior: tem um bug chato com SSL que ninguém resolveu.

O Bug de SSL

Mesmo que você não esteja usando SSL, o plugin sempre reclama. Coloca a opção como desativado? Continua exigindo. É como se o plugin ignorasse completamente as opções de SSL que você passa.

Basicamente, com essas limitações, o R41-4 virou inútil pra mim.

Por Que Rust

Resolvi fazer do zero porque:
- Encontra socket em qualquer lugar (suporta caminhos customizados)
- Sem libmysqlclient bagunçando tudo
- SSL funciona como deveria (você ativa, ativa; desativa, desativa)
- Código novo, sem bugs antigos carregados

Funciona?

Sim. Testei nos ambientes problemáticos e continua funcionando. Sem aquele erro de socket. Sem aquela brincadeira de SSL.

Links

GitHub: https://github.com/NullSablex/mysql_samp
Releases: https://github.com/NullSablex/mysql_samp/releases

Se alguém tá com o mesmo problema, talvez ajude.

samp-uuid-rs

Sat, 10 Jul 2021 14:20:00 +0000

samp-uuid-rs

This library provides a UUID v4?generator function.

UUIDs are generally used for identifying information that needs to be unique within a system or network thereof. Their uniqueness and low probability in being repeated makes them useful for being associative keys in databases and identifiers for physical hardware within an organization.

Installation

Simply install to your project:

Code:
sampctl package install carlos-menezes/samp-uuid-rs

Include in your code and begin using the library:

Quote:

#include

Usage

Code:
new dest[UUID_LEN];

UUID(dest);

printf("%s", dest); // xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx

Build

To build, run:

Code:
make build

Testing

To test, run:

Code:
make test

SampSharp - Write game modes in .NET Core

Mon, 28 Sep 2020 21:06:38 +0000

SampSharp

Join us on Discord

SampSharp is a plugin and library which allows you to write SA-MP game modes in C#. The plugin works both on Linux and Windows. The library contains various classes for every type of resource available in SA-MP (players, vehicles, textdraws, etc). Aside from this wrapper around native functions, the library also contains a good structure to build your gamemode on. This plugin was initially released in 2014, and has received a good ever since and I'm still available for any questions related to this plugin.

SampSharp provides two structures for developing game modes. SampSharp.GameMode and SampSharp.Entities.

SampSharp.GameMode provides a simple object-oriented structure for developing your game mode. All callbacks are forwarded to the implementation of BaseMode and vanilla callbacks are forwarded as events to the related instances (eg. OnPlayerText fires the PlayerText event on the related Player instance). A simple code sample can be found below.

PHP Code:
public class GameMode : BaseMode

{

? ? protected override void OnPlayerConnected(BasePlayer player, EventArgs e)

? ? {

? ? ? ? base.OnPlayerConnected(player, e);

? ? ? ? player.SendClientMessage($"Welcome {player.Name}, to a whole new world!");

? ? }

? ? [Command("spawn")]

? ? public static void VehicleCommand(BasePlayer player, VehicleModelType model)

? ? {

? ? ? ? Console.WriteLine($"Spawning a {model} for {player.Name}");

? ? ? ? var vehicle = GtaVehicle.Create(model, player.Position  new Vector3(0, 0, 0.5f), player.Rotation.Z);

? ? ? ? player.PutInVehicle(vehicle);

? ? ? ? player.SendClientMessage(Color.GreenYellow, $"You have spawned a {model}!");

? ? }

}

SampSharp.Entities (only available since early 2020) provides an Entity-Component-System structure with full dependency injection support for developing your game mode. SampSharp.Entities is still in active development but is already stable and usable. Below, a similar code sample can be found:

PHP Code:
? ? public class SampleSystem : ISystem

? ? {

? ? ? ? [Event]

? ? ? ? public void OnPlayerConnected(Player player)

? ? ? ? {

? ? ? ? ? ? player.SendClientMessage($"Welcome {player.Name}, to a whole new world!");

? ? ? ? }

? ? ? ? [PlayerCommand("spawn")]

? ? ? ? public static void VehicleCommand(Player player, VehicleModelType model, IWorldService worldService)

? ? ? ? {

? ? ? ? ? ? Console.WriteLine($"Spawning a {model} for {player.Name}");

? ? ? ? ? ? var vehicle = worldService.CreateVehicle(model, player.Position  new Vector3(0, 0, 0.5f), player.Rotation.Z, -1, -1);

? ? ? ? ? ? player.PutInVehicle(vehicle);

? ? ? ? ? ? player.SendClientMessage(Color.GreenYellow, $"You have spawned a {model}!");

? ? ? ? }

? ? }

Download

Stable version:

Unstable version:

https://github.com/ikkentim/SampSharp/releases

Documentation

Our documentation website is still in development and some vital documentation is still lacking. If you need any assistance, feel free to join our Discord server!

https://sampsharp.net

Streamer Plugin by Incognito

Fri, 21 Jun 2019 06:14:18 +0000

Since Incognito does not use these forums and since his Streamer plugin is very important to the community, I am re-posting his thread here.

Quote:Streamer Plugin

This plugin streams objects, pickups, checkpoints, race checkpoints, map icons, and 3D text labels at user-defined server ticks. Basic area detection is also included. Because it is written entirely in C, much of the overhead from PAWN is avoided. This streamer, as a result, is quite a bit faster than any other implementation currently available in PAWN.

Changelog

GitHub Commit History

Refer to the CHANGES file the binary package for the full changelog.

Documentation

GitHub Wiki

Additional information can be found by searching this thread.

Download

GitHub Releases Page

The Windows version requires the?Microsoft Visual C 2015 Redistributable Package.

samp-precise-timers ?: A timer plugin written in Rust

Tue, 21 May 2019 05:36:34 +0000

samp-precise-timers ⌚
github.com/bmisiak/samp-precise-timers

Briefly
Developed for net4game.com (RolePlay), this plugin provides precise timers for the server. It is written in Rust, a memory-safe language.

Why rewrite timers?
I had a lot of safety concerns with some of the existing solutions. They weren't written with data integrity, memory safety or preventing server crashes in mind and seemed to have quite a few bugs. As privacy and safety is our primary concern at net4game, I wrote this in Rust, which combines high-level ergonomics with the performance of a low-level language. ⚡

Please check out the code to see the benefits. You might like Rust a lot. The code is much simpler than C++ equivalents, especially the ones which still use *char, free() and delete[] instead of modern C++ idioms such as std::unique_ptr, but as Rust has no runtime, there is no overhead 😉

We would like your help! 💃
Oh, and if you enjoy working on servers, we are looking for a team to help our international expansion. 🎉 net4game has been around for a decade as the biggest Polish server. We introduced a lot of innovations over the years and we are almost ready to become international. Shoot me an e-mail at bm+code@net4game.com if you're interested.

Downloads on GitHub
Also available on sampctl as

Code:
bmisiak/samp-precise-timers

On top of all of the above, I would love to help with developing open.mp!

pawn env

Sun, 12 May 2019 15:41:18 +0000

pawn-env

Access environment variables in PAWN

Installation

Install to your project:

Code:
sampctl package install dakyskye/pawn-env

include in your code:

Code:
#include 

and start using it.

Usage

At development time, you can use .env file, but in production it’s not recommended.

Example .env file content:

Code:
MYSQL_USER=user

MYSQL_PASSWORD=password

MYSQL_HOST=localhost

MYSQL_DATABASE=database

Using it in the recommended way:

Code:
MYSQL_USER=user MYSQL_PASSWORD=password MYSQL_HOST=localhost MYSQL_DATABASE=database sampctl package run

Code:
$env:MYSQL_USER="user"; $env:MYSQL_PASSWORD="password"; $env:MYSQL_HOST="localhost"; $env:MYSQL_DATABASE="database"; sampctl package run

Code:
docker run -d \

    -e MYSQL_USER=user \

    -e MYSQL_PASSWORD=password \

    -e MYSQL_HOST=localhost \

    -e MYSQL_DATABASE=database \

    --name my-container my/image

API

Code:
native bool:Env_Has(const env[]);

native bool:Env_Get(const env[], dest[], size=sizeof(dest));

bool:Env_Has(const env[]);

It checks if an environment variable with passed name as env exists or not and returns the result as true or false, hence the bool tag.

bool:Env_Get(const env[], dest[], size=sizeof(dest));

It reads the value of the environment variable of passed name as env, then packs it into dest.

Example usage can be found in tests/tests.pwn

Building

First of all, install GNU Make if you haven’t already.

Code:
make build

Code:
docker build -t pawn-env .

docker run -v DISKLETTER:\path\to\pawn-env\plugins:/pawn-env/plugins --name pawn-env pawn-env

An example path from my case: X:\My-Workflow\pawn-env\plugins

Credits

Southclaws - for inspiration (see his pawn-env)
SyS - for boilerplate
ZOTTCE - for samp-rs

sscanf

Sun, 21 Apr 2019 23:34:39 +0000

sscanf 2.8.2

NPC modes

To use sscanf in an NPC mode, download this file:

http://dl.dropbox.com/u/21683085/npcdll.rar

And extract it to your root server directory (so "amxsscanf.dll" is in the same directory as "samp-npc.exe"). Then use as normal. The only tiny difference is that "u", "r", and "q" don't know if a user is a bot or not, so just assume they are all players - use accordingly.

Downloads

GitHub repo (for sscanf 3):

https://github.com/maddinat0r/sscanf/releases

Source, Windows .dll, Linux .so and include:

https://dl.dropboxusercontent.com/u/1025...-2.8.2.zip

Use

This behaves exactly as the old sscanf did, just MUCH faster and much more flexibly. To use it add:

PHP Code:
#include  

To your modes and remove the old sscanf (the new include will detect the old version and throw an error if it is detected). On windows add:

PHP Code:
plugins sscanf 

To server.cfg. On Linux add:

PHP Code:
plugins sscanf.so 

The basic code looks like:

PHP Code:
if (sscanf(params, "ui", giveplayerid, amount))
{
? ?return SendClientMessage(playerid, 0xFF0000AA, "Usage: /givecash  ");
} 

However it should be noted that sscanf can be used for any text processing you like. For example an ini processor could look like (don't worry about what the bits mean at this stage):

PHP Code:
if (sscanf(szFileLine, "p<=>s[8]s[32]", szIniName, szIniValue))
{
? ?printf("Invalid INI format line");
} 

There is also an alternate function name to avoid confusion with the C standard sscanf:

PHP Code:
if (unformat(params, "ui", giveplayerid, amount))
{
? ?return SendClientMessage(playerid, 0xFF0000AA, "Usage: /givecash  ");
} 

Specifiers

The available specifiers (the letters "u", "i" and "s" in the codes above) are below.

? ?

Basic specifiers

Code:
Specifier(s) ? ? ? ? ? ? ? Name ? ? ? ? ? ? ? ? ? Example values

? ?i, d ? ? ? ? Integer ? ? ? ? ? ? ? ? ? ? ? ? ? ?1, 42, -10

? ?c ? ? ? ? ? ?Character ? ? ? ? ? ? ? ? ? ? ? ? ?a, o, *

? ?l ? ? ? ? ? ?Logical ? ? ? ? ? ? ? ? ? ? ? ? ? ?true, false

? ?b ? ? ? ? ? ?Binary ? ? ? ? ? ? ? ? ? ? ? ? ? ? 01001, 0b1100

? ?h, x ? ? ? ? Hex ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?1A, 0x23

? ?o ? ? ? ? ? ?Octal ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?045 12

? ?n ? ? ? ? ? ?Number ? ? ? ? ? ? ? ? ? ? ? ? ? ? 42, 0b010, 0xAC, 045

? ?f ? ? ? ? ? ?Float ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?0.7, -99.5

? ?g ? ? ? ? ? ?IEEE Float ? ? ? ? ? ? ? ? ? ? ? ? 0.7, -99.5, INFINITY, -INFINITY, NAN, NAN_E

? ?u ? ? ? ? ? ?User name/id (bots and players) ? ?Y_Less, 0

? ?q ? ? ? ? ? ?Bot name/id ? ? ? ? ? ? ? ? ? ? ? ?ShopBot, 27

? ?r ? ? ? ? ? ?Player name/id ? ? ? ? ? ? ? ? ? ? Y_Less, 42

? ?

Strings

The specifier "s" is used, as before, for strings - but they are now more advanced. As before they support collection, so doing:

PHP Code:
sscanf("hello 27", "si", str, val); 

Will give:

Code:
hello

27

Doing:

PHP Code:
sscanf("hello there 27", "si", str, val); 

Will fail as "there" is not a number. However doing:

PHP Code:
sscanf("hello there", "s", str); 

Will give:

Code:
hello there

Because there is nothing after "s" in the specifier, the string gets everything. To stop this simply add a space:

PHP Code:
sscanf("hello there", "s ", str); 

Will give:

Code:
hello

You can also escape parts of strings with "\\" - note that it is two backslashes as 1 is used by the compiler:

PHP Code:
sscanf("hello\\ there 27", "si", str, val); 

Will give:

Code:
hello there

27

All these examples however will give warnings in the server as the new version has array sizes. The above code should be:

PHP Code:
new
? ?str[32],
? ?val;
sscanf("hello\\ there 27", "s[32]i", str, val); 

As you can see - the format specifier now contains the length of the target string, ensuring that you can never have your strings overflow and cause problems. This can be combined with the SA:MP compiler's stringizing:

PHP Code:
#define STR_SIZE 32
new
? ?str[STR_SIZE],
? ?val;
sscanf("hello\\ there 27", "s[" #STR_SIZE "]i", str, val); 

So when you change your string size you don't need to change your specifiers.

What happened to "z", the optional string? z has been removed (you can still use it but will get a server warning) to make way for the new optional parameter system described later on.

? ?

Arrays

One of the advanced new specifiers is "a", which creates an array, obviously. The syntax is similar to that of strings and, as you will see later, the delimiter code:

PHP Code:
new
? ?arr[5];
sscanf("1 2 3 4 5", "a[5]", arr); 

The "a" specifier is immediately followed by a single type enclosed in angle brackets - this type can be any of the basic types listed above. It is the followed, as with strings now, by an array size. The code above will put the numbers 1 to 5 into the 5 indexes of the "arr" array variable.

Arrays can now also be combined with strings (see below), specifying the string size in the array type:

Code:
a[12]

This will produce an array of 12 strings, each up to 10 characters long (9 NULL). Optional string arrays still follow the optional array syntax:

Code:
A(hello)[12]

However, unlike numbers you can't specify a progression and have it fill up. This code:

Code:
A(0, 1)[4]

Will by default produce:

Code:
0, 1, 2, 3

However, this code:

Code:
A(hi, there)[4]

Will by default produce:

Code:
"hi, there", "hi, there", "hi, there", "hi, there"

As normal, you can add brackets in to the default string value with "\)":

Code:
A(hi (code\))[4]

It should also be noted that there is NO length checking on default strings. If you do:

Code:
A(This is longer than 10 characters)[4]

You will probably just corrupt the PAWN stack. The length checking is to ensure no users enter malicious data; however, in this case it is up to the scripter to ensure that the data is correct as they are the only one affecting it and shouldn't be trying to crash their own server. Interestingly, arrays of strings actually also work with jagged arrays and arrays that have been shuffled by Slice's quicksort function (this isn't a side-effect, I specifically wrote them to do so).

? ?
Enums

This is possibly the most powerful addition to sscanf ever. This gives you the ability to define the structure of an enum within your specifier string and read any data straight into it. The format takes after that of arrays, but with more types - and you can include strings in enums (but not other enums or arrays):

PHP Code:
enum ? ?E_DATA { ? ?E_DATA_C, ? ?Float:E_DATA_X, ? ?E_DATA_NAME[32], ? ?E_DATA_Z } main { ? ?new ? ? ? ?var[E_DATA]; ? ?sscanf("1 12.0 Bob c", "e", var); }

Now I'll be impressed if you can read that code straight off, so I'll explain it slowly:

PHP Code:
e - Start of the "enum" type < - Starts the specification of the structure of the enum i - An integer, corresponds with E_DATA_C f - A float, corresponds with E_DATA_X s[32] - A 32 cell string, corresponds with E_DATA_NAME c - A character, corresponds with E_DATA_Z > - End of the enum specification

Note that an enum doesn't require a size like arrays and strings - it's size is determined by the number and size of the types. Most, but not all, specifiers can be used inside enums (notably arrays and other enums can't be).

? ?
Quiet

The two new specifiers "{" and "}" are used for what are known as "quiet" strings. These are strings which are read and checked, but not saved. For example:

PHP Code:
sscanf("42 -100", "{i}i", var);

Clearly there are two numbers and two "i", but only one return variable. This is because the first "i" is quiet so is not saved, but affects the return value. The code above makes "var" "-100". The code below will fail in an if check:

PHP Code:
sscanf("hi -100", "{i}i", var);

Although the first integer is not saved it is still read - and "hi" is not an integer. Quiet zones can be as long as you like, even for the whole string if you only want to check values are right, not save them:

PHP Code:
sscanf("1 2 3", "i{ii}", var); sscanf("1 2 3", "{iii}"); sscanf("1 2 3", "i{a[2]}", var);

You can also embed quiet sections inside enum specifications:

PHP Code:
sscanf("1 12.0 Bob 42 INFINITY c", "e", var);

Quiet sections cannot contain other quiet sections, however they can include enums which contain quiet sections.

? ?
Searches

Searches were in the last version of sscanf too, but I'm explaining them again anyway. Strings enclosed in single quotes (') are scanned for in the main string and the position moved on. Note that to search for a single quote you escape it as above using "\\":

PHP Code:
sscanf("10 11 woo 12", "i'woo'i", var0, var1);

Gives:

Code:
10 12

You could achieve the same effect with:

PHP Code:
sscanf("10 11 woo 12", "i{is[1000]}i", var0, var1);

But that wouldn't check that the string was "woo". Also note the use of "1000" for the string size. Quiet strings must still have a length, but as they aren't saved anywhere you can make this number as large as you like to cover any eventuality. Enum specifications can include search strings.

? ?
Enums

This is a feature similar to quiet sections, which allows you to skip overwriting certain parts of an enum:

Code:
e

Here the "-" is a "minus", and tells sscanf that there is an enum element there, but not to do anything, so if you had:

PHP Code:
enum E { ? ?E_A, ? ?E_B, ? ?E_C, ? ?E_D, ? ?E_E }

And you only wanted to update the first two and the last fields and leave all others untouched you could use that specifier above. This way sscanf knows how to skip over the memory, and how much memory to skip. Note that this doesn't read anything, so you could also combine this with quiet sections:

Code:
e

That will read two values and save them, skip over two memory locations, read two values and NOT save them, then read and save a last value. In this way you can have written down all the values for every slot in the enum, but have only used 3 of them. Note that this is the same with "E" - if you do:

Code:
E

You should ONLY specify THREE defaults, not all five:

Code:
E(11, 22, 55)

? ?
Delimiters

The previous version of sscanf had "p" to change the symbol used to separate tokens. This specifier still exists but it has been formalised to match the array and enum syntax. What was previously:

PHP Code:
sscanf("1,2,3", "p,iii", var0, var1, var2);

Is now:

PHP Code:
sscanf("1,2,3", "p<,>iii", var0, var1, var2);

The old version will still work, but it will give a warning. Enum specifications can include delimiters, and is the only time "<>"s are contained in other "<>"s:

PHP Code:
sscanf("1 12.0 Bob,c", "es[32]c>", var);

Note that the delimiter will remain in effect after the enum is complete. You can even use ">" as a specifier by doing "p<\>>" (or the older "p>").

When used with strings, the collection behaviour is overruled. Most specifiers are still space delimited, so for example this will work:

PHP Code:
sscanf("1 2 3", "p<;>iii", var0, var1, var2);

Despite the fact that there are no ";"s. However, strings will ONLY use the specified delimiters, so:

PHP Code:
sscanf("hello 1", "p<->s[32]i", str, var);

Will NOT work - the variable "str" will contain "hello 1". On the other hand, the example from earlier, slightly modified:

PHP Code:
sscanf("hello there>27", "p<>>s[32]i", str, var);

WILL work and will give an output of:

Code:
hello there 27

You can now have optional delimiters using "P" (upper case "p" to match other "optional" specifiers). These are optional in the sense that you specify multiple delimiters and any one of them can be used to end the next symbol:

PHP Code:
sscanf("(4, 5, 6, 7)", "P<(),>{s[2]}iiii", a, b, c, d);

This uses a "quiet section" to ignore anything before the first "(", and then uses multiple delimiters to end all the text. Example:

PHP Code:
sscanf("42, 43; 44@", "P<,;@>a[3]", arr);

? ?
Optional specifiers

EVERY format specifier (that is, everything except '', {} and p) now has an optional equivalent - this is just their letter capitalised, so for example the old "z" optional string specifier is now "S" (there is still "z" and, for completeness, "Z", but both give warnings). In addition to optional specifiers, there are also now default values:

PHP Code:
sscanf("", "I(12)", var);

The "()"s (round brackets) contain the default value for the optional integer and, as the main string has no data, the value of "var" becomes "12". Default values come before array sizes and after specifications, so an optional array would look like:

PHP Code:
sscanf("1 2", "A(3)[4]", arr);

Note that the size of the array is "4" and the default value is "3". There are also two values which are defined, so the final value of "arr" is:

Code:
1, 2, 3, 3

Array default values are clever, the final value of:

PHP Code:
sscanf("", "A(3,6)[4]", arr);

Will be:

Code:
3, 6, 9, 12

The difference between "3" and "6" is "3", so the values increase by that every index. Note that it is not very clever, so:

PHP Code:
sscanf("", "A(1,2,2)[4]", arr);

Will produce:

Code:
1, 2, 2, 2

The difference between "2" and "2" (the last 2 numbers in the default) is 0, so there will be no further increase. For "l" (logical) arrays, the value is always the same as the last value, as it is with "g" if the last value is one of the special values (INFINITY, NEG_INFINITY (same as -INFINITY), NAN or NAN_E). Note that:

PHP Code:
sscanf("", "a(1,2,2)[4]", arr);

Is invalid syntax, the "A" must be the capital part.

Enums can also be optional:

PHP Code:
sscanf("4", "E(1, 12.0, Bob, c)", var);

In that code all values except "4" will be default. Also, again, you can escape commas with "\\" in default enum strings. Some final examples:

PHP Code:
sscanf("1", "I(2)I(3)I(4)", var0, var1, var2); sscanf("", "O(045)H(0xF4)B(0b0100)U(Y_Less)", octnum, hexnum, binnum, user); sscanf("0xFF", "N(0b101)");

That last example is of a specifier not too well described yet - the "number" specifier, which will work out the format of the number from the leading characters (0x, 0b, 0 or nothing). Also note that the second example has changed - see the next section.

? ?
Users

The "u", "q", and "r" specifiers search for a user by name or ID. The method of this search has changed in the latest versions of "sscanf".

Additionally "U", "Q", and "R" used to take a name or ID as their default value - this has since been changed to JUST a number, and sscanf will not try and determine if this number is online:

Previous:

PHP Code:
sscanf(params, "U(Y_Less)", id); if (id == INVALID_PLAYER_ID) { ? ?// Y_Less or the entered player is not connected. }

New:

PHP Code:
sscanf(params, "U(-1)", id); if (id == -1) { ? ?// No player was entered. } else if (id == INVALID_PLAYER_ID) ? ?// Entered player is not connected. }

See the section on options for more details.

Users can now optionally return an ARRAY of users instead of just one. This array is just a list of matched IDs, followed by "INVALID_PLAYER_ID". Given the following players:

Code:
0) Y_Less 1) [CLAN]Y_Less 2) Jake 3) Alex 4) Hass

This code:

PHP Code:
new ids[3], i; if (sscanf("Le", "?u[3]", ids)) printf("Error in input"); for (i = 0; ids[i] != INVALID_PLAYER_ID; ) { ? ?if (ids[i] == cellmin) ? ?{ ? ? ? ?printf("Too many matches"); ? ? ? ?break; ? ?} ? ?printf("id = %d", ids[i]); } if (i == 0) printf("No matching players found.");

Will output:

Code:
id = 0 id = 1 Too many matches

Searching "Les" instead will give:

Code:
id = 0 id = 1

And searching without "MATCH_NAME_PARTIAL" will give:

Code:
No matching players found.

Basically, if an array of size "N" is passed, this code will return the first N-1 results. If there are less than "N" players whose name matches the given name then that many players will be returned and the next slot will be "INVALID_PLAYER_ID" to indicate the end of the list. On the other hand if there are MORE than "N - 1" players whose name matches the given pattern, then the last slot will be "cellmin" to indicate this fact.

When combined with "U" and returning the default, the first slot is always exactly the default value (even if that's not a valid connected player) and the next slot is always "INVALID_PLAYER_ID".

Note also that user arrays can't be combined with normal arrays or enums, but normal single-return user specifiers still can be.

? ?
Custom (kustom) specifiers

The latest version of sscanf adds a new "k" specifier to allow you to define your own specifers in PAWN:

PHP Code:
SSCANF:playerstate(string[]) { ? ?if ('0' <= string[0] <= '9') ? ?{ ? ? ? ?new ? ? ? ? ? ?ret = strval(string); ? ? ? ?if (0 <= ret <= 9) ? ? ? ?{ ? ? ? ? ? ?return ret; ? ? ? ?} ? ?} ? ?else if (!strcmp(string, "PLAYER_STATE_NONE")) return 0; ? ?else if (!strcmp(string, "PLAYER_STATE_ONFOOT")) return 1; ? ?else if (!strcmp(string, "PLAYER_STATE_DRIVER")) return 2; ? ?else if (!strcmp(string, "PLAYER_STATE_PASSENGER")) return 3; ? ?else if (!strcmp(string, "PLAYER_STATE_WASTED")) return 7; ? ?else if (!strcmp(string, "PLAYER_STATE_SPAWNED")) return 8; ? ?else if (!strcmp(string, "PLAYER_STATE_SPECTATING")) return 9; }

The code above, when added to the top level of your mode, will add the "playerstate" specifier, allowing you to do:

PHP Code:
sscanf(params, "uk", playerid, state);

This system supports optional custom specifiers with no additional PAWN code:

PHP Code:
sscanf(params, "uK(PLAYER_STATE_NONE)", playerid, state);

The new version of "sscanf2.inc" includes functions for "k" and "k" allowing you to enter either the ID or name and get the ID back, but both are VERY basic at the moment and I expect other people will improve on them.

Note that custom specifiers are not supported in either arrays or enumerations.

Note also that custom specifiers always take a string input and always return a number, but this can be a Float, bool, or any other single cell tag type.

The optional kustom specifier "K" takes a default value that is NOT (as of sscanf 2.8) parsed by the given callback:

Code:
K(999)

"999" is NOT a valid vehicle model, but if no other value is supplied then 999 will be returned, allowing you to differentiate between the user entering an invalid vehicle and not entering anything at all.

Also as of sscanf 2.8, "k" can be used in both arrays and enums.

Options

The latest version of sscanf introduces several options that can be used to customise the way in which sscanf operates. There are two ways of setting these options - globally and locally:

PHP Code:
SSCANF_Option(SSCANF_QUIET, 1);

This sets the "SSCANF_QUIET" option globally. Every time "sscanf" is called the option (see below) will be in effect. Note that the use of:

Code:
SSCANF_QUIET

Instead of a string as:

Code:
SSCANF_QUIET

Is entirely valid here - all the options are defined in the sscanf2 include already.

Alternatively you can use "?" to specify an option locally - i.e. only for the current sscanf call:

PHP Code:
sscanf(params, "si", str, num); sscanf(params, "?si", str, num); sscanf(params, "si", str, num);

Obviously "s" without a length is deprecated, and the first and last "sscanf" calls will give a warning in the console, but the second one won't as for just that one call prints have been disabled. The following code disables prints globally then enables them locally:

PHP Code:
SSCANF_Option(SSCANF_QUIET, 1); sscanf(params, "si", str, num); sscanf(params, "?si", str, num); sscanf(params, "si", str, num);

Note that disabling prints is a VERY bad idea when developing code as you open yourself up to unreported buffer overflows when no length is specified on strings less than 32 cells (the default length).

To specify multiple options requires multiple calls:

PHP Code:
SSCANF_Option(SSCANF_QUIET, 1); SSCANF_Option(MATCH_NAME_PARTIAL, 0); sscanf(params, "??s[10]i", str, num);

The options are:

? ?
OLD_DEFAULT_NAME:

? ?The behaviour of "U", "Q", and "R" have been changed to take any number as a default, instead of a connected player. Setting "OLD_DEFAULT_NAME" to "1" will revert to the old version.

? ?
MATCH_NAME_PARTIAL:

? ?Currently sscanf will search for players by name, and will ALWAYS search for player whose name STARTS with the specified string. If you have, say "[CLAN]Y_Less" connected and someone types "Y_Less", sscanf will not find "[CLAN]Y_Less" because there name doesn't start with the specified name. This option, when set to 1, will search ANYWHERE in the player's name for the given string.

? ?
CELLMIN_ON_MATCHES:

? ?Whatever the value of "MATCH_NAME_PARTIAL", the first found player will always be returned, so if you do a search for "_" on an RP server, you could get almost anyone. To detect this case, if more than one player will match the specified string then sscanf will return an ID of "cellmin" instead. This can be combined with "U" for a lot more power:

? ?
PHP Code:
? ?sscanf(params, "?U(-1)", id); ? ?if (id == -1) ? ?{ ? ? ? ?// No player was entered. ? ?} ? ?else if (id == cellmin) ? ?{ ? ? ? ?// Multiple matches found ? ?} ? ?else if (id == INVALID_PLAYER_ID) ? ?{ ? ? ? ?// Entered player is not connected. ? ?} ? ?else ? ?{ ? ? ? ?// Found just one player. ? ?} ? ?

? ?
SSCANF_QUIET:

? ?Don't print any errors to the console. REALLY not recommended unless you KNOW your code is stable and in production.

? ?
OLD_DEFAULT_KUSTOM:

? ?As with "U", "K" used to require a valid identifier as the default and would parse it using the specified callback, so this would NOT work:

? ?
Code:
? ?K(Veyron) ? ?

? ?Because that is not a valid vehicle name in GTA. The new version now JUST takes a number and returns that regardless:

? ?[code
? ?K(9999)
? ?[/code]

? ?This setting reverts to the old behaviour.

All specifiers

For quick reference, here is a list of ALL the specifiers and their use:

Code:
[b][u]Format[/u][/b] [b][u]Use[/u][/b] L(true/false) Optional logical truthity l Logical truthity K(any format number) ? ? ? ?Optional custom operator k Custom operator B(binary) Optional binary number b Binary number N(any format number) Optional number n Number C(character) Optional character c Character I(integer) Optional integer i Integer D(integer) Optional integer d Integer H(hex value) Optional hex number h Hex number O(octal value) Optional octal value o Octal value F(float) Optional floating point number f Floating point number G(float/INFINITY/-INFINITY/NAN/NAN_E) Optional float with IEEE definitions g Float with IEEE definitions { Open quiet section } Close quiet section P Multiple delimiters change p Delimiter change Z(string)[length] Invalid optional string z(string)[length] Deprecated optional string S(string)[length] Optional string s[length] String U(any format number) Optional user (bot/player) u User (bot/player) Q(any format number) Optional bot (bot) q Bot (bot) R(any format number) Optional player (player) r Player (player) A(default)[length] Optional array of given type a[length] Array of given type E(default) Optional enumeration of given layout e Enumeration of given layout 'string' Search string % Deprecated optional specifier prefix ? Local options specifier

"extract"

I've written some (extendable) macros so you can do:

PHP Code:
extract params -> new a, string:b[32], Float:c; else { ? ?return SendClientMessage(playerid, COLOUR_RED, "FAIL!"); }

This will compile as:

PHP Code:
new a, string:b[32], Float:c; if (unformat(params, "is[32]f", a, b, c)) { ? ?return SendClientMessage(playerid, COLOUR_RED, "FAIL!"); }

Note that "unformat" is the same as "sscanf", also note that the "SendClientMessage" part is optional:

PHP Code:
extract params -> new a, string:b[32], Float:c;

Will simply compile as:

PHP Code:
new a, string:b[32], Float:c; unformat(params, "is[32]f", a, b, c);

Basically it just simplifies sscanf a little bit (IMHO). I like new operators and syntax, hence this, examples:

PHP Code:
// An int and a float. extract params -> new a, Float:b; // An int and an OPTIONAL float. extract params -> new a, Float:b = 7.0; // An int and a string. extract params -> new a, string:s[32]; // An int and a playerid. extract params -> new a, player:b;

As I say, the syntax is extendable, so to add hex numbers you would do:

PHP Code:
#define hex_EXTRO:%0##%1,%2|||%3=%9|||%4,%5) EXTRY:%0##%1H"("#%9")"#,%2,%3|||%4|||%5) #define hex_EXTRN:%0##%1,%2|||%3|||%4,%5) EXTRY:%0##%1h,%2,%3|||%4|||%5) #define hex_EXTRW:%0##%1,%2|||%3[%7]|||%4,%5) EXTRY:%0##%1a[%7],%2,%3|||%4|||%5)

That will add the tag "hex" to the system. Yes, the lines look complicated (because they are), but the ONLY things you need to change are the name before the underscore and the letter near the middle ("H", "h" and "a" in the examples above for "optional", "required" and "required array" (no optional arrays yet besides strings)).

New examples (with "hex" added):

PHP Code:
// A hex number and a player. extract params -> new hex:a, player:b; // 32 numbers then 32 players. extract params -> new a[32], player:b[32]; // 11 floats, an optional string, then an optional hex number. extract params -> new Float:f[11], string:s[12] = "optional", hex:end = 0xFF;

The code is actually surprisingly simple (I developed another new technique to simplify my "tag" macros and it paid off big style here). By default "Float", "string", "player" and "_" (i.e. no tag) are supported, and their individual letter definitions take up the majority of the code as demonstrated with the "hex" addition above. Note that "string:" is now used extensively in my code to differentiate from tagless arrays in cases like this, it is removed automatically but "player:" and "hex:" are not so you may wish to add:

PHP Code:
#define player: #define hex:

To avoid tag mismatch warnings (to remove them AFTER the compiler has used them to determine the correct specifier).

The very first example had an "else", this will turn:

PHP Code:
unformat(params, "ii", a, b);

In to:

PHP Code:
if (unformat(params, "ii", a, b))

You MUST put the "else" on the same line as "extract" for it to be detected, but then you can use normal single or multi-line statements. This is to cover common command use cases, you can even leave things on the same line:

PHP Code:
else return SendClientMessage(playerid, 0xFF0000AA, "Usage: /cmd ");

There is now the ability to split by things other than space (i.e. adds "P" to the syntax - updated from using "p" to "P"):

PHP Code:
extract params<|> -> new a, string:b[32], Float:c;

Will simply compile as:

PHP Code:
new a, string:b[32], Float:c; unformat(params, "P<|>is[32]f", a, b, c);

Note that for technical reasons you can use "<->" (because it looks like the arrow after the "extract" keyword). You also can't use "<;>", "<,>", or "<)>" because of a bug with "#", but you can use any other character (most notably "<|>", as is popular with SQL scripts). I'm thinking of adding enums and existing variables (currently you HAVE to declare new variables), but not right now.

Errors/Warnings

? ?
MSVRC100.dll not found

If you get this error, DO NOT just download the dll from a random website. This is part of the "Microsoft Visual Studio Redistributable Package". This is required for many programs, but they often come with it. Download it here:

http://www.microsoft.com/download/en...s.aspx?id=5555

? ?
sscanf error: System not initialised

If you get this error, you need to make sure that you have recompiled ALL your scripts using the LATEST version of "sscanf2.inc". Older versions didn't really require this as they only had two natives - "sscanf" and "unformat", the new version has some other functions - you don't need to worry about them, but you must use "sscanf2.inc" so that they are correctly called. If you think you have done this and STILL get the error then try again - make sure you are using the correct version of PAWNO for example.

? ?
sscanf warning: String buffer overflow.

This error comes up when people try and put too much data in to a string. For example:

PHP Code:
new str[10]; sscanf("Hello there, how are you?", "s[10]", str);

That code will try and put the string "Hello there, how are you?" in to the variable called "str". However, "str" is only 10 cells big and can thus only hold the string "Hello ther" (with a NULL terminator). In this case, the rest of the data is ignored - which could be good or bad:

PHP Code:
new str[10], num; sscanf("Hello there you|42", "p<|>s[10]i", str, num);

In this case "num" is still correctly set to "42", but the warning is given for lost data ("e you").

Currently there is nothing you can do about this from a programming side (you can't even detect it - that is a problem I intend to address), as long as you specify how much data a user should enter this will simply discard the excess, or make the destination variable large enough to handle all cases.

sscanf warning: Optional types invalid in array specifiers, consider using 'A'.

A specifier such as:

Code:
a[10]

Has been written - here indicating an array of optional integers all with the default value "5". Instead you should use:

Code:
A(5)[10]

This is an optional array of integers all with the default value "5", the advantage of this is that arrays can have multiple defaults:

Code:
A(5, 6)[10]

That will set the array to "5, 6, 7, 8, 9, 10, 11, 12, 13, 14" by default, incrementing by the found difference each time.

sscanf warning: Optional types invalid in enum specifiers, consider using 'E'.

Similar to the previous warning, A specifier such as:

Code:
e

Is invalid, instead use:

Code:
E(42, 11.0)

This forces ALL the parts of an enum to be optional - anything less is not possible.

? ?
sscanf error: Multi-dimensional arrays are not supported.

This is not allowed:

PHP Code:
sscanf(params, "a[5]>[10]", arr);

A work-around can be done using:

PHP Code:
sscanf(params, "a[50]", arr[0]);

That will correctly set up the pointers for the system.

? ?
sscanf error: Search strings are not supported in arrays.

This is not allowed (see the section on search strings):

Code:
a<'hello'i>[10]

? ?
sscanf error: Delimiters are not supported in arrays.

This is not allowed:

Code:
ai>[10]

Instead use:

Code:
p<,>a[10]

? ?
sscanf error: Quiet sections are not supported in arrays.

This is not allowed:

Code:
a<{i}>[10]

Instead use:

Code:
{a[10]}

? ?
sscanf error: Unknown format specifier '?'.

The given specifier is not known (this post contains a full list of all the specifiers near the bottom).

sscanf warning: 'Z' doesn't exist - that would be an optional, deprecated optional string!.

You used "Z", don't; instead use "S".

? ?
sscanf warning: 'z' is deprecated, consider using 'S' instead.

You used "z", don't; instead use "S".

? ?
sscanf warning: Empty default values.

An optional specifier has been set as (for example):

Code:
I()

Instead of:

Code:
I(42)

This does not apply to strings as they can be legitimately empty.

? ?
sscanf warning: Unclosed default value.

You have a default value on an optional specifier that looks like:

Code:
I(42

Instead of:

Code:
I(42)

? ?
sscanf warning: No default value found.

You have no default value on an optional specifier:

Code:
I

Instead of:

Code:
I(42)
sscanf warning: Unclosed specifier parameter, assuming '<', consider using something like p<<>.

A custom delimiter of:

Code:
p<

Was found with no matching ">" after one character. In this case the system assumes you are using the old (deprecated) style of delimiters and sets it to just "<". Instead use:

Code:
p<,>

Or, if you really do want a delimiter of "<" then use:

Code:
p<<>

Note that this does not need to be escaped; however, a delimiter of ">" does:

Code:
p<\>>

The "\" may also need to be escaped when writing actual PAWN strings, leading to:

Code:
p<\\>>

This also applies to array types ("a<" vs "a"), note that this will result in an invalid array type.

sscanf warning: Unenclosed specifier parameters are deprecated, consider using something like p<<>.

You are using the old style:

Code:
p,

Instead of:

Code:
p<,>

This also applies to array types ("ai" vs "a").

sscanf warning: No specified parameter found.

The format specifier just ends with:

Code:
p

This also applies to array types ("a" vs "a").

sscanf warning: Missing string length end.

sscanf warning: Missing length end.

A string has been written as:

Code:
s[10

Instead of:

Code:
s[10]

I.e. the length has not been closed.

sscanf warning: Arrays without a length are deprecated, please add a destination size.

A string has been written as:

Code:
s

Instead of:

Code:
s[10]

I.e. the length has not been included.

? ?
sscanf error: Invalid data length.

An invalid array or string size has been specified (0, negative, or not a number).

? ?
sscanf error: Invalid character in data length.

A string or array has been given a length that is not a number.

? ?
sscanf warning: Strings without a length are deprecated, please add a destination size.

In the old system, strings were not required to have lengths but this introduced security problems with overflows. Now you must add a length or get the default of "32".

? ?
sscanf error: String/array must include a length, please add a destination size.

Arrays are newer than strings, so never had an implementation not requiring a length, so there is no compatability problems in REQUIRING a length to be given.

? ?
sscanf warning: Can't have nestled quiet sections.

You have tried writing something like this:

Code:
{i{x}}

This has a quiet section ("{}") inside another one, which makes no sense.

? ?
sscanf warning: Not in a quiet section.

"}" was found with no corresponding "{":

Code:
i}

? ?
sscanf warning: Can't remove quiet in enum.

This is caused by specifiers such as:

Code:
{fe

Where the quiet section is started before the enum, but finishes part way through it rather than after it. This can be emulated by:

Code:
{f}e<{i}x>

? ?
sscanf error: Arrays are not supported in enums.

Basically, you can't do:

Code:
e[5]f>

You can, however, still do:

Code:
e

This is a little more awkward, but is actually more technically correct given how enums are compiled.

? ?
sscanf warning: Unclosed string literal.

A specifier starts a string with "'", but doesn't close it:

Code:
i'hello
sscanf warning: sscanf specifiers do not require '%' before them.

"format" uses code such as "%d", sscanf only needs "d", and confusingly the C equivalent function (also called "sscanf") DOES require "%". Sorry.

sscanf error: Insufficient default values.

Default values for arrays can be partially specified and the remainder will be inferred from the pattern of the last two:

Code:
A(0, 1)[10]

That specifier will default to the numbers "0" to "9". However, because enums have a mixture of types, all the default values for "E" must ALWAYS be specified:

Code:
E(0, 1, 0.0, 1.0)

This will not do:

Code:
E(0, 1)
sscanf error: Options are not supported in enums.

sscanf error: Options are not supported in arrays.

The "?" specifier for local options must appear outside any other specifier.

? ?
sscanf error: No option value.

An option was specified with no value:

Code:
?

? ?
sscanf error: Unknown option name.

The given option was not recognised. Check spelling and case:

Code:
?
sscanf warning: Could not find function SSCANF:?.

A "k" specifier has been used, but the corresponding function could not be found. If you think it is there check the spelling matches exactly - including the case.

sscanf error: SSCANF_Init has incorrect parameters.

sscanf error: SSCANF_Join has incorrect parameters.

sscanf error: SSCANF_Leave has incorrect parameters.

sscanf error: SSCANF_SetPlayerName has incorrect parameters.

You edited something in the sscanf2 include - undo it or redownload it.

Changelog

sscanf 2.8.2 - 18/04/2015
- Fixed a bug where "u" wasn't working correctly after a server restart.

Yet Another Lua Plugin

Sat, 20 Apr 2019 13:57:54 +0000

YALP v1.0

Download

Tutorials

Introduction
This plugin allows you to use Lua, your favourite dynamic flexible scripting language, in SA-MP, for all purposes, be it sandboxing user scripts, debugging the server, or developing filterscripts and gamemodes. YALP provides lightweight and flexible Lua environment that can use existing or future natives from SA-MP or plugins.

The main feature of YALP is a powerful interop API to interact with existing Pawn natives and callbacks. It is very easy to call existing functions, without needing to declare them anywhere:

Code:
interop.native.SetPlayerPos(0, 1235.31, -2331.84, 12.33)
YALP automatically converts all arguments to their proper Pawn cells, and allows you to specify what the function returns in the actuall call. All standard cell and single-dimensional array types are supported.

Callbacks can be specified in a similar simple way:

Code:
function interop.public.OnPlayerConnect(playerid) -- ... end

Thanks to these mechanisms, you can use any framework you want, or build your own in Lua, without depending on new versions of this plugin.

Configuration
There is no special XML, JSON or other configuration of this plugin, because you can specify everything when you create a new Lua state (you can create any number you wish, and run any code inside). You can specify what packages should be loaded or available in the Lua instance, how much maximum memory it should take, or even limit for how long Lua functions can run.

Features
All standard Lua packages are available (although some of the more unsafe ones aren't allowed by default). The powerful interop package can interface with any Pawn native function or callback. There is also an advanced timer library with support for simple asynchronous functions (with Lua coroutines) and all sorts of timers. The remote package contains functions for remote communication between two separate Lua instance (via serialization or proxies).

The standard Lua packages are also enhanced with a couple of useful functions. Please see the wiki for a list of all new functions.

The Pawn API is basically a port of the Lua C API, allowing advanced manipulation of the Lua machine. It is recommended to use the Lua API, since it can do everything that Pawn can do, but if you need to interact with an existing complex Pawn library, it is possible as well.

Sample code

Code:
#include #include public OnFilterScriptInit() { new Lua:l = lua_newstate(); // creates a new Lua instance if(lua_loadfile(l, "script.lua")) // loads a Lua script and returns an error code { lua_stackdump(l); // prints the stack for more information about the error return; } lua_bind(l); // binds the Lua instance to the current Pawn filterscript/gamemode, so all interation with it is rerouted to Lua // if the binding succeeds, this code is not run (and the Lua instance is destroyed if the script is unloaded) lua_stackdump(l); }
Code:
-- script.lua local interop = require "interop" interop.native.print("Hello from Lua!")

[Include] pawn-array-view: non-owning spans for multi-dimensional pawn arrays

Wed, 17 Apr 2019 05:00:54 +0000
pawn-array-view

pawn-array-view is an efficient C library that abstracts the complex memory layout of multi-dimensional pawn arrays and provides an intuitive C/ array-like interface for dealing with them. The name suggests that the library only allows read-only access to the arrays but that's not true; you can access and modify the arrays. Any decent C compiler will be able to optimize off all access and modifications to the arrays into simple pointer arithmetic.

Defects (Help Wanted)
LICM optimizations aren't pushing loop invariant subexpressions out of the loop because of aliased pointers. I haven't figured out how to correctly place restrict qualifiers which aren't ignored.

Code:
int main() { pawn::array_view array((cell*)0x10000); for(int i = 0; i < 100; i) { for(int j = 0; j < 100; j) { for(int k = 0; k < 128; k) { array[i][j][k] = 10; } } } return 0; }

The compiler does not move the array[i][j] calculations outside the loop. There is a valid reason to not move them since modifying an element could modify something which would require recalculating the indexes. This is useful only when indirection tables are being modified. The common case is data being modified but not the indirection table. In this situation, moving the calculations out of the loop improves performance.

There are more consequences. The compiler can also vectorize the loop if it manages to pull the subexpression out of the loop. The failure to move the subexpression outside the loop prevents a ton of optimizations.

Note that the optimizations happen when the array is only being read. The problem is for modifications only.

Plans
If the size of the arrays are known at compile-time, a better interface can be provided. I have plans on providing full-fledged container like support for arrays where the dimensions are available at compile time.

There is a project going on in the develop branch which has working but inefficient code for dealing with known dimensions at run-time.

I plan on renaming array_view to span. This include was initially providing a view but then the ability to mutate was added but the name wasn't changed. It's a very misleading name now.

Links
array_view.hpp

documentation

examples

project repository

develop branch (interesting stuff happens here)

PAWN memory access plugin

Mon, 15 Apr 2019 11:35:00 +0000

PAWN memory access plugin

A successor to http://forum.sa-mp.com/showthread.php?t=451381

Description

The PAWN memory access plugin allows to allocate and free memory from heap in PAWN.

Project

All of the source code, builds and documentations are located at GitHub: https://github.com/BigETI/pawn-memory

SAMP GameMode in Assembly (SGMA)

Sun, 14 Apr 2019 23:45:52 +0000

SAMP GameMode in Assembly (SGMA)

SGMA is the first SAMP gamemode written entirely in assembly programming language using fasm

Technical features:

As fast as it gets: doesn't use an AMX machine, runs on native x86 code

Cross-platform: in assembly, yeah!

Gamemode features:

Simple Deathmatch

SQLite-based account system

Weapon store

Download page

GitHub page

Also please read the technical and development notes (click)

samp-crypto - bcrypt, scrypt & argon2 hashing

Sun, 14 Apr 2019 23:40:58 +0000
samp crypto
A SAMP cryptography plugin written in Rust. This plugin was written as a means to make it really simple for anyone to transition from Whirlpool, SHA256_PassHash or any other hashing method similar to these without major script changes, like the other bcrypt plugins do. This is my first plugin written in Rust, I tried cleaning up all my code and I will continue to do so however you may still see some older code. If you wish to clean it up please fork the repo, make changes and create a PR! I will happily review and accept it.

Encryption Methods
Bcrypt

Scrypt

Argon2i (Argon2d and 2id will be brought out soon if demand is there)

Installation
Head to the release page and download the latest version of samp crypto (https://github.com/infin1tyy/samp-crypto/releases).

Place the .inc into your pawno/include folder.

Place the .dll or .so in your plugins folder (if one doesn't exist, create a new one).

Add?samp_crypto?to your server.cfg (if on linux, add?libsamp_crypto.so?to your server.cfg instead.

Enjoy!

How to Use
Click me to go to the wiki!

Downloads
Binaries
Source Code

Credits
The credits can be found?here, in the GitHub README.md

Notes
I was debating whether or not I should release this for a while. After what has been going on in SAMP, with essentially the community being divided between the players in the Discord and the SAMP forum, I wasn't sure who to support. A lot of the people from this community have been quite spiteful towards me, however, I'm putting that in the past and I suppose my support is with you lot.
samp crypto will be a burgershot.gg exclusive.
Special thanks to iAmir & Dakyskye from the bottom of my heart.
For anyone who didn't believe in me, fuck you I suppose. :joy: Maybe this'll prove I'm worth something. And I'd like to apologize for never delivering on that Postgres plugin, but do know that I still have it in mind and I'll make it happen whenever I have the experience to do so.