summaryrefslogtreecommitdiffstats
path: root/DOCS/man/en/lua.rst
diff options
context:
space:
mode:
Diffstat (limited to 'DOCS/man/en/lua.rst')
-rw-r--r--DOCS/man/en/lua.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/DOCS/man/en/lua.rst b/DOCS/man/en/lua.rst
new file mode 100644
index 0000000000..25d456cb46
--- /dev/null
+++ b/DOCS/man/en/lua.rst
@@ -0,0 +1,18 @@
+LUA SCRIPTING
+=============
+
+mpv can load Lua scripts. These scripts can be used to control mpv in a similar
+way to slave mode. mpv provides the builtin module ``mp`` (can be loaded
+with ``require 'mpv'``), which provides functions to send commands to the
+mpv core and to retrieve information about playback state, user settings,
+file information, and so on.
+
+.. admonition:: Warning
+
+ Lua scripting is work in progress, and it's in a very early stage. When
+ writing scripts, rely only on the features and functions documented here.
+ Everything else is subject to change.
+
+.. admonition:: Warning
+
+ Nothing is finished and documented yet.