Skip to content

Commit 81e0355

Browse files
committed
Improve install docs, some misc fixes
1 parent e88d868 commit 81e0355

File tree

2 files changed

+40
-25
lines changed

2 files changed

+40
-25
lines changed

src/content/docs/dev/publishing.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,6 @@ moonlight CI builds the `develop` branch automatically. This section is for publ
4444
- We originally didn't have the types version in sync with moonlight, but we're aiming to resync. Bump the patch version until we can eventually re-synchronize them.
4545
- Continue to publish a moonlight release like normal, and wait for CI to finish.
4646
- [Run the types workflow](https://github.com/moonlight-mod/moonlight/actions/workflows/types.yml) to manually trigger a release to npm.
47-
- In [the sample extension](https://github.com/moonlight-mod/sample-extension), update the types package: `pnpm update @moonlight-mod/types`
48-
- Remember to `git pull` and `pnpm i` beforehand so you are up to date.
49-
- Commit and push to the sample extension.
50-
- Update [create-extension](https://github.com/moonlight-mod/create-extension) following [these instructions](#publishing-other-libraries).
5147
- If the manifest type was updated, regenerate the schema: `pnpx ts-json-schema-generator --path './packages/types/src/*.ts' --type ExtensionManifest -f ./tsconfig.json > ../moonlight-mod.github.io/public/manifest.schema.json`
5248

5349
## Publishing other libraries

src/content/docs/using/install.mdx

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: How to install, build, and use moonlight
44
sidebar:
55
order: 1
66
---
7-
import { FileTree, LinkButton } from "@astrojs/starlight/components";
7+
import { FileTree, LinkButton, Tabs, TabItem, Aside } from "@astrojs/starlight/components";
88

99
There are several ways to install moonlight. It is suggested to use the installer or CLI if you are not a developer.
1010

@@ -16,31 +16,58 @@ Despite that, we try our best to ensure your account and system is safe. There a
1616

1717
## moonlight installer
1818

19-
<LinkButton href="https://github.com/moonlight-mod/moonlight-installer/releases/latest/download/moonlight-installer.exe" icon="seti:windows">Download</LinkButton>
20-
<LinkButton href="https://github.com/moonlight-mod/moonlight-installer/releases/latest/download/moonlight-installer-macos.dmg" icon="apple">Download</LinkButton>
19+
The moonlight [installer](https://github.com/moonlight-mod/moonlight-installer) automates the installation process for you. To use it, [download](https://github.com/moonlight-mod/moonlight-installer/releases/latest) and run the installer, download moonlight through it, and then patch a Discord installation.
2120

22-
The moonlight [installer](https://github.com/moonlight-mod/moonlight-installer) automates the installation process for you. **This is the suggested way to install moonlight for Windows and macOS users.**
21+
Discord installations are autodetected on your machine. Keep the installer in the event that a Discord update breaks moonlight, so you can unpatch Discord or update moonlight.
22+
23+
<Tabs>
24+
<TabItem label="Windows">
25+
<LinkButton href="https://github.com/moonlight-mod/moonlight-installer/releases/latest/download/moonlight-installer.exe" icon="seti:windows">Download</LinkButton>
26+
27+
Download and run `moonlight-installer.exe`. Close Discord fully before patching.
28+
</TabItem>
29+
30+
<TabItem label="macOS">
31+
<LinkButton href="https://github.com/moonlight-mod/moonlight-installer/releases/latest/download/moonlight-installer-macos.dmg" icon="apple">Download</LinkButton>
32+
33+
Download and run `moonlight-installer-macos.dmg`.
34+
<Aside>
35+
Patching on macOS may cause issues with application signing, and moonlight currently does not persist between updates on macOS. This is planned to be fixed in the near future.
36+
</Aside>
37+
</TabItem>
38+
39+
<TabItem label="Linux">
40+
<LinkButton href="https://flathub.org/apps/io.github.moonlight_mod.moonlight-installer" icon="linux">Download</LinkButton>
41+
42+
Install [Flatpak](https://flatpak.org/), then install the moonlight installer from Flathub.
43+
44+
<Aside>
45+
Only some methods of Discord installations are supported:
46+
47+
- Local installations in `~/.local/share`
48+
- A script to install Discord locally (maintained by a community member) is available [here](https://gist.github.com/maddymeows/6af1a5d5a870c13b7b159c4463edee70).
49+
- moonlight has an auto updater for Linux in the "Native Fixes" extension.
50+
- Discord installed through Flatpak as a user
51+
- System installations are not supported.
52+
53+
Discord installations from system package managers are not supported.
54+
</Aside>
55+
</TabItem>
56+
</Tabs>
2357

24-
To use it, [download](https://github.com/moonlight-mod/moonlight-installer/releases/latest) and run the installer, download moonlight through it, and then patch a Discord installation. Discord installations are autodetected on your machine. Keep the installer in the event that a Discord update breaks moonlight, so you can unpatch Discord or update moonlight.
2558

2659
## moonlight-cli
2760

28-
A [command line installer](https://github.com/moonlight-mod/moonlight-installer/tree/main/crates/moonlight-cli) can be compiled from source manually and used to patch moonlight. **This is the suggested way to install moonlight for Linux users.**
61+
A [command line installer](https://github.com/moonlight-mod/moonlight-installer/tree/main/crates/moonlight-cli) can be compiled from source manually and used to patch moonlight.
2962

3063
```shell
3164
cargo install --git https://github.com/moonlight-mod/moonlight-installer.git moonlight-cli
32-
moonlight-cli install stable
65+
moonlight-cli install stable # or `moonlight-cli install nightly`
3366
moonlight-cli patch /path/to/discord/executable
3467
```
3568

3669
You can specify a custom moonlight `dist` directory with `moonlight-cli patch -m /path/to/moonlight/dist`.
3770

38-
:::note
39-
Discord installations from Linux package managers may not work well with moonlight (due to root permissions or immutability). It is suggested to install Discord locally into a path like `~/.local/share`.
40-
41-
A script to install Discord locally (maintained by a community member) is available [here](https://gist.github.com/maddymeows/6af1a5d5a870c13b7b159c4463edee70). You will need to patch this Discord installation manually after installing it.
42-
:::
43-
4471
## Manual installations
4572

4673
Manual installations are suggested for those who wish to work on moonlight itself.
@@ -95,14 +122,6 @@ The output extension will be at `dist/browser`. Chrome users can check "Develope
95122

96123
Browser support is experimental and may be unreliable. Developing extensions or using custom repositories is not supported with the browser extension.
97124

98-
## rocketship
99-
100-
Linux users can install a custom Discord build with [rocketship](https://github.com/moonlight-mod/rocketship) and then install moonlight into it. Enable the rocketship extension after installation.
101-
102-
:::caution
103-
rocketship is experimental and may break. If you don't care about the benefits of rocketship, use [moonlight-cli](#moonlight-cli) instead.
104-
:::
105-
106125
## Nix
107126

108127
moonlight offers [a Nix flake](https://github.com/moonlight-mod/moonlight/blob/main/flake.nix) which has an overlay to install moonlight on top of Discord. The flake is not monitored, so if it fails to build, please leave an issue.

0 commit comments

Comments
 (0)