/vRP3-Dev

Development Branch for vRP3

Primary LanguageLuaMIT LicenseMIT

vRP

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.

ℹ️
 This is a development build for the next version of vRP (vRP3 - Name not confirmed) It is planned to be backwards compatible with previous vRP scripts, or at least can be updated with minor tweaks.
ℹ️
 If you wish to help with the next version, please contact Sharky on the Discord server.
Current Features

  • Basic weather control

  • Commands and miscellaneous module (for all general commands and functions)

  • Lua Object-Oriented-Programming (OOP) for optimization

Documentation

ℹ️
 Documentation for vRP3 has not yet been completed. All current documentation is for vRP2 or Legacy vRP Online: https://vrp-framework.github.io/vRP
Offline:

  • git worktree add gh-pages gh-pages

  • open the gh-pages directory from a browser

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

Issues / Features / Help

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

When submitting an issue, add any information you can find, with all details. Saying that something doesn’t work will probably not be enough to solve the issue. If you have errors in your console before the issue happens, things could be corrupted, so the issue may be irrelevant. You should solve all unrelated errors before submitting issues.

When submitting a feature request, make sure the feature is relevant about the core of the framework or already existing vRP features. vRP is a framework, thus it doesn’t aim to implement everything, but to give the tools to do so.

⚠️
 The issue section is only for bug reports and feature requests. Issues not related to the core of vRP, about old versions (no backwards update) or vRP modifications will be closed without warning.
💡
 Before submitting an issue or a feature request, do a search in open and closed ones to know if it has been reported/requested before.
ℹ️
 For questions, help, discussions around the project, please go instead on the vRP thread of the FiveM forum or the discord.

Credits