DogLua - Lua Scripting

for Project Dogwaffle & PD Pro!

Lua Scripting for Project Dogwaffle - Marco Pontello's project

Overview - Downloads - Reference Guide - Lua Browser - Sample Scripts

see also: GUI Server - Developer's SDK - Other Lua Sightings

DogLua - Overview:
Please note: this is a work in progress - here are just a few notes and pointers to get you started as it evolves... read Marco's pages for details! Available in English, ed'anche disponibile in italiano!

DogLua is a scriptable interface for Project Dogwaffle. It provides an environment for experimenting with image processing algorithms, using Lua as the scripting language. DogLua is being developed by Marco Pontello.

DogLua it's largely inspired by gluas, by OEyvind Kolaas, and tries to be as compatible as possible with it, providing a similar syntax for the basics pixel manipulation functions. Additional functionality for user interface interaction is provided through the GUI server. Some scripts mentioned here make use of the GUI server and will probably only run within Dogwaffle (although this might change over time since the GUI server should be of interest to other applications).

Lua was developed at PUC Rio Brasil
Lua.org is the home of Lua. Lua is free.
gluas reference material at codecave
here are some of its many uses - if you are a game developer you should read this!
DogLua is by Marco Pontello of Italy. Doglua is freeware. Grazie mille!
gluas at the GIMP, the core functions of which are used for DogLua.
Marco's plugin is being developed with PowerBasic. Sample source code for accessing Dogwaffle via PowerBasic can be found in our SDK pages, in case you're interested in programming a similar project.
You may want to also get the DogLua Browser if your version of Dogwaffle didn't come with it.
If you plan on running scripts which have user interface options based on the GUI server, then you should also get the free GUI server if it wasn't included with your latest version of Dogwaffle

To Probe Further:

The Lua Wiki: http://lua-users.org/wiki/LuaLinks
an Introduction to Lua (by Ash Matheson, at Gamedev.net, not only on gluas)
Lua scripting forum at Facepunch

New filters combined with existing
filters... great new possibilities

sample filter: randomize the red channel

- top -

Other Lua sightings?

Where else have we seen Lua or gluas-based scripting capabilities?

Imaging & Painting Programs:

Project Dogwaffle Professional, PDPro 3 and 4 support Doglua, a Lua scripting plugin by Marco Pontelli

Pixarra's Twistedbrush Pro Studio now also supports Lua filters: see TB's Lua scripts here

Artweaver - another very cool & free paint and imaging program, with great plugin connections to Project Dogwaffle(!). Supports the Lua GuiServer too! more details at Artweaver.de

the GIMP - Graphics Image Manipulation Program) is another cool (open source and very free) imaging program, and where the g(lua)s revolution started with the original gluas plugin!

Adobe is known to have sponsored Lua, which has been used in Lightroom and Photoshop. Not necessarily to make filters according to gluas, but rather for other parts of the program. See below for more ways to use Lua.

Animation, GameDev & other tools:

World of Warcraft supports Lua. See examples at http://wowprogramming.com/ and many others.

Anime Studio Pro supports LUA scripting

http://www.rtsoft.com/novashell/

Awakening, by Awing Software - support scripting with Lua (going beyond gluas for image filters)

Fragmosoft.com - creator of Fragmotion

Digital Fusion - by Eyeon Software

Strata 3D 5 has Lua scripting!

many more on Wikipedia

Do you know of others? Please tell us.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

- top -

DogLua - Downloading & Installing

There are two items to download and install: the core DogLua components from Marco Pontello and the DogLua Addons, a collection of tools for use with DogLua, such as the Lua browser and the GUI server.

1. DogLua: the core components
Downloading the latest version:

visit Marco Pontello's DogLua page and scroll down to the Downloads area. It's a ZIP file.
check Marco's site for latest version updates and news!

2. DogLua Addons: GUI Server, LUA Browser, sample scripts...

We now offer a single download of additional content and plugins in support of DogLua:

download: DogLua_addons.zip - 129 KB (133,068 bytes)

Notes: When extracting (unzipping) the files, they will be found in a sub-folder named 'DogLua_addons'. This is not their final destination. Be sure to move or copy the files into the folder where your Project Dogwaffle is installed. Copy the *.lua files found in the 'DogLuaScripts' subfolder over to the 'DogLuaScripts' subfolder which you should already have in your Dogwaffle installation folder if you installed DogLua.

The following files should be found in the above zip archive:

- top -

Lua Browser for Dogwaffle

This is a free plugin by Dan Ritchie. It lets you quickly access the lua scripts found in the main Lua scripts folder. You can simply double-click the desired script to run it. You can also optionally apply the filter script across the entire animation, i.e. repeat it for all frames of an animation.

From the browser you can also jump directly to the editor, which is the original DogLua plugin by Marco.

Some new features:

context menu to rename, delete, update list, pattern match, explore
Help button to go to developers web page.
Set the frame range to apply scripts to animation.

Downloading the Lua Browser:

The DogLua Browser plugin is now included as part of the DogLua Pack addons download

right-click on a script file entry to see
the context menu:

the Special execution dialog for
running scripts across a range of
frames from an animation:

- top -

Sample Scripts...

The Sample Scripts have moved here: samples.html

- top -

Reference Guide for DogLua

The basic reference guide lives of course on Marco Pontello's site, who created the DogLua module.

shortcuts:

DogLua Reference
http://www.mark0.net/plugins-doglua-ref2.html

GUI Server API
http://www.mark0.net/plugins-doglua-ref3.html

- top -