https://github.com/electron/node-rcedit

Node module to edit resources of exe
https://github.com/electron/node-rcedit

electron electron-packager

Last synced: about 1 month ago
JSON representation

Node module to edit resources of exe

• Host: GitHub
• URL: https://github.com/electron/node-rcedit
• Owner: electron
• License: mit
• Created: 2013-11-06T09:08:11.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T17:52:49.000Z (8 months ago)
• Last Synced: 2024-04-14T03:56:19.062Z (7 months ago)
• Topics: electron, electron-packager
• Language: JavaScript
• Size: 28.1 MB
• Stars: 185
• Watchers: 25
• Forks: 41
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Support: SUPPORT.md

Awesome Lists containing this project

README

        
# node-rcedit

[![CircleCI build status](https://circleci.com/gh/electron/node-rcedit/tree/main.svg?style=shield)](https://circleci.com/gh/electron/node-rcedit/tree/main)

[![NPM package](https://img.shields.io/npm/v/rcedit)](https://npm.im/rcedit)

Node module to edit resources of Windows executables.

## Requirements

On platforms other than Windows, you will need to have [Wine](https://winehq.org)

1.6 or later installed and in the system path.

## Usage

```javascript

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](https://msdn.microsoft.com/en-us/library/6ad1fshk.aspx#Anchor_9) for

  more details.

* `application-manifest` - String path to a local manifest file to use.

  See [here](https://msdn.microsoft.com/en-us/library/windows/desktop/aa374191.aspx)

  for more details.

* `resource-string` - An object in the form of `{ [id]: value }` to add to the

  [string table](https://docs.microsoft.com/en-us/windows/win32/menurc/stringtable-resource).

Returns a `Promise` with no value.

## Building

* Clone the repository

* Run `yarn install`

* Run `yarn test` to run the tests