enabling a Lua script
Table of Contents
Enabling a Lua script for use is a two-step process:
- finding it, as described below, and then
- starting it.
#finding a script
To find the folder containing a script, such as “rename-images”, use the following steps.
- Open the lighttable view.
- In the lower part of the leftmost pane in the lighttable view you should see the scripts module. Click (once) on the right-facing arrowhead, to open the module. (If the scripts module does not appear, make sure that in the darktable preferences under “Lua options” that the checkbox for “disable Lua scripts” is not checked (that is uncheck it), see preferences > lua options, and then start darktable again.)
- You should then see an initial view of the scripts module.
- Check that the scripts module has the “start/stop scripts” action selected, which should appear to the right of the word “action” in the second row from the top as shown above. (If that action is not selected, click on the word “action” and then select “start/stop scripts” from the menu that appears.)
- Find out what folder contains the script you want to enable. To do that look at the darktable scripts page and the lists under each folder.
In our example “rename-images” is a contributed script and the “contributed” folder is already selected. (If you want to enable a script in the “official” folder, then you will need to select that folder, “official”, from the menu that appears when you click on “folder”.)
Once the correct folder is selected, such as “contributed”, use the
left and
right arrows to navigate through that folder to find the desired script’s name. In our example, “rename-images” is (as of this writing) on the last page, so you should click the
right folder selection arrow several times to get to the page containing that script’s name.
Now start that script as described below
#starting a script
Once you have found the folder containing a script, such as “rename-images”, use the following steps to start it
- Click (once) on the grayed-out start/stop icon to the left of the script’s name to start it.
- The icon should turn bold (whiter) to indicate that the script is on and the script’s user interface (if it has one) will appear in a panel in the appropriate view.
- In this example, the user interface for the script appears in the right panel of the lighttable view.
- To open that user interface, click (once) on the right-facing arrowhead at the left side of the user interface to expand it. Then interact with the script as described in its documentation.
These actions need to be repeated for each script you wish to use.