Skip to content
Snippets Groups Projects
Commit fac19f77 authored by Simon McVittie's avatar Simon McVittie
Browse files

Document how runtimes work

parent 41f732b9
No related branches found
No related tags found
No related merge requests found
...@@ -79,11 +79,11 @@ Instructions for testing ...@@ -79,11 +79,11 @@ Instructions for testing
* Configure the launch options for a game in Steam to be: * Configure the launch options for a game in Steam to be:
/path/to/pressure-vessel-wrap -- %command% /path/to/bin/pressure-vessel-wrap -- %command%
* For interactive testing, if you ran Steam from a shell, you can use: * For interactive testing, if you ran Steam from a shell, you can use:
/path/to/pressure-vessel-wrap --interactive -- %command% /path/to/bin/pressure-vessel-wrap --interactive -- %command%
The interactive shell's current working directory matches the game's. The interactive shell's current working directory matches the game's.
Run `"$@"` in the interactive shell to run the game. Run `"$@"` in the interactive shell to run the game.
...@@ -95,9 +95,27 @@ Instructions for testing ...@@ -95,9 +95,27 @@ Instructions for testing
- Run one of: - Run one of:
/path/to/pressure-vessel-wrap --fake-home=/some/path --interactive -- ./whatever-game /path/to/bin/pressure-vessel-wrap --fake-home=/some/path --interactive -- ./whatever-game
/path/to/pressure-vessel-wrap --freedesktop-app-id=com.example.Anything --interactive -- ./whatever-game /path/to/bin/pressure-vessel-wrap --freedesktop-app-id=com.example.Anything --interactive -- ./whatever-game
/path/to/pressure-vessel-wrap --steam-app-id=70 --interactive -- ./whatever-game /path/to/bin/pressure-vessel-wrap --steam-app-id=70 --interactive -- ./whatever-game
* To use a runtime instead of the host system, use:
/path/to/bin/pressure-vessel-wrap --runtime=$HOME/some-runtime -- ./whatever-game
The runtime can be either:
- A merged `/usr` containing `bin/bash`, `lib/ld-linux.so.2`,
`bin/env`, `share/locale`, `lib/python2.7` and so on
- A Flatpak runtime such as
`~/.local/share/flatpak/runtime/com.valvesoftware.SteamRuntime.Platform/x86_64/scout_beta/active/files`,
for example produced by [flatdeb][] (this is a special case of a
merged `/usr`)
- A sysroot containing `bin/bash`, `lib/ld-linux.so.2`,
`usr/bin/env`, `usr/share/locale`, `usr/lib/python2.7` and so on,
optionally with `bin`, `lib` etc. being symlinks into `usr`
Design constraints Design constraints
------------------ ------------------
...@@ -179,6 +197,9 @@ TODO ...@@ -179,6 +197,9 @@ TODO
[weird behaviour]: https://www.ctrl.blog/entry/flatpak-steamcloud-xdg [weird behaviour]: https://www.ctrl.blog/entry/flatpak-steamcloud-xdg
* Team Fortress 2 reports an error because it is unable to set the
`en_US.UTF-8` locale (but then starts successfully anyway).
Design Design
------ ------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment