Skip to content

Commit

Permalink
update to pdlua 0.12.17
Browse files Browse the repository at this point in the history
docs and more
  • Loading branch information
porres committed Sep 21, 2024
1 parent 041b504 commit 5e2d266
Show file tree
Hide file tree
Showing 39 changed files with 2,282 additions and 749 deletions.
62 changes: 42 additions & 20 deletions Source/Control/lua/README
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ corresponding subdirectories). Originally written by Claude Heiland-Allen,
pdlua has gone through the hands of a few people over the years, including
mrpeach (maintainer since 2011), zmoelnig a.k.a. umlaeute (loader update,
Debian package), and myself (Arch package, Lua 5.3+ support, Purr Data and
plugdata support, tutorial). Please also check my brief account on the history
of pd-lua below.
plugdata support, pdx.lua live-coding extension, tutorial). Please also check
my brief account on the history of pd-lua below.

Lua 5.4 is highly recommended with the latest version, Lua 5.3 works as
well. Reportedly, Lua 5.2 and even 5.1 still work (at least to some extent),
Expand All @@ -42,9 +42,10 @@ https://agraef.github.io/pd-lua/tutorial/pd-lua-intro.html

This contains a fairly gentle introduction to pdlua, walks you through the
creation of a basic example, and then goes on to cover most major features of
pdlua, including the special facilities for tables, clocks, receivers, and
live-coding, in quite some detail. This will be helpful when embarking on your
own projects, or trying to make sense of the included examples.
pdlua, including the special facilities for tables, clocks, receivers, signal
processing, graphics, and live-coding, in quite some detail. This will be
helpful when embarking on your own projects, or trying to make sense of the
included examples.


History and Credits:
Expand All @@ -66,11 +67,11 @@ in turn was based on the 0.7.3 version of pdlua in Pd's svn repository.

The current version (0.8 and later) is actively maintained by Albert Gräf,
with contributions by Claude Heiland-Allen (Lua 5.4 update, bugfixes),
Alexandre Porres (documentation updates, Deken package), sebshader (relative
path loading), and Timothy Schoen (plugdata compatibility, signal and graphics
support). This is also the version included in Purr Data
(https://github.com/agraef/purr-data) and Timothy Schoen's plugdata
(https://github.com/plugdata-team/plugdata).
Alexandre Porres (documentation updates), sebshader (relative path loading),
Timothy Schoen (plugdata compatibility, signal and graphics support), and Ben
Wesch (Deken tests and uploads on GitHub). This is also the version included
in Purr Data (https://github.com/agraef/purr-data) and Timothy Schoen's
plugdata (https://github.com/plugdata-team/plugdata).

Please file bugs and requests at https://github.com/agraef/pd-lua. I maintain
a lot of packages and thus it may take a while at times, but I look at all the
Expand All @@ -79,17 +80,21 @@ bug reports and pull requests, and try to respond to them eventually. :)

Ready-Made Packages:

The latest vanilla binaries for Ubuntu, Mac and Windows can always be found on
https://github.com/agraef/pd-lua. The same version is also in the Arch
community repository (maintained by dvzrv, thanks David!). Other packages are
available in Debian (maintained by IOhannes Zmölnig) and Deken (maintained by
Alexandre Porres). You can also compile pdlua yourself from source, which
isn't hard to do (see below). Also, both Purr Data and plugdata ship with
pdlua, so no 3rd party package is needed in those environments.
The latest vanilla binaries for Ubuntu, Mac, and Windows can always be found
on https://github.com/agraef/pd-lua (but see below for the Deken package).
Also, both Purr Data and plugdata ship with pdlua, and have it enabled by
default, so no 3rd party package is needed in those environments.

To enable the pdlua loader in Pd after installation, just add `pdlua` to your
startup libraries (after adding its parent directory to Pd's search path if
necessary) and you should be set.
For vanilla Pd, we recommend installing the Deken package (named `pdlua`),
readily available using Pd's `Find externals` menu option. This package was
originally uploaded by Alexandre Porres, but Ben Wesch recently added Deken
tests and uploads to our GitHub workflow, so that the Deken releases are now
automatized and always in sync with the GitHub releases. Thanks, Ben!

pd-lua is also in the Arch repositories (maintained by dvzrv, thanks David!),
and in the Debian repositories (maintained by IOhannes Zmölnig, thanks
umlaeute!). (During busy times, these may trail our releases for a little bit,
but most of the time they will the latest version.)

Mac users please note that the packages I distribute aren't notarized, so on
recent macOS versions you'll have to jump through the usual hoops to make them
Expand All @@ -98,8 +103,25 @@ usually do the trick, but check the internet for up-to-date information on
Gatekeeper for details.


Enabling pdlua:

Again, this step is only necessary with vanilla Pd; both Purr Data and
plugdata have the pdlua loader enabled by default, so it should be ready to go
immediately.

With vanilla Pd, after installing pdlua, the pdlua loader also needs to be
added to your startup libraries, before Pd will recognize any Lua object in
your patches. This only needs to be done once. (Alternatively, you can also
use the `-lib pdlua` option on the Pd command line, or a `declare -lib pdlua`
object in a patch with Lua objects.) To make any of this work, you may also
have to add the parent directory of the `pdlua` folder to Pd's search path if
pdlua was installed in an unusual location.


Compilation Instructions:

You can also compile pdlua yourself from source, which isn't hard to do.

The source should compile out of the box on (at least) Linux, macOS and
Windows, just make sure that you have Lua and Pd installed and run
`make`. pdlua uses pd-lib-builder by Katja Vetter as its build system, please
Expand Down
Loading

0 comments on commit 5e2d266

Please sign in to comment.