StimzRx/wolf

ATTENTION

This is a slightly modified (and very unofficial) version of the original games-on-whales/wolf project. Please give them some love for this outstanding project! Their discord and dontaions are linked above.

Description

This unofficial fork of Wolf will allow it to use OverlayFS in its steam container/app. This allows all users that connect to Wolf and use Steam to already have the games downloaded for them once they log in, and they can immediately play them (if they own the game). This only works if the host computer has downloaded the game themselves via steam first.

In addition, it is likely each time a new user connects the first time, they will have to go to Steam Settings -> Compatability tab -> Turn on Enable Steam Play for all other titles and then restart steam. This should persist for that user going forward.

If wolf users cant see some games as downloaded or playable this is likely why!

---

Install Instructions

1. Fully follow/complete the normal install directions
2. Start the NORMAL Wolf image at least once before continuing with docker compose up and then stop it(with docker compose down) (skipping this step will cause there to be no /etc/wolf/cfg/config.toml file to edit later on!)
3. Change the wolf's docker-compose.yml file on the image: ghcr.io/games-on-whales/wolf:stable line to use ghcr.io/stimzrx/wolf:stable instead
4. Edit /etc/wolf/cfg/config.toml under the Steam app section to look like this:

env = ["PUID=1000","PGID=1000","PROTON_LOG=1","RUN_SWAY=true","GOW_REQUIRED_DEVICES=/dev/input/* /dev/dri/* /dev/nvidia*"]
base_create_json = """
{
  "Entrypoint": ["/overlayfs-entrypoint.sh"],
  "HostConfig": {
    "Binds": [
      "/etc/wolf/overlayfs-entrypoint.sh:/overlayfs-entrypoint.sh:ro",
      "/home/<YOUR USERNAME HERE>/.steam/debian-installation/steamapps:/overlayfs/steam-ro:ro"
    ],
    ...

Make sure to replace the <YOUR USERNAME HERE> with your own linux user name. If needed, change PUID and PGID to match your host user's id and group id.

6. Make a new file at /etc/wolf/overlayfs-entrypoint.sh named exactly that and put the overlayfs-entrypoint.sh script found here in it.
7. run the command sudo chmod +x /etc/wolf/overlayfs-entrypoint.sh to allow execution of the script or it will crash when opening steam
8. Start the now edited docker-compose.yml file with docker compose up -d and connect/use as normal. You should see the games you have installed on your host are already installed in the Wolf containers!

Acknowledgements

• @Drakulix for the incredible help given in developing Wolf
• @zb140 for the constant help and support in GOW
• @loki-47-6F-64 for creating and sharing Sunshine
• @ReenigneArcher for beying the first stargazer of the project and taking care of keeping Sunshine alive
• All the guys at the Moonlight Discord channel, for the tireless help they provide to anyone