Improve default options and behaviour.

README.md

@@ -25,16 +25,31 @@ You can then pull to receive updates.
 Alternatively, you can download the zip and extract the contents to `~~/scripts/file-browser`.
 `~~/` is the mpv config directory which is typically `~/.config/mpv/` on linux and `%APPDATA%/mpv/` on windows.
 
-Create a `file_browser.conf` file in the `~~/script-opts/` directory and customise the [`root` option](#root-directory) for your
-system. The [`docs/file_browser.conf`](docs/file_browser.conf) file contains the full list of options and their defaults.
+### Configuration
+
+Create a `file_browser.conf` file in the `~~/script-opts/` directory to configure the script.
+See [docs/file_browser.conf](docs/file_browser.conf) for the full list of options and their default values.
+The [`root` option](#root-directory) may be worth tweaking for your system.
+
+### Addons
+
+To use [addons](addons/README.md) place addon files in the `~~/script-modules/file-browser-addons/` directory.
+
+### Custom Keybinds
+To setup [custom keybinds](docs/custom-keybinds.md) create a `~~/script-opts/file-browser-keybinds.json` file.
+Do **not** copy the `file-browser-keybinds.json` file
+stored in this repository, that file is a collection of random examples, many of which are for completely different
+operating systems. Use them and the [docs](docs/custom-keybinds.md) to create your own collection of keybinds.
+
+### File Structure
 
 <details>
-<summary>Expected directory tree:</summary>
+<summary>Expected directory tree (basic):</summary>
 
 ```
 ~~/
 ├── script-opts
-│   └── file-browser.conf
+│   └── file_browser.conf
 └── scripts
     └── file-browser
         ├── addons/
@@ -47,21 +62,8 @@ system. The [`docs/file_browser.conf`](docs/file_browser.conf) file contains the
 ```
 </details>
 
-### Advanced
-
-To setup [custom keybinds](docs/custom-keybinds.md) enable the `custom_keybinds` option in `file_browser.conf` and
-create a `~~/script-opts/file-browser-keybinds.json` file. Do **not** copy the `file-browser-keybinds.json` file
-stored in this repository, that file is a collection of random examples, many of which are for completely different
-operating systems. Use them and the [docs](docs/custom-keybinds.md) to create your own collection of keybinds.
-
-To setup [addons](addons/README.md) enable the `addons` option in `file_browser.conf` and place the addon files
-in the `~~/script-modules/file-browser-addons/` directory.
-
-If you are not going to enable custom keybinds or addons then there is no reason to
-create `file-browser-keybinds.json` or `script-modules/file-browser-addons/`.
-
 <details>
-<summary>Expected directory tree:</summary>
+<summary>Expected directory tree (full):</summary>
 
 ```
 ~~/
@@ -120,6 +122,10 @@ The following dynamic keybinds are only set while the browser is open:
 | s           | select_mode   | toggles multiselect mode                                                      |
 | S           | select_item   | toggles selection for the current item                                        |
 | Ctrl+a      | select_all    | select all items in the current directory                                     |
+| Ctrl+f      | find/find     | Opens a text input to search the contents of the folder - requires [mpv-user-input](#mpv-user-input) when mpv < v0.38|
+| Ctrl+F      | find/find_advanced| Allows using [Lua Patterns](https://www.lua.org/manual/5.1/manual.html#5.4.1) in the search input|
+| n           | find/next     | Jumps to the next matching entry for the latest search term                   |
+| N           | find/prev     | Jumps to the previous matching entry for the latest search term               |
 
 When attempting to play or append a subtitle file the script will instead load the subtitle track into the existing video.
 
@@ -130,11 +136,9 @@ By default the playlist will only be autoloaded if `Alt+ENTER` is used on a sing
 
 To accomodate for both windows and linux this script has its own virtual root directory where drives and file folders can be manually added. The root directory can only contain folders.
 
-The root directory is set using the `root` option, which is a comma separated list of directories. Entries are sent through mpv's `expand-path` command. By default the only root value is the user's home folder:
-
-`root=~/`
-
-It is highly recommended that this be customised for the computer being used; [file_browser.conf](file_browser.conf) contains commented out suggestions for generic linux and windows systems. For example, my windows root looks like:
+The root directory is set using the `root` option, which is a comma separated list of directories. Entries are sent through mpv's `expand-path` command. By default `~/` and `C:/` are set on Windows
+and `~/` and `/` are set on non-Windows systems.
+Extra locations can be added manually, for example, my Windows root looks like:
 
 `root=~/,C:/,D:/,E:/,Z:/`
 
@@ -189,11 +193,6 @@ The `response-string` refers to an arbitrary script-message that the tables shou
 
 This script-message allows other scripts to utilise file-browser's directory parsing capabilities, as well as those of the file-browser addons.
 
-## Configuration
-
-See [file_browser.conf](docs/file_browser.conf) for the full list of options and their default values.
-The file is placed in the `~~/script-opts/` folder.
-
 ## Conditional Auto-Profiles
 
 file-browser provides a property that can be used with [conditional auto-profiles](https://mpv.io/manual/master/#conditional-auto-profiles)

docs/addons.md

@@ -227,14 +227,16 @@ Below is a table of suggested priority ranges:
 
 | Range   | Suggested Use                                                                                  | Example parsers                                |
 |---------|------------------------------------------------------------------------------------------------|------------------------------------------------|
-| 0-20    | parsers that purely modify the results of other parsers                                        | [m3u-fixer](m3u-browser.lua)                   |
-| 21-40   | virtual filesystems which need to link to the results of other parsers                         | [favourites](favourites.lua)                   |
+| 0       | priority of the internal cache addon that caches the results of other parsers                  | [cache](../modules/addons/cache.lua)           |
+| 1-20    | parsers that purely modify the results of other parsers                                        | [url-decode](../addons/url-decode.lua)         |
+| 21-40   | virtual filesystems which need to link to the results of other parsers                         | [favourites](../addons/favourites.lua)         |
 | 41-50   | to support specific sites or systems which can be inferred from the path                       |                                                |
-| 51-80   | limitted support for specific protocols which requires complex parsing to verify compatability | [apache](apache-browser.lua)                   |
-| 81-90   | parsers that only need to modify the results of full parsers                                   | [home-label](home-label.lua)                   |
-| 91-100  | use for parsers which fully support a non-native protocol with absolutely no overlap           | [ftp](ftp-browser.lua), [m3u](m3u-browser.lua) |
-| 101-109 | replacements for the native file parser or fallbacks for the full parsers                      | [powershell](powershell.lua)                   |
-| 110     | priority of the native file parser - don't use                                                 |                                                |
+| 51-70   |                                                                                                |                                                |
+| 71-80   | limitted support for specific protocols which requires complex parsing to verify compatability | [apache](../addons/apache-browser.lua)         |
+| 81-90   | parsers that only need to modify the results of full parsers                                   | [home-label](../modules/addons/home-label.lua) |
+| 91-100  | use for parsers which fully support a non-native protocol with absolutely no overlap           | [ftp](../addons/ftp-browser.lua)               |
+| 101-109 | replacements for the native file parser or fallbacks for the full parsers                      | [ls](../modules/addons/ls.lua)                 |
+| 110     | priority of the native file parser - don't use                                                 | [file](../modules/addons/file.lua)             |
 | 111+    | fallbacks for native parser - potentially alternatives to the default root                     |                                                |
 
 ## Keybinds
@@ -994,9 +996,14 @@ If the input is not a number return false, if the input is out of bounds move it
 
 ## Examples
 
-For standard addons that add support for non-native filesystems, but otherwise don't do anything fancy, see [ftp-browser](ftp-browser.lua) and [apache-browser](apache-browser.lua).
+The internal [file](../modules/addons/file.lua), [ls](../modules/addons/ls.lua), and [windir](../modules/addons/windir.lua) addons provide
+support for browsing the native filesystem.
 
-For more simple addons that make a few small modifications to how other parsers are displayed, see [home-label](home-label.lua).
+For standard addons that add support for non-native filesystems, but otherwise don't do anything fancy, see [ftp-browser](../addons/ftp-browser.lua) and [apache-browser](../addons/apache-browser.lua).
+
+For more simple addons that make a few small modifications to how other parsers are displayed, see [home-label](../modules/addons/home-label.lua).
 
 For more complex addons that maintain their own virtual directory structure, see
-[favourites](favourites.lua).
+[favourites](../addons/favourites.lua).
+
+

docs/file-browser-keybinds.json

@@ -1,46 +1,10 @@
 [
-    {
-        "key": "KP1",
-        "command": ["print-text", "file: %f"],
-        "multiselect": true
-    },
-    {
-        "key": "KP2",
-        "command": ["print-text", "name: %n"],
-        "multiselect": true
-    },
-    {
-        "key": "KP3",
-        "command": ["print-text", "open directory: %p"]
-    },
-    {
-        "key": "KP4",
-        "command": ["print-text", "directory name: %d"]
-    },
-    {
-        "key": "KP5",
-        "command": ["print-text", "escape the code: %%f"],
-        "multiselect": true
-    },
-    {
-        "key": "KP6",
-        "command": ["print-text", "full filepath via concatenation: %p%n"],
-        "multiselect": true
-    },
-    {
-        "key": "KP7",
-        "command": ["print-text", "quote/escape filepath: %F"],
-        "multiselect": true
-    },
-
-
     {
         "comment": "deletes the currently selected file",
         "key": "Alt+DEL",
-        "command": ["run", "rm", "%F"],
-        "filter": "file",
+        "command": ["script-message", "run-statement", "os.remove(%F) ; fb.rescan()"],
         "multiselect": true,
-        "multi-type": "concat"
+        "multi-type": "repeat"
     },
     {
         "comment": "opens the currently selected items in a new mpv window",
@@ -55,45 +19,22 @@
             ["run", "powershell", "-command", "Set-Clipboard", "%F"],
             ["print-text", "copied filepath to clipboard"]
         ],
+        "condition": "fb.get_platform() == 'windows'",
+        "api_version": "1.9.0",
         "multiselect": true,
         "delay": 0.3
     },
-    {
-        "comment": "Opens the current directory in windows explorer",
-        "key": "Ctrl+o",
-        "command": ["run", "powershell", "-command", "explorer.exe", "(( %P ).TrimEnd('/') -replace '/', '\\' )"],
-        "multiselect": false
-    },
-    {
-        "comment": "Opens the selected directory in windows explorer",
-        "key": "Ctrl+O",
-        "command": ["run", "powershell", "-command", "explorer.exe", "(( %F ).TrimEnd('/') -replace '/', '\\' )"],
-        "filter": "dir",
-        "multiselect": true
-    },
-    {
-        "comment": "Opens the current directory in windows explorer and highlights the currently selected file",
-        "key": "Ctrl+O",
-        "command": ["run", "powershell", "-command", "explorer.exe", "'/select,'", "( %F -replace '/', '\\' )"],
-        "filter": "file",
-        "multiselect": true
-    },
-    {
-        "key": "INS",
-        "command": ["run", "powershell", "-command", "Set-Content", "-LiteralPath", "( %P + '/.ordered-chapters.m3u' )", "-Value", "( %N )"],
-        "multiselect": true,
-        "multi-type": "concat",
-        "concat-string": "+ '\n' +"
-    },
 
 
     {
         "key": "WHEEL_UP",
-        "command": ["script-binding", "file_browser/dynamic/scroll_up"]
+        "command": ["script-binding", "file_browser/dynamic/scroll_up"],
+        "flags": { "repeat": true }
     },
     {
         "key": "WHEEL_DOWN",
-        "command": ["script-binding", "file_browser/dynamic/scroll_down"]
+        "command": ["script-binding", "file_browser/dynamic/scroll_down"],
+        "flags": { "repeat": true }
     },
     {
         "key": "MBTN_LEFT",
@@ -106,13 +47,5 @@
     {
         "key": "MBTN_MID",
         "command": ["script-binding", "file_browser/dynamic/play"]
-    },
-    {
-        "key": "UP",
-        "command": ["osd-auto", "add", "volume", "2"]
-    },
-    {
-        "key": "DOWN",
-        "command": ["osd-auto", "add", "volume", "-2"]
     }
 ]