From 0df58e30e2014949fefbe5518db16e9f26556997 Mon Sep 17 00:00:00 2001 From: Raidriar796 <145519075+Raidriar796@users.noreply.github.com> Date: Mon, 22 Apr 2024 12:22:48 -0700 Subject: [PATCH] Update README.md Added info on how the mod works and explaining the terminal pop up --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4fda15e..5ac6935 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,25 @@ A [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader) mod for [Resonite](https://resonite.com/) that runs the built in update function for yt-dlp on startup, includes option to change the update branch. +**Only Windows and Linux with Proton is supported, Native Linux support is planned.** ## Requirements -- [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader) +- [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader) 2.5.0 or later +- [ResoniteModSettings](https://github.com/badhaloninja/ResoniteModSettings) for changing update branch in Resonite ## Installation 1. Install [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader). 2. Place [ytdlpUpdater.dll](https://github.com/Raidriar796/yt-dlp-Updater/releases/latest/download/ytdlpUpdater.dll) into your `rml_mods` folder. This folder should be at `C:\Program Files (x86)\Steam\steamapps\common\Resonite\rml_mods` for a default install. You can create it if it's missing, or if you launch the game once with ResoniteModLoader installed it will create the folder for you. 3. Start the game. If you want to verify that the mod is working you can check your Resonite logs. + +## How does it work? + +Resonite comes bundled with yt-dlp in the `RuntimeTools` folder, this .exe is instantiated everytime a video link is pasted into Resonite so the video can be streamed through Resonite. + +yt-dlp has a built in update function and because it's installed as a standalone .exe, it can be called upon with the update arguments. In the case of this mod, the update function is ran when the engine starts and when the config changes. + +Since the .exe is instantiated, it can be updated during runtime and you can start using the updated version immediately. + +## Why does a terminal appear everytime Resonite starts? + +yt-dlp has an embedded python runtime which always opens a terminal when called upon through this mod. A modified version of yt-dlp would be needed to not have a terminal open. \ No newline at end of file