Document --no-sandbox Linux launch option

Fixes ceifa#42.
dfabulich · Oct 28, 2022 · 2c66ac3 · 2c66ac3
1 parent 92e73fa
commit 2c66ac3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/LaunchOption.png b/LaunchOption.png
diff --git a/README.md b/README.md
@@ -68,6 +68,10 @@ To make the steam overlay working, call the `electronEnableSteamOverlay` on the
 require('steamworks.js').electronEnableSteamOverlay()
 ```
 
+[Some users have reported an issue when launching Linux apps](https://github.com/ceifa/steamworks.js/issues/42). A workaround is available, to pass a `--no-sandbox` as an argument to the app launcher in Steamworks --> Steamworks Settings --> Installation --> General Installation --> Launch Options. (Note that `--no-sandbox` makes it unsafe to run third-party code, but as long as you're only running game code under your own control, it should be fine.) A screenshot example of this appears below.
+
+![screenshot](LaunchOptions.png)
+
 ## How to build
 
 > You **only** need to build if you are going to change something on steamworks.js code, if you are looking to just consume the library or use it in your game, refer to the [installation section](#installation).