BurnsCommon

v1.0.0

Shared Utility Framework for LSPDFR Plugins

Required Dependency

This framework is required to run all of my LSPDFR mods. While BurnsCommon is automatically packaged with each mod download, you may occasionally need to download and install it separately — for example, if you're troubleshooting plugin conflicts, updating from an older version, or if the bundled version becomes out of sync. Installing the latest version here ensures compatibility across all plugins.

Description

BurnsCommon is a shared library designed to provide a solid foundation for LSPDFR plugins.

It centralizes common systems such as logging, dependency validation, update checking, configuration helpers, audio utilities, and UI components into a single lightweight framework. Instead of every plugin re-implementing the same boilerplate code, developers can rely on BurnsCommon for consistent, reliable behavior.

The result: smaller plugins, fewer conflicts, faster development, and a more stable experience for players.

Features

Centralized logging with configurable prefixes
Dependency validation (RagePluginHook, LSPDFR, required files)
Batched startup error reporting
Asynchronous update checking
Standardized INI configuration helpers
Value clamping utilities (int / float)
Toast notification system
Popup / dialog system with multiple choice support
Animation helpers
Shared color palette
Reusable audio helper functions
Plugin-agnostic logging and playback
Public BurnsCommonAPI with Version and IsLoaded properties
EnsureLoaded() method for dependency checks
No hardcoded references to specific mods
Safe to use across multiple projects
Designed as a drop-in dependency

Requirements

GTA V
RagePluginHook (latest)
LSPDFR 0.4.9+
.NET Framework 4.8

Installation

1.Extract to your GTA V folder
2.Place BurnsCommon.dll in the GTA V root directory
3.Launch RagePluginHook
4.Verify [BurnsCommon] appears in the RPH console/log

Plugins that depend on BurnsCommon will now be able to load.

File Structure

GTAV/

└── BurnsCommon.dll

API Reference

Reference BurnsCommon in your plugin project. Full API below:

Please view the API reference table on a desktop device.

BurnsCommon

BurnsCommonAPIInitialize(pluginName)Initialize library

VersionGet version

CheckVersion(minVersion)Check version requirement

BurnsCommon.Core

LoggerInfo(message)Log info

Warning(message)Log warning

Error(message, ex)Log error

DependencyCheckerCheck(name, rph, lspdfr, files)Validate dependencies

UpdateCheckerCheckAsync()Check for updates

ConfigHelperGetIniPath(pluginName)Get INI path

ReadInt(ini, section, key, def, min, max)Read clamped int

ReadFloat(ini, section, key, def, min, max)Read clamped float

KeybindManagerRegister(name, key, modifiers)Register keybind

IsPressed(name)Check key pressed

IsHeld(name)Check key held

GetDisplayString(name)Get display text

NotificationQueueEnqueue(title, subtitle, msg)Queue notification

Show(message)Simple notification

ShowImmediate(title, sub, msg)Bypass queue

Clear()Clear queue

LocalizationManagerRegister(key, englishText)Register string

Get(key)Get translation

CurrentLanguageSet language

LoadFromIni(path)Load translations

BurnsCommon.Helpers

VehicleHelperIsPoliceVehicle(vehicle)Check if police

IsEmergencyVehicle(vehicle)Check if emergency

GetVehicleClass(vehicle)Get class enum

GetNearbyVehicles(pos, radius)Get vehicles nearby

HasDriver(vehicle)Check has driver

GetOccupants(vehicle)Get all occupants

RepairAndClean(vehicle)Fix vehicle

PedHelperIsArmed(ped)Check has weapon

HasFirearm(ped)Check has gun

IsCop(ped)Check is police

IsDead(ped)Check is dead

IsInVehicle(ped)Check in vehicle

GetNearbyPeds(pos, radius)Get peds nearby

GetClosestPed(pos, radius)Get closest ped

Flee(ped, fromPos)Make ped flee

Surrender(ped)Hands up

GiveWeapon(ped, name, ammo)Give weapon

WorldHelperPlayerPositionGet player pos

GetStreetName(pos)Get street name

GetSafeSpawnPoint(pos, min, max)Get spawn point

GetGroundZ(pos)Get ground height

IsNightTime()Check if night

GetDistance(pos1, pos2)Get distance

CreateBlip(pos, color, name)Create blip

BurnsCommon.Audio

AudioHelperPlayAsync(path, logPrefix)Play sound

StopAll()Stop all sounds

BurnsCommon.UI

ToastSystemInfo(message)Blue toast

Success(message)Green toast

Warning(message)Amber toast

Error(message)Red toast

Draw()Render toasts (every frame)

PopupMessage(title, text)Show message

Confirm(title, text, onYes, onNo)Yes/No dialog

ColorPaletteAccentBlue/Green/Red/AmberTheme colors

WithAlpha(color, alpha)Set transparency

Lerp(from, to, t)Blend colors

AnimationHelperUpdateDeltaTime()Update timer (every frame)

Lerp(current, target, speed)Smooth interpolation

EaseOut(t) / EaseIn(t)Easing curves

Pulse(frequency)Oscillate 0-1

BurnsCommon.Callouts

CalloutBaseSetup()Override: set spawn point

OnAccepted()Override: spawn entities

OnProcess()Override: tick logic

SpawnPed(model, pos)Spawn + auto-cleanup

SpawnVehicle(model, pos)Spawn + auto-cleanup

CreateBlip(entity, color, name)Blip + auto-cleanup

ShowDispatch(message)Dispatch notification

EndCallout()End callout

Reference BurnsCommon in your plugin project and call BurnsCommonAPI.Initialize("YourPlugin") on startup.

Why BurnsCommon?

Most LSPDFR plugins re-implement the same systems over and over — logging, dependency checks, UI toasts, config parsing, update logic.

BurnsCommon solves this once.

By moving shared functionality into a single maintained framework, plugin developers can focus on gameplay features instead of infrastructure, while players benefit from improved stability and clearer error messages.

Build faster. Ship cleaner plugins. Reduce conflicts.