Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.64 KB

README.md

File metadata and controls

46 lines (33 loc) · 1.64 KB

node-rcedit

CircleCI build status NPM package

Node module to edit resources of Windows executables.

Requirements

On platforms other than Windows, you will need to have Wine 1.6 or later installed and in the system path.

Usage

const rcedit = require('rcedit')

async rcedit(exePath, options)

exePath is the path to the Windows executable to be modified.

options is an object that can contain following fields:

  • version-string - An object containing properties to change the exePath's version string.
  • file-version - File's version to change to.
  • product-version - Product's version to change to.
  • icon - Path to the icon file (.ico) to set as the exePath's default icon.
  • requested-execution-level - Requested execution level to change to, must be either asInvoker, highestAvailable, or requireAdministrator. See here for more details.
  • application-manifest - String path to a local manifest file to use. See here for more details.
  • resource-string - An object in the form of { [id]: value } to add to the string table.

Returns a Promise with no value.

Building

  • Clone the repository
  • Run yarn install
  • Run yarn test to run the tests