[META] Update Docs

This commit is contained in:
Ben C 2023-08-20 17:21:38 -04:00
parent dd4d728c0b
commit 90f944ce79
No known key found for this signature in database
GPG Key ID: 556064B755159BBC
3 changed files with 6 additions and 8 deletions

View File

@ -22,9 +22,7 @@ This is the monorepo for the new <a href="https://www.mobiusdigitalgames.com/out
|:------------:|:---------------:|
| **Windows** | ✅ |
| **Linux** | ✅ |
| **Deck** | ✅* |
\* The manager itself can only be launched in desktop mode, but mods will persist if you switch to game mode and launch the game itself. Note that in order for OWML to be injected into the game you need to press "Launch Game" in the manager once.
| **Deck** | ✅ |
## Related Repos

View File

@ -37,7 +37,7 @@ Using the manager on Linux should be easy **proton and wine are not required**.
The manager can be installed on Steam Deck in Desktop Mode in the Discover app.
Please note that the manager itself can only be launched in desktop mode, but mods will persist if you switch to game mode and launch the game. And that in order for OWML to be injected into the game you need to press "Launch Game" in the manager once.
Note that you won't be able to launch the game from the manager when in steam deck's game mode. But so long as you've *pressed* "Launch Game" at least once, you can launch the game directly and it will still be modded.
## How do I uninstall it?
@ -58,6 +58,8 @@ Please ensure you have [Mono](https://www.mono-project.com/) installed and avail
To debug issues with mono set the `MONO_LOG_LEVEL` variable to `debug`. and look at the logs.
On steam deck, keep in mind the game won't launch if you click Launch Game from the manager while in game mode. You need to launch the game directly from the steam deck's game mode.
### On Flatpak
Also, ensure the game is located in `~/.steam/steam/steamapps/common/Outer Wilds`, otherwise the manager won't be able to find the game as it only has access to that folder.
@ -79,6 +81,8 @@ Depending on which package you want to contribute to, please refer to the follow
- [The CONTRIBUTING for the GUI](https://github.com/ow-mods/ow-mod-man/blob/main/owmods_gui/CONTRIBUTING.md)
- [The CONTRIBUTING for the CLI](https://github.com/ow-mods/ow-mod-man/blob/main/owmods_cli/CONTRIBUTING.md)
You can also take a look at [The Architecture Doc](https://github.com/ow-mods/ow-mod-man/blob/main/ARCHITECTURE.md) for more info above the manager's behavior.
## My issue isn't listed here
If you're encountering issues or have questions, please [open an Issue](https://github.com/ow-mods/ow-mod-man/issues/new/choose). You can also [view closed issues](https://github.com/ow-mods/ow-mod-man/issues?q=is%3Aissue+is%3Aclosed) to see if your issue has already been resolved.

View File

@ -30,10 +30,6 @@ Check out the [mods website](https://outerwildsmods.com/mod-manager/) for instru
Go into the Discover app in desktop mode and search "Outer Wilds" and the manager should appear.
#### Note For Deck
The manager itself can only be launched in desktop mode, but mods will persist if you switch to game mode and launch the game. Note that in order for OWML to be injected into the game you need to press "Launch Game" in the manager once.
## Building
Prerequisites: