first commit

mpv/scripts/file-browser/docs/file_browser.conf

@@ -0,0 +1,175 @@
+#######################################################
+# This is the default config file for mpv-file-browser
+# https://github.com/CogentRedTester/mpv-file-browser
+#######################################################
+
+# root directories, separated by commas
+# on linux you will probably want to add `/`,
+# on windows this should be used to add different drive letters
+# Examples:
+# linux:     root=~/,/
+# windows:   root=~/,C:/
+root=~/
+
+# characters to separate root directories, each character works individually
+# this is in case one is using directories with strange names
+root_separators=,;
+
+# number of entries to show on the screen at once
+num_entries=20
+
+# wrap the cursor around the top and bottom of the list
+wrap=no
+
+# only show files compatible with mpv in the browser
+filter_files=yes
+
+# experimental feature that recurses directories concurrently when appending items to the playlist
+# this feature has the potential for massive performance improvements when using addons with asynchronous IO
+concurrent_recursion=no
+
+# maximum number of recursions that can run concurrently
+# if this number is too high it risks overflowing the mpv event queue, which will cause some directories to be dropped entirely
+max_concurrency=16
+
+# enable custom keybinds
+# the keybind json file must go in ~~/script-opts
+custom_keybinds=no
+
+# file-browser only shows files that are compatible with mpv by default
+# adding a file extension to this list will add it to the extension whitelist
+# extensions are separated with the root separators, do not use any spaces
+extension_whitelist=
+
+# add file extensions to this list to disable default filetypes
+# note that this will also override audio/subtitle_extension options below
+extension_blacklist=
+
+# files with these extensions will be added as additional audio tracks for the current file instead of appended to the playlist
+# items on this list are automatically added to the extension whitelist
+audio_extensions=mka,dts,dtshd,dts-hd,truehd,true-hd
+
+# files with these extensions will be added as additional subtitle tracks for the current file instead of appended to the playlist
+# items on this list are automatically added to the extension whitelist
+subtitle_extensions=etf,etf8,utf-8,idx,sub,srt,rt,ssa,ass,mks,vtt,sup,scc,smi,lrc,pgs
+
+# filter directories or files starting with a period like .config
+# for linux systems
+filter_dot_dirs=no
+filter_dot_files=no
+
+# substitude forward slashes for backslashes when appending a local file to the playlist
+# may be useful on windows systems
+substitute_backslash=no
+
+# interpret backslashes `\` in paths as forward slashes `/`
+# this is useful on Windows, which natively uses backslashes.
+# As backslashes are valid filename characters in Unix systems this could
+# cause mangled paths, though such filenames are rare.
+# Use `yes` and `no` to enable/disable. `auto` tries to use the mpv `platform`
+# property (mpv v0.36+) to decide. If the property is unavailable it defaults to `yes`.
+normalise_backslash=auto
+
+# this option reverses the behaviour of the alt+ENTER keybind
+# when disabled the keybind is required to enable autoload for the file
+# when enabled the keybind disables autoload for the file
+autoload=no
+
+# if autoload is triggered by selecting the currently playing file, then
+# the current file will have it's watch-later config saved before being closed and re-opened
+# essentially the current file will not be restarted
+autoload_save_current=yes
+
+# when opening the browser in idle mode prefer the current working directory over the root
+# note that the working directory is set as the 'current' directory regardless, so `home` will
+# move the browser there even if this option is set to false
+default_to_working_directory=no
+
+# when moving up a directory do not stop on empty protocol schemes like `ftp://`
+# e.g. moving up from `ftp://localhost/` will move straight to the root instead of `ftp://`
+skip_protocol_schemes=yes
+
+# map optical device paths to their respective file paths,
+# e.g. mapping bd:// to the value of the bluray-device property
+map_bd_device=yes
+map_dvd_device=yes
+map_cdda_device=yes
+
+# enables addons
+addons=no
+addon_directory=~~/script-modules/file-browser-addons
+
+# directory to load external modules - currently just user-input-module
+module_directory=~~/script-modules
+
+# turn the OSC idle screen off and on when opening and closing the browser
+# this should only be enabled if file-browser is the only thing controlling the idle-screen,
+# if multiple sources attempt to control the idle-screen at the same time it can cause unexpected behaviour.
+toggle_idlescreen=no
+
+# Set the current open status of the browser in the `file_browser/open` field of the `user-data` property.
+# This property is only available in mpv v0.36+.
+set_user_data=yes
+
+# Set the current open status of the browser in the `file_browser-open` field of the `shared-script-properties` property.
+# This property is deprecated. When it is removed in mpv v0.37 file-browser will automatically disable this option.
+set_shared_script_properties=no
+
+####################################
+######### style settings ###########
+####################################
+
+# force file-browser to use a specific text alignment (default: top-left)
+# uses ass tag alignment numbers: https://aegi.vmoe.info/docs/3.0/ASS_Tags/#index23h3
+# set to 0 to use the default mpv osd-align options
+alignment=7
+
+# The format string used for the header. Uses custom-keybind substitution codes to
+# dynamically change the contents of the header. See: docs/custom-keybinds.md#codes
+# e.g. to add file numbers, set this to: {\fnMonospace}[%i/%x]{\fn<font_name_header or blank>} %q\N----------------------------------------------------
+format_string_header=%q\N----------------------------------------------------
+
+# The format strings used for the wrappers. Supports custom-keybind substitution codes, and
+# supports two additional codes: `%<` and `%>` to show the number of items before and after the visible list, respectively.
+# Setting these options to empty strings will disable the wrappers.
+format_string_topwrapper=%< item(s) above\N
+format_string_bottomwrapper=\N%> item(s) remaining
+
+# allows custom icons be set for the folder and cursor
+# the `\h` character is a hard space to add padding
+folder_icon={\p1}m 6.52 0 l 1.63 0 b 0.73 0 0.01 0.73 0.01 1.63 l 0 11.41 b 0 12.32 0.73 13.05 1.63 13.05 l 14.68 13.05 b 15.58 13.05 16.31 12.32 16.31 11.41 l 16.31 3.26 b 16.31 2.36 15.58 1.63 14.68 1.63 l 8.15 1.63{\p0}\h
+cursor_icon={\p1}m 14.11 6.86 l 0.34 0.02 b 0.25 -0.02 0.13 -0 0.06 0.08 b -0.01 0.16 -0.02 0.28 0.04 0.36 l 3.38 5.55 l 3.38 5.55 3.67 6.15 3.81 6.79 3.79 7.45 3.61 8.08 3.39 8.5l 0.04 13.77 b -0.02 13.86 -0.01 13.98 0.06 14.06 b 0.11 14.11 0.17 14.13 0.24 14.13 b 0.27 14.13 0.31 14.13 0.34 14.11 l 14.11 7.28 b 14.2 7.24 14.25 7.16 14.25 7.07 b 14.25 6.98 14.2 6.9 14.11 6.86{\p0}\h
+
+# set the opacity of fonts in hexadecimal from 00 (opaque) to FF (transparent)
+font_opacity_selection_marker=99
+
+# print the header in bold font
+font_bold_header=yes
+
+# scale the size of the browser; 2 would double the size, 0.5 would halve it, etc.
+# the header and wrapper scaling is relative to the base scaling
+scaling_factor_base=1
+scaling_factor_header=1.4
+scaling_factor_wrappers=0.64
+
+# set custom font names, blank is the default
+# setting custom fonts for the folder/cursor can fix broken or missing icons
+font_name_header=
+font_name_body=
+font_name_wrappers=
+font_name_folder=
+font_name_cursor=
+
+# set custom font colours
+# colours are in hexadecimal format in Blue Green Red order
+# note that this is the opposite order to most RGB colour codes
+font_colour_header=00ccff
+font_colour_body=ffffff
+font_colour_wrappers=00ccff
+font_colour_cursor=00ccff
+
+# these are colours applied to list items in different states
+font_colour_selected=fce788
+font_colour_multiselect=fcad88
+font_colour_playing=33ff66
+font_colour_playing_multiselected=22b547