mirror of
https://github.com/Rockbox/rockbox.git
synced 2025-10-14 02:27:39 -04:00
Add the Lua scripting language plugin to the manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@21168 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
parent
d3d66f172a
commit
9c1283c80d
3 changed files with 32 additions and 0 deletions
|
@ -195,3 +195,7 @@ wheel_acceleration
|
||||||
#if defined(HAVE_TOUCHSCREEN)
|
#if defined(HAVE_TOUCHSCREEN)
|
||||||
touchscreen
|
touchscreen
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
#if (PLUGIN_BUFFER_SIZE >= 0x80000)
|
||||||
|
large_plugin_buffer
|
||||||
|
#endif
|
||||||
|
|
26
manual/plugins/lua.tex
Normal file
26
manual/plugins/lua.tex
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
\subsection{Lua scripting language}
|
||||||
|
|
||||||
|
To quote from the Lua website (\url{http://www.lua.org}), 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{http://www.lua.org/manual/5.1/} and
|
||||||
|
\url{http://www.lua.org/pil/}.
|
||||||
|
|
||||||
|
There are a few exceptions/additions to the Lua support in Rockbox:
|
||||||
|
\begin{description}
|
||||||
|
\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{http://luaforge.net/projects/bitlib} and
|
||||||
|
\url{http://lua-users.org/wiki/BitwiseOperators}.
|
||||||
|
\end{description}
|
||||||
|
|
||||||
|
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.}
|
|
@ -127,6 +127,8 @@ the associated file. Viewers are stored in the
|
||||||
|
|
||||||
\opt{lcd_bitmap}{\input{plugins/jpegviewer.tex}}
|
\opt{lcd_bitmap}{\input{plugins/jpegviewer.tex}}
|
||||||
|
|
||||||
|
\opt{large_plugin_buffer}{\input{plugins/lua.tex}}
|
||||||
|
|
||||||
\opt{swcodec}{\input{plugins/midiplay.tex}}
|
\opt{swcodec}{\input{plugins/midiplay.tex}}
|
||||||
|
|
||||||
\opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}}
|
\opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}}
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue