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

Document --no-sandbox Linux launch option #49

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document --no-sandbox Linux launch option #49

Show file tree
Hide file tree
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
Binary file added LaunchOption.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 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,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.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This only happens on steam deck or linux in general?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Back in Sep 2022, I reproduced the issue on Ubuntu 22 and Manjaro 22.

Copy link
Contributor

@headcr4sh headcr4sh Sep 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also can confirm that this is an issue that happens to Linux 'in general'.

According to the bug reports that our game (Friendly Fire) received from Linux users, it seems to me that --no-sandbox currently is the only viable option to push a reliable working Linux version of our Electron-based game.

I have the feeling, that Ubuntu users in particular seem to be having fewer problems than users of other distributions, but that assumption might very well be totally wrong.


![screenshot](LaunchOption.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).
Expand Down