From 3c037ef52a4c3b0d761fec38f1a7b7b55aee8e30 Mon Sep 17 00:00:00 2001 From: lethosor Date: Thu, 24 Sep 2020 00:16:32 -0400 Subject: [PATCH] Clean up plugin mkmodule/require explanation --- docs/Lua API.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/Lua API.rst b/docs/Lua API.rst index 1aaf73eda..8707a0d99 100644 --- a/docs/Lua API.rst +++ b/docs/Lua API.rst @@ -3656,19 +3656,22 @@ Plugins .. contents:: :local: -DFHack plugins may export native functions and events -to lua contexts. They are automatically imported by -``mkmodule('plugins.')``; this means that a lua -module file is still necessary for ``require`` to read. +DFHack plugins may export native functions and events to Lua contexts. These are +exposed as ``plugins.`` modules, which can be imported with +``require('plugins.')``. The plugins listed in this section expose +functions and/or data to Lua in this way. In addition to any native functions documented here, plugins that can be -disabled (that is, plugins that support the enable/disable API) will have the -following functions defined: +enabled (that is, plugins that support the `enable/disable API `) will +have the following functions defined: * ``isEnabled()`` returns whether the plugin is enabled. * ``setEnabled(boolean)`` sets whether the plugin is enabled. -The following plugins have lua support. +For plugin developers, note that a Lua file in ``plugins/lua`` is required for +``require()`` to work, even if it contains no pure-Lua functions. This file must +contain ``mkmodule('plugins.')`` to import any native functions defined in +the plugin. See existing files in ``plugins/lua`` for examples. blueprint =========