diff options
author | Kevin Mitchell <kevmitch@gmail.com> | 2014-04-29 05:11:39 -0700 |
---|---|---|
committer | Kevin Mitchell <kevmitch@gmail.com> | 2014-04-29 08:31:44 -0700 |
commit | 8e8758dbe15ed7611c65856d62c3f44b5be73d7e (patch) | |
tree | ccbf2fbfec3ed404c61605587d050e9082126456 /TOOLS/lua/README.md | |
parent | 4b0a760d86381587eff3552c440fbe1bfbac03e5 (diff) | |
download | mpv-8e8758dbe15ed7611c65856d62c3f44b5be73d7e.tar.bz2 mpv-8e8758dbe15ed7611c65856d62c3f44b5be73d7e.tar.xz |
TOOLS: better documentation of lua scripts
Diffstat (limited to 'TOOLS/lua/README.md')
-rw-r--r-- | TOOLS/lua/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/TOOLS/lua/README.md b/TOOLS/lua/README.md new file mode 100644 index 0000000000..fbe4bad267 --- /dev/null +++ b/TOOLS/lua/README.md @@ -0,0 +1,19 @@ +mpv lua scripts +=============== + +The lua scripts in this folder can be loaded on a one-time basis by +adding the option + + --lua=/path/to/script.lua + +to mpv's command line. + +Unless otherwise specified, they are also suitable for inclusion in +the `~/.mpv/lua` directory where they will be loaded every time mpv +starts, obviating the need to load them with the above `--lua=...` +argument. This is acceptable as they do only basic argument parsing +and key-binding registration, until those bound keys are actually +pressed. They should therefore not interfere with normal playback +(unless you have a conflicting user-defined key-binding, in which +case, you may want to modify either the `mp.add_key_binding()` calls +in the scripts, or your keybinding). |