Skip to content
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

Update README to clarify Steam Overlay compatibility issues #147

Closed
wants to merge 1 commit into from
Closed

Update README to clarify Steam Overlay compatibility issues #147

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
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,17 @@ To make the steam overlay working, call the `electronEnableSteamOverlay` on the
require('steamworks.js').electronEnableSteamOverlay()
```


If you build your Electron application, you may notice that the Steam overlay does not function by default. This is often resolved by enabling GPU processes to run within Electron's main process. To resolve that issue you can run your application like:

application.exe --in-process-gpu

If the overlay functions correctly with the argument above you can directly inject the arg:

const {app} = await import('electron');

app.commandLine.appendSwitch('in-process-gpu');

For the production build, copy the relevant distro files from `sdk/redistributable_bin/{YOUR_DISTRO}` into the root of your build. If you are using electron-forge, look for [#75](https://github.com/ceifa/steamworks.js/issues/75).


Expand Down
Loading