path: root/manual/plugins/lua.tex
diff options
Diffstat (limited to 'manual/plugins/lua.tex')
1 files changed, 26 insertions, 0 deletions
diff --git a/manual/plugins/lua.tex b/manual/plugins/lua.tex
new file mode 100644
index 0000000000..ac7ff22a85
--- /dev/null
+++ b/manual/plugins/lua.tex
@@ -0,0 +1,26 @@
+\subsection{Lua scripting language}
+To quote from the Lua website (\url{}), Lua is a ``powerful,
+fast, lightweight, embeddable scripting language''. Select a \fname{.lua} file
+in the \setting{File Browser} to run it. For more information on programming
+in Lua, please see \url{} and
+There are a few exceptions/additions to the Lua support in Rockbox:
+ \item[No floating point support.] The number type in Lua is usually float,
+ however in the Rockbox implementation it is integer.
+ \item[Non-supported libraries.] The coroutine, debug, file, io, math
+ and package libraries are not supported.
+ \item[Partially-supported libraries.] The os library is only partially
+ supported.
+ \item[Additional libraries.] The bitlib library is integrated to support
+ bitwise operators. See \url{} and
+ \url{}.
+Documentation of the API is still a work in progress, and the API itself is
+not finalised. For the latest information, see \wikilink{PluginLua}.\\
+\note{Please note that if a script does not provide a way to exit, then
+the only way to exit will be to reset the \dap.} \ No newline at end of file