add an option to run mpvacious from the project root

Author: tatsumoto-ren

README.md

@@ -140,23 +140,42 @@ it'll install there instead of `AppData`.
 Installing Mpvacious in development mode allows contributors to easily test their changes.
 With this setup, any changes made to the *.lua files will be applied immediately after restarting mpv.
 
+#### First approach
+
 Clone the repository, then create a symlink from the `mpvacious` directory to the mpv config directory.
 
 Commands for GNU/Linux:
 
-```
+```bash
 git clone 'https://github.com/Ajatt-Tools/mpvacious.git'
 mkdir -p ~/.config/mpv/scripts/
 cd mpvacious
 bash scripts/symlink.sh
 ```
 
-To update existing installation, use `git`.
+To update an existing installation, use `git` in the project folder.
 
-```
+```bash
 git pull
 ```
 
+#### Second approach
+
+Clone the repo directly into the `mpv/scripts` directory.
+
+Commands for GNU/Linux:
+
+```bash
+mkdir -p ~/.config/mpv/scripts/
+git clone 'https://github.com/Ajatt-Tools/mpvacious.git' ~/.config/mpv/scripts/mpvacious
+```
+
+To update an existing installation, use `git`.
+
+```
+cd ~/.config/mpv/scripts/mpvacious && git pull
+```
+
 ### Manually
 
 This way is not recommended because it's easy to make a mistake during the process

main.lua

@@ -0,0 +1,14 @@
+-- For compatibility, allow running mpvacious
+-- by placing the project folder in mpv's scripts directory (e.g. ~/.config/mpv/scripts).
+-- Recommended only for mpvacious contributors.
+
+local mp = require('mp')
+local utils = require('mp.utils')
+local mpvacious_root = utils.join_path(mp.get_script_directory(), "mpvacious")
+
+-- Add mpvacious subfolder to Lua search path
+package.path = string.format("%s/?.lua;%s", mpvacious_root, package.path)
+print("new package path", package.path)
+
+-- Run the main script
+dofile(utils.join_path(mpvacious_root, "main.lua"))

mpvacious/config/utils.lua

@@ -15,7 +15,7 @@ local function create_config_file(default_profile_name)
     local name = default_profile_name
     -- ~/.config/mpv/script-opts/subs2srs.conf
     local config_filepath = utils.join_path(h.find_mpv_script_opts_directory(), string.format('%s.conf', name))
-    local example_config_filepath = utils.join_path(mp.get_script_directory(), "mpvacious/config/default_config.conf")
+    local example_config_filepath = utils.join_path(h.find_mpvacious_dir(), "config/default_config.conf")
 
     local file_info = utils.file_info(config_filepath)
     if file_info and file_info.is_file then

mpvacious/helpers.lua

@@ -546,6 +546,20 @@ function this.str_limit(str, n_chars)
     return table.concat(ret)
 end
 
+function this.find_mpvacious_dir()
+    -- The fallback path will be valid if the project folder is placed
+    -- in mpv's scripts directory (e.g. ~/.config/mpv/scripts).
+    -- This does not apply to normal installations of mpvacious.
+    -- https://github.com/mpv-player/mpv/blob/master/DOCS/man/lua.rst#mputils-functions
+    local default_path = mp.get_script_directory()
+    -- test if version file is present
+    local info = utils.file_info(utils.join_path(default_path, "version.json"))
+    if info and info.is_file then
+        return default_path
+    end
+    return utils.join_path(mp.get_script_directory(), "mpvacious")
+end
+
 --- Like pathlib.Path.read_text() but doesn't throw.
 --- Returns tuple[text, error].
 function this.read_text(file_path)

mpvacious/utils/release_checker.lua

@@ -14,17 +14,17 @@ local function make_release_checker()
     local private = {}
     local public = {}
 
-    private.repo="Ajatt-Tools/mpvacious"
-    private.max_time_sec=20
-    private.check_delay_sec=5
+    private.repo = "Ajatt-Tools/mpvacious"
+    private.max_time_sec = 20
+    private.check_delay_sec = 5
     private.api_check_url = "https://api.github.com/repos/" .. private.repo .. "/releases/latest"
     private.curl_args = { "-sL", "--max-time", tostring(private.max_time_sec), private.api_check_url }
     private.is_new_version_available = false
     private.latest_version = nil
     private.installed_version = nil
 
     local function read_installed_version_file()
-        local version_file_path = utils.join_path(mp.get_script_directory(), "version.json")
+        local version_file_path = utils.join_path(h.find_mpvacious_dir(), "version.json")
         local version_text, error = h.read_text(version_file_path)
         if error then
             mp.msg.error(error)