# Help

This file contains common questions for the manager.

## Table of Contents

- [Help](#help)
  - [Table of Contents](#table-of-contents)
  - [How do I use this?](#how-do-i-use-this)
    - [The manager has encountered a fatal error, the system cannot find the file specified (Windows)](#the-manager-has-encountered-a-fatal-error-the-system-cannot-find-the-file-specified-windows)
  - [Website buttons aren't working](#website-buttons-arent-working)
  - [How do I use this on Mac?](#how-do-i-use-this-on-mac)
  - [How do I use this on Linux?](#how-do-i-use-this-on-linux)
    - [Manager window is blank](#manager-window-blank)
    - [Manager doesn't launch on Wayland](#manager-doesnt-launch-on-wayland)
    - [Mod folder not found on Flatpak version of Steam](#mod-folder-not-found-on-flatpak-version-of-steam)
    - [What About Steam Deck?](#what-about-steam-deck)
  - [How do I uninstall it?](#how-do-i-uninstall-it)
  - [How do I update it?](#how-do-i-update-it)
  - [The game won't launch on Linux](#the-game-wont-launch-on-linux)
    - [On Flatpak](#on-flatpak)
  - [I made a mod! How do I submit it?](#i-made-a-mod-how-do-i-submit-it)
  - [I have a question about modding](#i-have-a-question-about-modding)
  - [I want to contribute to the manager](#i-want-to-contribute-to-the-manager)
  - [My issue isn't listed here](#my-issue-isnt-listed-here)

## How do I use this?

(See below for non-Windows instructions)

- Download the Outer Wilds Mod Manager from [the mods website](https://outerwildsmods.com/mod-manager);
- Run the downloaded .msi (you might need to ignore some Chrome / Windows warnings);
- Shortcuts are added to the desktop and start menu, use them to run the manager;
- Run the manager;
- Install OWML;
- Head to the "Get Mods" tab to install any mods you want;
- Press the top right play button to launch the game;
- You won't believe what happens next.

### The manager has encountered a fatal error, the system cannot find the file specified (Windows)

If you're getting an error message like this (or the manager isn't doing anything at all):

```txt
The manager encountered a fatal error when starting: Runtime(CreateWebview(WebView2Error(WindowsError(Error { code: 0x80070002, message: The system cannot find the file specified. }))))
```

This is most likely a result of not having the [Microsoft Edge WebView2 Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) installed. If you've used a "Window debloat" script, it's likely that this was removed, even though it's a component of Windows. To try and reinstall it, you can [download the evergreen bootstrapper](https://developer.microsoft.com/en-us/microsoft-edge/webview2/) and let it install.

The manager's installer is supposed to install Webview2 for you, but depending on how programs uninstall Webview2, it may have left bad registry keys that make the Webview2 bootstrapper think it's already installed. If you're still having issues, try inspecting the registry keys mentioned in [this Webview2 article](https://learn.microsoft.com/en-us/microsoft-edge/webview2/concepts/distribution?tabs=dotnetcsharp#detect-if-a-webview2-runtime-is-already-installed) to see if they're pointing to bad folders. Most likely the one in `HKEY_LOCAL_MACHINE` will be defined and the one in `HKEY_CURRENT_USER` won't, if so only inspect the one in `HKEY_LOCAL_MACHINE`.

If either of these keys contain a path that's invalid set the subkey `pv` to `0.0.0.0` and run the Webview2 installer again, this should make it realize it's not installed.

## Website Buttons Aren't Working

This may be due to an update from 0.14.2 to 0.15.0. The path for the procotol handler changed.

1. Uninstall the manager entirely.
2. In `regedit`, delete `HKEY_LOCAL_MACHINE\Software\Classes\owmods` and `HKEY_CURRENT_USER\Software\Classes\owmods`.
3. Re-install the manager, the registry keys should now point to the right executable.

On Linux you may need to delete a file in `~/.local/share/applications` called something along the lines of `outer-wilds-mod-manager-handler.desktop`. The old version used to make this desktop entry on launch but it is not needed anymore as the .desktop file in the package should be setup to handle the scheme for you.

## How do I use this on Mac?

The manager can be used on MacOS with some caveats:

1. We haven't setup code signing because Apple moment:
   1. Try to open the DMG for the manager at least once
   2. System Preferences -> Security & Privacy -> General -> Allow apps downloaded from -> Outer Wilds Mod Manager -> Open anyway
2. Seeing as how Outer Wilds isn't available on MacOS, OWML will not be able to find the game on its own. You'll need to manually set it in the settings menu (Gear in the top-corner, scroll down to OWML Settings -> Game Path). This folder should contain the game's `.exe` file and the `OuterWilds_Data` folder.
3. The manager needs [Mono](https://www.mono-project.com/docs/getting-started/install/mac/) to be installed in order to run OWML. The manager assumes the default location of Mono at `/Library/Frameworks/Mono.framework/Versions/Current/Commands/mono` however this path can be overridden with the `MONO_BINARY` environment variable
4. The manager will not be able to launch the game directly. After you see a "Client Disconnected From Console" message in the logs window your game will be patched to run modded, just launch the game directly.
   1. Note if you see a message along the lines of "Current game path not valid", this means that the game hasn't been patched. You'll need to set the game path in the settings menu and try again.

MacOS support is experimental and not well-tested. If you need help troubleshooting or have a suggestion for
improving the MacOS experience, please [open an issue](https://github.com/ow-mods/ow-mod-man/issues/new/choose)
or come chat with us on [the Discord server](https://discord.com/invite/wusTQYbYTc).

## How do I use this on Linux?

Using the manager on Linux should be easy, **proton and wine are not required**. The manager requires [Mono](https://www.mono-project.com) 6 to be installed and available on the PATH. If you're using the Flatpak, AUR, or Nix versions, Mono will be installed and set up automatically.

### Manager Window Blank

This can be due to an issue with webkit2gtk using accelerated compositing. To disable this set the `WEBKIT_DISABLE_COMPOSITING_MODE` environment variable to `1`. If you're on the Flatpak version of the manager this can be done with [the FlatSeal application](https://flathub.org/apps/com.github.tchx84.Flatseal), use it to edit the manager's flatpak to set the variable.

If you're on other distros/package formats you can try editing the `.desktop` file of the manager like so:

```diff
- Exec=outer-wilds-mod-manager %u
+ Exec=env WEBKIT_DISABLE_COMPOSITING_MODE=1 outer-wilds-mod-manager %u
```

### Manager Doesn't Launch on Wayland

If you're getting an error like:

```
Error 71 (Protocol error) dispatching to Wayland display.
```

And you're on a Nvidia card, try setting the `__NV_DISABLE_EXPLICIT_SYNC` environment variable to `1`. You can follow the same instructions in "[Manager window is blank](#manager-window-blank)" to set this environment variable.

### Mod folder not found on Flatpak version of Steam

This is an issue with sharing the manager's folder with Steam, as OWML will be running from within Steam's flatpak container it won't be able to access the mods folder. See [this issue](https://github.com/ow-mods/ow-mod-man/issues/501) for details. tl;dr:

1. Move the OWML folder from `~/.local/share/OuterWildsModManager/OWML` to `~/.var/app/com.valvesoftware.Steam/.local/share/OuterWildsModManager/OWML`, this will make it available to the Steam container
2. Change your OWML path in the manager settings to `~/.var/app/com.valvesoftware.Steam/.local/share/OuterWildsModManager/OWML` to point to the new OWML location
3. Reverify your game files in Steam, this is to remove any possibly bad versions of OWML that still point to the old path
4. Try to launch the game again through the manager

### What About Steam Deck?

The manager can be installed on Steam Deck in Desktop Mode in the Discover app.

The mod manager requires that the game is installed in `~/.steam/steam/steamapps/common/Outer Wilds` or `~/Games/Heroic/OuterWilds`.

When selecting game path **DO NOT** use the browse button, on Flatpak this tries to open a portal which
won't work, you'll need to enter the path manually or copy it.

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.

**To use the manager in Game Mode, you'll also need to change your controller layout to the "Mouse Only" template.**

## How do I uninstall it?

You can uninstall the Mod Manager by searching for "Add or remove programs" in the start menu (or in the control panel) and then finding "Outer Wilds Mod Manager" in the list. However, this won't uninstall your mods.

To revert the game to its original state, verify the game files' integrity:

- **Steam**: Library > Right-click Outer Wilds > Properties > Local Files > Verify integrity of game files.
- **Epic**: Library > Click three dots under Outer Wilds > Verify.

## How do I update it?

The manager will automatically check for updates when you launch it. If an update is available, you will be prompted to download it. On the Flatpak, AUR, and Nix versions, your system's package manager will handle updates.

## The game won't launch on Linux

Please ensure you have [Mono](https://www.mono-project.com/) installed and available on your PATH.

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 OWML Flatpak + Non-Flatpak Steam

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.

### On OWML Flatpak + Steam Flatpak

Make sure you set the Game Path to `~/.var/app/com.valvesoftware.Steam/.local/share/Steam/steamapps/common/Outer Wilds/` and the OWML path to `~/.var/app/com.valvesoftware.Steam/.local/share/OuterWildsModManager/OWML`. You may have to make the `~/.var/app/com.valvesoftware.Steam/.local/share/OuterWildsModManager` directory in order for this to work.

## I made a mod! How do I submit it?

The mod database is stored in a separate repository. [Go here to find out how to add your mod to the list](https://github.com/ow-mods/ow-mod-db#readme).

## I have a question about modding

Please refer to the [OWML documentation](https://owml.outerwildsmods.com) for information about creating mods.

## I want to contribute to the manager

Depending on which package you want to contribute to, please refer to the following:

- [The main CONTRIBUTING (read this first)](https://github.com/ow-mods/ow-mod-man/blob/main/CONTRIBUTING.md)
- [The CONTRIBUTING for the Core package](https://github.com/ow-mods/ow-mod-man/blob/main/owmods_core/CONTRIBUTING.md)
- [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 about 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.

We also have [a Discord server](https://discord.com/invite/wusTQYbYTc) available if you want to chat.

You can also email `bwc9876@outerwildsmods.com` if your issue is sensitive / security related.