From 463200bc1622bfe6496a648506577ac97aa23c55 Mon Sep 17 00:00:00 2001 From: Zarg <62082797+Zaarrg@users.noreply.github.com> Date: Wed, 15 Jan 2025 10:34:21 +0100 Subject: [PATCH] Update README.md --- README.md | 131 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 128 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f256801..58c030d 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ MPV Win32 +

+

Scoop @@ -25,23 +27,24 @@ Torrents

+ ## 🌟 **Features** - 🚀 **Latest Technology**: Built with WebView2 to provide the newest features and best performance - 🌐 **Latest Web Ui**: Always up-to-date with Stremio Web v5 - 🎞️ **Native Playback**: Integrated Player for native 4K playback, hardware decoding, and fastest video performance - 🔍 **Video Upscaling**: Upscaling support for anything mpv supports -- 🎥 **Full MPV Support**: Full MPV support use any hwdec, gpu-api or gpu-context like d3d, opengl and vulkan or `target-colorspace-hint=yes` for DV content +- 🎥 **Full MPV Support**: Full MPV support use any hwdec, gpu-api or gpu-context like d3d, opengl and vulkan - 🌈 **HDR Support**: Full HDR Support thanks to fully supported mpv and any other mpv feature - 🔊 **Dolby Atmos Support**: Support for all mpv advanced audio features. - 🖼️ **Picture in Picture**: Picture in Picture Mode Support - 🌑 **Dark Mode**: Windows Dark mode support - 🖼️ **Thumbnail Preview**: ThumbFast support to allow for preview thumbnails when seeking -- 📁 **Local File Playback**: Play any local file that MPV and ffmpeg supports, just use open with 'stremio' or drag and drop +- 📁 **Local File Playback**: Play any file MPV and ffmpeg supports, just use **open with** 'stremio' or **drag and drop** - 🌀 **Torrent Support**: Play any local .torrent file or any magnet: link - 📺 **Chromecast Support**: Cast Videos to your Chromecast - ➕ **Easy Addon Install**: Just use the install Button like stremio v4, no need to copy paste urls - 💼 **Portable Version**: Fully portable version including WebView2. -- ⚙️ **App Settings**: Customize App behavior like CloseOnExit, PauseOnMinimize or PauseOnLostFocus and more via stremio-settings.ini. +- ⚙️ **App Settings**: Customize options like CloseOnExit, PauseOnMinimize, and PauseOnLostFocus via stremio-settings.ini. @@ -67,3 +70,125 @@ - Coming soon! > **⏳ Note:** Linux and Mac release will take considerable time as they need their own build with os specific technology's + +## 🔍 **Mpv Upscalers** + +- 🎥 **[Anime4k](https://github.com/bloc97/Anime4K)** + - ✅ Included by default. + - 🔢 Use `CTRL+1` - `CTRL+6` to enable shaders. + - ❌ Use `CTRL+0` to disable. + +- 🎨 **[AnimeJaNai](https://github.com/the-database/mpv-upscale-2x_animejanai)** + - ❌ Not included by default. + - 📥 Download from the **Stremio-Desktop-v5** [release tab](https://github.com/Zaarrg/stremio-desktop-v5) the `stremio-animejanai-3.x.x.7z` for Stremio and drop the content of the 7z into `%localAppData%\Programs\LNV\Stremio-5\` and `replace all` + - 🛠️ **Changes made:** + - Removed `mpvnet.exe` as Stremio is used as the player. + - Adjusted `mpv.conf` to work with Stremio. + - Adjusted `input.conf` to work with Stremio. + - ⌨️ **Possible Keybindings** + - 🎬 `CTRL+J` Show Upscaler Status + - 🛠️ `CTRL+E` Open AnimeJaNai ConfEditor + - ❌ `CTRL+0` Disable Upscaling + - 🔢 `SHIFT+1` - `SHIFT+3` Select Quality, Balanced or Performance Profiles + - ⚙️ `CTRL+1` - `CTRL+9` Switch between Custom Profiles + - 🔗 For more, check [AnimeJaNai](https://github.com/the-database/mpv-upscale-2x_animejanai) + +> **⏳ Note:** When using AnimeJaNai on first playback Stremio will be unresponsive and a console will open to build the model via e.g. TensorRT. You will need to wait until the console closes for playback to start. This happens only once per model. + + +- 🚀 **Nvidia RTX and Intel VSR Scaling** + - ✅ Supported by using `mpv.conf`. + - ✍️ Modify in `%localAppData%\Programs\LNV\Stremio-5\` the ``portable_config/mpv.conf`` and add the line ``vf=d3d11vpp=scale=2:scaling-mode=nvidia`` more details [here](https://www.reddit.com/r/nvidia/comments/1foyl4n/mpv_player_v0390_adds_rtx_video_super_resolution/) + +## 🔍 **Mpv Addons** + +- 🎥 **[ThumbFast](https://github.com/po5/thumbfast)** + - 🔧 Go in the `Stremio-Dekstop-v5` Repo to ``utils/mpv/thumbfast`` or ``direct-link`` and download ``thumbfast.7z``. Drag and Drop the archive contents into ``%localAppData%\Programs\LNV\Stremio-5\`` + - 📁 Works best with local files as there is no **network bottleneck**. U can `Drag and Drop` any local file into **Stremio** or right click ``Open With > Stremio`` + + +## ✨ **Stremio App** + +- 📁 **Local Files** + - Play any **local file** or **torrent** by `drag and dropping` or ``Open With > Stremio`` that mpv and ffmpeg support + - Play any **magnet** by `opening it via the browser` in Stremio or `copy pasting` it into the **Search Bar** + +- 🧩 **Browser Extensions** + - Add any Browser Extension to Stremio by dropping the ``unpacked`` Extension into ``portable_config/extensions`` + - On Start Extensions from ``portable_config/extensions`` are loaded. + - 👉 **To install extension:** + 1. Get the ``unpacked`` Extensions from``%localAppData%\Microsoft\Edge SxS\User Data\Default\Extensions``. + 2. Here look for the `mainfest.json` for example ublock `{string-id}/1.62.0_0/manifest.json` as all the content beside is the extension + 3. Now we can copy the contents of ``{string-id}/1.62.0_0`` to ``%localAppData%\Programs\LNV\Stremio-5\portable_config\extensions\ublock`` + 4. Important is that the ``mainfest.json`` is located directly in ``portable_config\extensions\ublock`` + 5. Done. Restart app and addon will be loaded. If loading fails check ``portable_config\errors-{date}.txt`` + +- ⚙️ **App Settings** + - All App Settings can be adjusted with ``portable_config\stremio-settings.ini`` + - Some options can be set by `right-clicking` on the **tray icon** as well. + - ⌨️ **Possible Settings** + - ❌ ``CloseOnExit`` Close app on exit instead of minimized to tray + - 🌓 ``UseDarkTheme`` Toggle dark theme + - 📏 ``ThumbFastHeight`` Enable thumbfast and set the thumbfast image height. This adjust the offset of the top left corner of the thumb. Meaning `100` will move the top left corner 100px up. `0` disables thumbfast + - 😴 ``PauseOnMinimize`` Pause playback on window minimize + - 👀 ``PauseOnLostFocus`` Pause playback on window loses focus + - 🔍 ``AllowZoom`` Allow zoom via `pinch action` or ``CTRL+Scroll`` + +## 🎛️ **Mpv Configuration** + +Enhance your Stremio experience by customizing the MPV player settings. Below are the key configuration files and guidelines to help you get started: + +- 📁 **`mpv.conf` Location** + - The ``mpv.conf`` file can be found in the following location: + - **Installation Path:** ``%localAppData%\Programs\LNV\Stremio-5\portable_config\mpv.conf`` + - **Shaders Folder:** Located within the installation directory ``..\Stremio-5\portable_config\shaders``. + +- **🎹 Usage example of `mpv.conf` for DV Content:** + ```shell + # MPV Conf for DV Content + vo=gpu-next + gpu-api=vulkan + target-colorspace-hint=yes + ``` +or `target-colorspace-hint=yes` for DV content + +> **⏳ Note:** Any other configuration files can be just dropped into ``%localAppData%\Programs\LNV\Stremio-5\portable_config`` as this is the mpv ``config-dir`` like ``input.conf``. ``scripts`` or ``scripts-conf`` + +- **🎹 Usage example in `input.conf` using [Anime4k](https://github.com/bloc97/Anime4K):** + ```shell + # Optimized shaders for higher-end GPU + CTRL+1 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl;~~/shaders/Anime4K_Restore_CNN_VL.glsl;~~/shaders/Anime4K_Upscale_CNN_x2_VL.glsl;~~/shaders/Anime4K_AutoDownscalePre_x2.glsl;~~/shaders/Anime4K_AutoDownscalePre_x4.glsl;~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode A (HQ)" + CTRL+2 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl;~~/shaders/Anime4K_Restore_CNN_Soft_VL.glsl;~~/shaders/Anime4K_Upscale_CNN_x2_VL.glsl;~~/shaders/Anime4K_AutoDownscalePre_x2.glsl;~~/shaders/Anime4K_AutoDownscalePre_x4.glsl;~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode B (HQ)" + CTRL+3 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl;~~/shaders/Anime4K_Upscale_Denoise_CNN_x2_VL.glsl;~~/shaders/Anime4K_AutoDownscalePre_x2.glsl;~~/shaders/Anime4K_AutoDownscalePre_x4.glsl;~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode C (HQ)" + CTRL+4 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl;~~/shaders/Anime4K_Restore_CNN_VL.glsl;~~/shaders/Anime4K_Upscale_CNN_x2_VL.glsl;~~/shaders/Anime4K_Restore_CNN_M.glsl;~~/shaders/Anime4K_AutoDownscalePre_x2.glsl;~~/shaders/Anime4K_AutoDownscalePre_x4.glsl;~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode A+A (HQ)" + CTRL+5 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl;~~/shaders/Anime4K_Restore_CNN_Soft_VL.glsl;~~/shaders/Anime4K_Upscale_CNN_x2_VL.glsl;~~/shaders/Anime4K_AutoDownscalePre_x2.glsl;~~/shaders/Anime4K_AutoDownscalePre_x4.glsl;~~/shaders/Anime4K_Restore_CNN_Soft_M.glsl;~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode B+B (HQ)" + CTRL+6 no-osd change-list glsl-shaders set "~~/shaders/Anime4K_Clamp_Highlights.glsl;~~/shaders/Anime4K_Upscale_Denoise_CNN_x2_VL.glsl;~~/shaders/Anime4K_AutoDownscalePre_x2.glsl;~~/shaders/Anime4K_AutoDownscalePre_x4.glsl;~~/shaders/Anime4K_Restore_CNN_M.glsl;~~/shaders/Anime4K_Upscale_CNN_x2_M.glsl"; show-text "Anime4K: Mode C+A (HQ)" + + CTRL+0 no-osd change-list glsl-shaders clr ""; show-text "GLSL shaders cleared" + ``` +> **⏳ Note:** Some keys might not work as key presses are converted from js event.codes to literal values for mpv + +## ⚙️ **Start Arguments** +Use these extra arguments when launching the application: + +| Argument | Example | Description | +|-----------------------------|-------------------------------------------------------|-----------------------------------------------------------------------------------------------------------| +| --webui-url= | --webui-url=https://web.stremio.com/ | Loads web ui from `https://web.stremio.com/` | +| --streaming-server-disabled | | Disable auto start of `streamio-server`, Default behaviour in prod +| --autoupdater-force-full | | Forces Autoupdate to always do a `full-update` rather than `partial` | +| --autoupdater-endpoint= | --autoupdater-endpoint==https://verison.mydomain.com/ | Overrides default checking endpoint for the autoupdater | + +> **⏳ Note:** By default will use as ``webui-url`` the [stremio-web-shell](https://github.com/Zaarrg/stremio-web-shell-fixes) web-ui hosted [here](https://zaarrg.github.io/stremio-web-shell-fixes/#/) which includes fixes to run smoothly with qt6 + +## 📚 **Guide / Docs** +If you want to build this app yourself, check the “[docs](https://github.com/Zaarrg/stremio-desktop-v5/tree/master/docs)” folder in this repository for setup instructions and additional information. + +## ⚠️ **Disclaimer** +This project is not affiliated with **Stremio** in any way. + +## 🤝 **Support Development** +If you enjoy this project and want to support further development, consider [buying me a coffee](https://ko-fi.com/zaarrg). Your support means a lot! ☕ + +

+ ⭐ Made with ❤️ by Zaarrg ⭐ +

\ No newline at end of file