https://github.com/tfnrp/fivem-merge
An API to merge your FiveM vehicle resources
https://github.com/tfnrp/fivem-merge
api cli fivem manifest merge meta xml
Last synced: 7 months ago
JSON representation
An API to merge your FiveM vehicle resources
- Host: GitHub
- URL: https://github.com/tfnrp/fivem-merge
- Owner: TFNRP
- License: apache-2.0
- Created: 2021-09-29T08:35:49.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T11:53:11.000Z (over 2 years ago)
- Last Synced: 2025-03-06T07:18:12.665Z (7 months ago)
- Topics: api, cli, fivem, manifest, merge, meta, xml
- Language: JavaScript
- Homepage:
- Size: 439 KB
- Stars: 6
- Watchers: 2
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
FiveM Merge
## Table of Contents
- [About](#about)
- [Documentation](#documentation)
- [CLI](#cli)
- [API](#api)
## About
Fivem API for vehicle resource packing.
## Documentation
### CLI
```sh
$ vmerge --help
```
### API
```js
const merge = require('fivem-merge');
/**
* The relative paths to the resources to merge
* @type {(string|string[])}
*/
const paths = './'
/**
* Options for vMerge
* @type {Object}
*/
const options = {
/**
* The location to move the merged resource into
* @type {string}
*/
outputPath: './vehicles',
/**
* A preferred temp path. Uses `os.tmpdir()` by default
* @type {string}
* @default undefined
*/
tempPath: null,
/**
* Additional info logging
* @type {boolean}
* @default false
*/
verbose: true,
/**
* Whether output XML should be linted for human readability
* @type {Boolean}
* @default true
*/
lintOutput: true,
}
/**
* Merges FiveM vehicle resources
* @param {(string|string[])} paths The relative paths to the resources to merge
* @param {VMergeOptions} options Options to use with vMerge
* @returns {Promise}
*/
merge(paths, options)
```