summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/plugins/console.rst
diff options
context:
space:
mode:
author Vas Crabb <vas@vastheman.com>2021-10-24 05:48:05 +1100
committer Vas Crabb <vas@vastheman.com>2021-10-24 05:48:05 +1100
commit669b1f6adecfd940d5ae8b97150dc73db04894c5 (patch)
tree3b32a4f2d55f558be04294ebe818c8f35135ef8b /docs/source/plugins/console.rst
parent3a11f9168703f33f2f066c3e9d0f6905f2c95453 (diff)
-docs: Started documenting plugins.
* Also added a couple of missing command-line options, and added a local table of contents to the (rather long) command line options page. -Added a separate CI target for localisation updates that produces an artefact, and removed the message catalogs from the trigger paths for the Linux CI build.
Diffstat (limited to 'docs/source/plugins/console.rst')
-rw-r--r--docs/source/plugins/console.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/source/plugins/console.rst b/docs/source/plugins/console.rst
new file mode 100644
index 00000000000..0afdb1f796c
--- /dev/null
+++ b/docs/source/plugins/console.rst
@@ -0,0 +1,9 @@
+.. _plugins-console:
+
+Console Plugin
+==============
+
+The console plugin provides functionality for MAME’s interactive Lua console.
+It is not used directly. Use the
+:ref:`console option <mame-commandline-console>` to activate the interactive Lua
+console. See :ref:`luaengine` for more information about MAME’s Lua API.