WHAT IS FIVEM-CHECKER?
FiveM Checker is a resource that uses HTTPS requests to determine if resources are outdated or not.
(They need to be compatible with fivem-checker, more information below)
List of already compatible resources
Some new features will be added soon: a command to check for updates (instead of having to restart the resource or the server), Auto-Updater, Update checker for non-compatible resources, etc.
KNOWN BUG:
- None (For now, I guess?)
Don’t forget to this post if you liked this resource. It motivates me to keep coding for FiveM (but it’s mostly for my ego
).
HOW DOES IT WORK? (Devs)
First step
You will need to add several metadata items to your fxmanifest.lua
files.
Manifest Metadata | Required/Optional | Description | Example |
---|---|---|---|
fivem_checker | Required | Without this metadata, the checker won’t be able to “see” your resource | fivem_checker 'yes' |
github | Required | Link to the GitHub repo of your resource | github 'https://github.com/clementinise/kc-test' |
version | Required | Version of your resource (You will need to change this every time you release an update) | version '1.0' |
name | Optional | Name of your resource (You can also use color codes) | name '^2Test Script' |
Second step
You will also need to add a file labeled version
(An example can be found here) to your GitHub repo.
This file needs to follow certain syntax rules:
Syntax | Required/Optional | Description | Example |
---|---|---|---|
<version-number> |
Required | The version number should be enclosed in angle brackets | <1.1> |
- Changelog |
Optional | Each line of the changelog should be separated by a minus symbol | - This is a test sentence |
Last step
There isn’t one, only those two steps are required to make your resource compatible with this resource.
INSTALLATION (Users)
Download the latest release.
Drag the folder into your <server-data>/resources
folder.
Add this in your server.cfg
:
ensure fivem-checker
Note: This needs to be added at the end of your resources list in server.cfg