Skip to content

A RedM standalone Github Version Checker API for your custom scripts!

License

Notifications You must be signed in to change notification settings

BryceCanyonCounty/bcc-versioner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

BCC Versioner

A RedM standalone Github Version Checker API for your custom scripts!

Topics github fivem cfx redm vorp

Features

  • Resource Version Check export APIs
    • Github Release(tag) based check
    • Github Version file based check

How to install

  • Download this repo
  • Copy and paste bcc-versions folder to resources/bcc-versions
  • Add ensure bcc-versions to your server.cfg file
  • Now you are ready to get coding!

API Docs

Version Check

This API will allow you to add a version check to your resource.

The script will check what current version of the script is downloaded via the Version defined in the fxmanifest.

For Example version '1.0'

Release(Tag) Based Checks

How to use Github Releases

Create a Release and tag with the version number

Correct: 1.0.0

Wrong: v1.1.0

Add the following contents to your lua server

local versioner = exports['bcc-versioner'].initiate()
local repo = 'https://github.com/BryceCanyonCounty/bcc-anticheat'
versioner.checkRelease(GetCurrentResourceName(), repo)

Version File Based Checks

Create a file called version with the following contents

<1.3>
- More awesome updates
<1.1>
- Some awesome updates
<1.0>
- My first Update

Add the following contents to your lua server

local versioner = exports['bcc-versioner'].initiate()
local repo = 'https://github.com/BryceCanyonCounty/bcc-anticheat'
versioner.checkFile(GetCurrentResourceName(), repo)

Need More Support?

Requirements

  • NONE! It's standalone.