Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brycecanyoncounty/bcc-versioner
A RedM standalone Github Version Checker API for your custom scripts!
https://github.com/brycecanyoncounty/bcc-versioner
cfx fivem github redm vorp vorpcore
Last synced: 27 days ago
JSON representation
A RedM standalone Github Version Checker API for your custom scripts!
- Host: GitHub
- URL: https://github.com/brycecanyoncounty/bcc-versioner
- Owner: BryceCanyonCounty
- License: gpl-3.0
- Created: 2022-10-13T06:24:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-26T23:52:48.000Z (over 1 year ago)
- Last Synced: 2023-09-27T07:50:44.967Z (over 1 year ago)
- Topics: cfx, fivem, github, redm, vorp, vorpcore
- Language: Lua
- Homepage:
- Size: 20.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository)_
> 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
```lua
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
```txt
<1.3>
- More awesome updates
<1.1>
- Some awesome updates
<1.0>
- My first Update
```
> Add the following contents to your lua server
```lua
local versioner = exports['bcc-versioner'].initiate()
local repo = 'https://github.com/BryceCanyonCounty/bcc-anticheat'
versioner.checkFile(GetCurrentResourceName(), repo)
```
## Need More Support?
- [BCC Discord](https://discord.gg/cQMJaTqcqJ)
## Requirements
- NONE! It's standalone.