44 lines
1.4 KiB
Markdown
44 lines
1.4 KiB
Markdown
|
# node-rcedit
|
||
|
|
|
||
|
|
[](https://circleci.com/gh/electron/node-rcedit/tree/master)
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
Returns a `Promise` with no value.
|
||
|
|
|
||
|
|
## Building
|
||
|
|
|
||
|
|
* Clone the repository
|
||
|
|
* Run `npm install`
|
||
|
|
* Run `npm test` to run the tests
|