/vRP

FiveM (http://fivem.net) RP addon/framework

Primary LanguageLuaMIT LicenseMIT

vRP

Table of Contents
vRP

FiveM RP addon/framework
The project aims to create a generic and simple RP framework to prevent everyone from reinventing the wheel.
Contributions are welcomed.

Support me on Patreon to keep this project alive:

Support me and the project on Patreon
ℹ️
 This is vRP 2, the second major version of vRP. It aims to have less overhead and a more straightforward and structured approach using OOP. This will probably be the last major version, vRP based resources can be updated for vRP 2 using the extension system. See the developers documentation.
Features

  • basic admin tools (kick,ban,whitelist), groups/permissions, languages, identification system (persistent user id for database storage), user/character/server/global custom data key/value

  • player state (survival vitals, weapons, player appearance, position)

  • player identity/phone/aptitudes (education/exp), emotes, business system / money (wallet/bank), homes

  • cloakrooms (uniform for jobs), basic police (PC, check, I.D., handcuff, jails, seize weapons/items), basic emergency (coma, reanimate)

  • inventory (with custom item definition, parametric items), chests (vehicle trunks), transformer (harvest, process, produce) (illegal informer)

  • basic implementations: ATM, market, shops, skinshop, garage

  • GUI (dynamic menu, progress bars, prompt), map entities (blip, markers), areas (enter/leave callbacks)

  • database MySQL "driver" system to interface to any MySQL resources

  • OOP design, more structured code and less overhead

  • proxy for easy inter-resource developement, tunnel for easy server/clients communication

  • …​

Documentation

⚠️
 Read the documentation before asking for help, creating a bug report or a feature request.

See the documentation.

See also (and use it as a basis to understand how to develop extensions for vRP):

Credits