What is rcedit?
The rcedit npm package is used to edit the resources of Windows executables. It allows you to modify various properties of an executable file, such as its version information, icon, and more.
What are rcedit's main functionalities?
Change Version Information
This feature allows you to change the version information of a Windows executable. You can set properties like ProductName, FileDescription, and CompanyName.
const rcedit = require('rcedit');
rcedit('path/to/executable.exe', {
'version-string': {
'ProductName': 'MyApp',
'FileDescription': 'My Application Description',
'CompanyName': 'My Company'
}
}, function (error) {
if (error) {
console.error('Failed to edit executable:', error);
} else {
console.log('Executable edited successfully');
}
});
Change Icon
This feature allows you to change the icon of a Windows executable. You need to provide the path to the new icon file.
const rcedit = require('rcedit');
rcedit('path/to/executable.exe', {
'icon': 'path/to/icon.ico'
}, function (error) {
if (error) {
console.error('Failed to edit executable:', error);
} else {
console.log('Executable edited successfully');
}
});
Set Requested Execution Level
This feature allows you to set the requested execution level of a Windows executable. For example, you can set it to 'requireAdministrator' to request administrative privileges.
const rcedit = require('rcedit');
rcedit('path/to/executable.exe', {
'requested-execution-level': 'requireAdministrator'
}, function (error) {
if (error) {
console.error('Failed to edit executable:', error);
} else {
console.log('Executable edited successfully');
}
});
0
node-rcedit
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