Skip to content

Commit

Permalink
Document crash recovery
Browse files Browse the repository at this point in the history
  • Loading branch information
NotNite committed Jan 6, 2025
1 parent d1f5d8e commit 22fa58b
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
32 changes: 32 additions & 0 deletions src/content/docs/using/crash-recovery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Recovering from crashes
description: How to fix your client if it crashes on startup
sidebar:
order: 2
---

When Discord updates, there is a chance for moonlight (or the extensions you use) to break. In the event your Discord client is broken, follow these steps to recover it.

## Report the issue

In order for us to fix a bug, we need to know about it first! Bugs with moonlight itself can be reported [on GitHub issues](https://github.com/moonlight-mod/moonlight/issues) or in [the Discord server](https://discord.gg/FdZBTFCP6F). Bugs with extensions can be reported on the developer's Git repository (if issues are open).

:::note
Please check if the issue has already been reported beforehand. Reporting the same issue multiple times quickly overwhelms our ability to provide support.
:::

## Update moonlight

moonlight, and your extensions, can be updated from Moonbase. If you cannot access it, moonbase will attempt to let you update from the crash screen itself.

If you cannot update from the crash screen, you can update moonlight using the moonlight installer (or however you installed moonlight).

## Reset your config

The moonlight installer features a "Reset config" button. Clicking it will backup and reset your config. When you restart Discord, your client will act like you installed moonlight for the first time, with all extensions disabled and all settings reset.

You can also edit the config file manually, if you wish. See [the manual installation instructions](/using/install#manual-installations) for the config path.

## Unpatch moonlight

If all else fails, you can unpatch moonlight from the moonlight installer (or however you installed moonlight), and wait for an update to moonlight.
8 changes: 7 additions & 1 deletion src/content/docs/using/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,13 @@ You should have the following structure:
- package.json
</FileTree>

After first launch, moonlight will create a config directory in the Electron `appData` path named `moonlight-mod`. Each Discord branch has its own `.json` file for configuration.
After first launch, moonlight will create a config directory in the Electron `appData` path named `moonlight-mod`:

- Windows: `%AppData%/moonlight-mod`
- macOS: `~/Library/Application Support/moonlight-mod`
- Linux: `~/.config/moonlight-mod`

Each Discord branch has its own `.json` file for configuration.

## Browser

Expand Down

0 comments on commit 22fa58b

Please sign in to comment.