Skip to content

docs(config): document extraResource for runtime assets #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SAY-5 wants to merge 1 commit into
base: v6
Choose a base branch
from
Open

docs(config): document extraResource for runtime assets #258

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions config/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,33 @@ If you want to specify a platform/architecture combination for any build command
See the [#build-commands](../cli.md#build-commands "mention") documentation for more details.
{% endhint %}

{% hint style="info" %}
To ship runtime assets that live outside your bundled source code (for example, a tray icon or other binary file referenced at runtime), use [`extraResource`](https://electron.github.io/packager/main/interfaces/Options.html#extraresource). Files listed here are copied into the platform's resources directory (next to `app.asar`) and are available at runtime via `process.resourcesPath`.

{% code title="forge.config.js" %}
```javascript
module.exports = {
packagerConfig: {
extraResource: ['./assets/tray-icon.png']
}
};
```
{% endcode %}

In the main process, resolve the file with `process.resourcesPath` when the app is packaged:

```javascript
const path = require('path');
const { app, Tray } = require('electron');

const iconPath = app.isPackaged
? path.join(process.resourcesPath, 'tray-icon.png')
: path.join(__dirname, '..', 'assets', 'tray-icon.png');

const tray = new Tray(iconPath);
```
{% endhint %}

### Electron Rebuild config

The top level property `rebuildConfig` on the configuration object maps directly to the options sent to [`@electron/rebuild`](https://github.com/electron/rebuild) during both the [#package](../cli.md#package "mention") and [#start](../cli.md#start "mention") commands in Electron Forge.
Expand Down
Loading