Table of Contents

• About
• Documentation
  • CLI
  • API

About

Fivem API for vehicle resource packing.

Documentation

CLI

$ vmerge --help

API

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<boolean>}
 */
merge(paths, options)