From f0324cd93a25cfdd8798bfe23af48bf2cb261052 Mon Sep 17 00:00:00 2001 From: sudacode Date: Wed, 13 May 2026 00:30:55 -0700 Subject: [PATCH] docs: simplify Windows setup instructions and remove experimental warnin - Remove "Windows support is experimental" warning across README and docs - Replace `bun run subminer` references with SubMiner mpv shortcut as recommended Windows launch method - Remove `subminer doctor` step from README quickstart - Clarify launcher script is primarily for Linux/macOS --- README.md | 23 +++++------------------ docs-site/installation.md | 7 ++----- docs-site/launcher-script.md | 2 +- docs-site/usage.md | 4 ++-- 4 files changed, 10 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 55db317d..0f65e885 100644 --- a/README.md +++ b/README.md @@ -229,11 +229,9 @@ sudo curl -fSL https://github.com/ksyasuda/SubMiner/releases/latest/download/sub
Windows -Download the latest installer or portable `.zip` from [GitHub Releases](https://github.com/ksyasuda/SubMiner/releases/latest). Make sure `mpv` is on your `PATH`. +Download the latest installer (`.exe`) [GitHub Releases](https://github.com/ksyasuda/SubMiner/releases/latest). Make sure `mpv` is on your `PATH`. -**Windows support is experimental.** Core features such as mining, annotations, and dictionary lookups work, but some functionality may be missing or unstable. Bug reports welcome. - -**Note:** On Windows the `subminer` launcher requires [`bun`](https://bun.sh) and must be invoked with `bun run subminer` instead of running the script directly. The recommended alternative is the **SubMiner mpv** shortcut created during first-run setup — double-click it, drag files onto it, or run `SubMiner.exe --launch-mpv` from a terminal. See the [Windows mpv Shortcut](https://docs.subminer.moe/usage#windows-mpv-shortcut) section for details. +**Note:** On Windows the recommended way to run SubMiner is with the **SubMiner mpv** shortcut created during first-run setup — double-click it, drag files onto it, or run `SubMiner.exe --launch-mpv` from a terminal. See the [Windows mpv Shortcut](https://docs.subminer.moe/usage#windows-mpv-shortcut) section for details.
@@ -250,23 +248,12 @@ See the [build-from-source guide](https://docs.subminer.moe/installation#from-so subminer app --setup # launch the first-run setup wizard ``` -SubMiner creates a default config, starts in the system tray, and opens a setup popup that walks you through installing the mpv plugin and configuring Yomitan dictionaries. Follow the on-screen steps to complete setup. - -Jellyfin setup is available from the tray or `subminer jellyfin`; once Jellyfin is enabled with a server URL, the tray can toggle Jellyfin Discovery for the current app session. +SubMiner creates a default config, starts in the system tray, and opens a setup popup that walks you through installing Yomitan dictionaries. Follow the on-screen steps to complete setup. > [!NOTE] > On Windows, run `SubMiner.exe` directly — it opens the setup wizard automatically on first launch. -### 3. Verify Setup - -```bash -subminer doctor # verify mpv, ffmpeg, config, and socket -``` - -> [!NOTE] -> On Windows, use `bun run subminer doctor` or run `SubMiner.exe` directly — first-run setup will guide you through dependency checks. - -### 4. Mine +### 3. Mine ```bash subminer video.mkv # play video with overlay @@ -276,7 +263,7 @@ subminer stats -b # stats daemon in background subminer stats -s # stop background stats daemon ``` -On **Windows**, the `subminer` script must be run with `bun run subminer` (e.g. `bun run subminer video.mkv`). The recommended alternative is the **SubMiner mpv** shortcut (created during setup) or `SubMiner.exe --launch-mpv`. Drag a video file onto the shortcut to play it, or double-click it to open mpv with SubMiner's defaults. +On **Windows**, use the **SubMiner mpv** shortcut created during first-run setup — double-click it to open mpv, or drag a video file onto it. You can also run `SubMiner.exe --launch-mpv` from a terminal. ## Documentation diff --git a/docs-site/installation.md b/docs-site/installation.md index 648325a6..c05efb47 100644 --- a/docs-site/installation.md +++ b/docs-site/installation.md @@ -301,9 +301,6 @@ binary_path=/Applications/SubMiner.app/Contents/MacOS/subminer ## Windows -> [!WARNING] -> **Windows support is experimental.** Core features — mining, annotations, and dictionary lookups — work, but some functionality may be missing or unstable. Bug reports welcome. - ### Prerequisites 1. Install [`mpv`](https://mpv.io/installation/) and ensure `mpv.exe` is on `PATH`. If mpv is installed elsewhere, you can set `mpv.executablePath` in `config.jsonc` or use the first-run setup field to point at the executable. @@ -333,7 +330,7 @@ The shortcut and `--launch-mpv` pass SubMiner's default IPC socket, subtitle arg ### Windows-Specific Notes -- The `subminer` launcher script requires [Bun](https://bun.sh) and must be invoked with `bun run subminer` on Windows since the shebang is not supported. The **SubMiner mpv** shortcut or `SubMiner.exe --launch-mpv` is the simpler alternative. +- The **SubMiner mpv** shortcut created during first-run setup is the recommended way to launch playback on Windows. The `subminer` launcher script is primarily for Linux and macOS. - First-run plugin installs pin `binary_path` to the current `SubMiner.exe` automatically. Manual plugin configs can leave `binary_path` empty unless SubMiner is in a non-standard location. - Plugin installs rewrite `socket_path` to `\\.\pipe\subminer-socket` — do not keep `/tmp/subminer-socket` on Windows. - Config is stored at `%APPDATA%\SubMiner\config.jsonc`. @@ -442,7 +439,7 @@ subminer doctor This checks for the app binary, mpv, ffmpeg, config file, and socket path. Fix any failures before continuing. > [!NOTE] -> On Windows, use `bun run subminer doctor` or run `SubMiner.exe` directly. Replace `SubMiner.AppImage` with `SubMiner.exe` in the direct app commands below. +> On Windows, run `SubMiner.exe` directly. Replace `SubMiner.AppImage` with `SubMiner.exe` in the direct app commands below. ## Optional Extras diff --git a/docs-site/launcher-script.md b/docs-site/launcher-script.md index 7160e80c..7aa6dcde 100644 --- a/docs-site/launcher-script.md +++ b/docs-site/launcher-script.md @@ -3,7 +3,7 @@ The `subminer` launcher is an all-in-one script that handles video selection, mpv startup, and overlay management. It is the recommended way to use SubMiner on Linux and macOS because it guarantees mpv is launched with the correct IPC socket and SubMiner defaults. It's a Bun script distributed as a release asset alongside the AppImage and DMG. ::: tip Windows users -On Windows the `subminer` script cannot run directly via shebang — use `bun run subminer` instead (e.g. `bun run subminer video.mkv`). The recommended alternative is the **SubMiner mpv** shortcut created during first-run setup, or `SubMiner.exe --launch-mpv`. See [Windows mpv Shortcut](/usage#windows-mpv-shortcut) for details. +On Windows, the recommended way to launch playback is the **SubMiner mpv** shortcut created during first-run setup — double-click it, drag a file onto it, or run `SubMiner.exe --launch-mpv` from a terminal. See [Windows mpv Shortcut](/usage#windows-mpv-shortcut) for details. ::: ## Video Picker diff --git a/docs-site/usage.md b/docs-site/usage.md index f8aeeacd..8f42c1b0 100644 --- a/docs-site/usage.md +++ b/docs-site/usage.md @@ -37,7 +37,7 @@ Field names must match your Anki note type exactly (case-sensitive). See [Anki I There are several ways to use SubMiner: > [!TIP] -> **New users: start with the `subminer` wrapper script** (or the **SubMiner mpv** shortcut on Windows). It handles mpv launch, IPC socket setup, and overlay lifecycle automatically so you don't need to configure anything in `mpv.conf`. +> **New users on Linux/macOS: start with the `subminer` wrapper script.** On Windows, use the **SubMiner mpv** shortcut created during first-run setup. Both handle mpv launch, IPC socket setup, and overlay lifecycle automatically so you don't need to configure anything in `mpv.conf`. | Approach | Use when | How | | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | @@ -45,7 +45,7 @@ There are several ways to use SubMiner: | **SubMiner mpv shortcut** (Windows) | The recommended Windows entry point. Created during first-run setup, launches mpv with SubMiner's defaults directly. | Double-click, drag a file onto it, or run `SubMiner.exe --launch-mpv` | | **MPV plugin** (all platforms) | You launch mpv yourself or from another tool (file manager, Jellyfin, etc.). Requires `--input-ipc-server=/tmp/subminer-socket` in your mpv config. | Use `y` chord keybindings inside mpv | -You can use both — the plugin provides in-player controls, while the `subminer` script (or the Windows shortcut) is convenient for direct playback. The `subminer` script runs directly via shebang on Linux and macOS (no `bun run` needed); on Windows it must be invoked with `bun run subminer` since the shebang is not supported. +You can use both — the plugin provides in-player controls, while the `subminer` script (Linux/macOS) or the SubMiner mpv shortcut (Windows) is convenient for direct playback. ## Live Config Reload