Skip to content

Commit bd2bc36

Browse files
authored
Merge pull request darktable-org#284 from wpferguson/update_install_instructions
Update README.md
2 parents 45d62f4 + f76fa01 commit bd2bc36

File tree

1 file changed

+35
-9
lines changed

1 file changed

+35
-9
lines changed

README.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,17 @@ Ensure git is installed on your system. If it isn't, use the package manager to
126126
cd ~/snap/darktable/current
127127
git clone https://github.com/darktable-org/lua-scripts.git lua
128128

129-
### flatpak and appimage packages
129+
### flatpak packages
130+
131+
Flatpak packages now use the internal lua interpreter.
132+
133+
134+
Ensure git is installed on your system. If it isn't, use the package manager to install it. Then open a terminal and:
135+
136+
cd ~/.var/app/org.darktable.Darktable/config/darktable
137+
git clone https://github.com/darktable-org/lua-scripts.git lua
138+
139+
### appimage packages
130140

131141
These packages run in their own environment and don't have access to a lua interpreter, therefore the scripts can't run. The packagers could enable the internal interpreter, or allow the package to link the interpreter from the operating system, or bundle a copy of lua with the package. If you use one of these packages and wish to use the lua scripts, please contact the package maintainer and suggest the above fixes.
132142

@@ -150,24 +160,34 @@ If you don't have %LOCALAPPDATA%\darktable you have to start dartable at least o
150160

151161
When darktable starts it looks for a file name `~/.config/darktable/luarc` (`%LOCALAPPDATA%\darktable\luarc` for windows) and reads it to see which scripts to include. The file is a plain text file with entries of the form `require "<directory>/<name>"` where directory is the directory containing the scripts, from the above list, and name is the name from the above list. To include GIMP the line would be `require "contrib/gimp"`.
152162

163+
The recommended way to enable and disable specific scripts is using the script manager module. To use script manager do the following:
164+
165+
### Linux or MacOS
166+
167+
echo 'require "tools/script_manager"' > ~/.config/darktable/luarc
168+
169+
### Windows
170+
171+
echo "require 'tools/script_manager'" > %LOCALAPPDATA%\darktable\luarc
172+
173+
### Snap
174+
175+
echo 'require "tools/script_manager"' > ~/snap/darktable/current/luarc
176+
177+
### Flatpak
178+
179+
echo require "tools/script_manager"' > ~/.var/app/org.darktable.Darktable/config/darktable/luarc
180+
153181
You can also create or add lines to the luarc file from the command line:
154182

155183
`echo 'require "contrib/gimp"' > ~/.config/darktable/luarc` to create the file with a gimp entry\
156184
or `echo 'require "contrib/hugin"' >> ~/.config/darktable/luarc` to add an entry for hugin.
157185

158-
Alteratively you can use script_manager.lua as your luarc file. script_manager.lua provides a point and click interface for managing the lua scripts. To use it:
159-
160-
ln -s $HOME/.config/darktable/lua/tools/script_manager.lua $HOME/.config/darktable/luarc
161-
162186
On windows from a command prompt:
163187

164188
`echo require "contrib/gimp" > %LOCALAPPDATA%\darktable\luarc` to create the file with a gimp entry\
165189
or `echo require "contrib/hugin" >> %LOCALAPPDATA%\darktable\luarc` to add an entry for hugin.
166190

167-
Alteratively you can use script_manager.lua as your luarc file. script_manager.lua provides a point and click interface for managing the lua scripts. To use it:
168-
169-
copy %LOCALAPPDATA%\darktable\lua\tools\script_manager.lua %LOCALAPPDATA%\darktable\luarc
170-
171191
## Disabling
172192

173193
To disable a script open the luarc file in your text editor and insert `--` at the start of the line containing the script you wish to disable, then save the file.
@@ -181,6 +201,12 @@ To update the script repository, open a terminal or command prompt and do the fo
181201
cd ~/snap/darktable/current/lua
182202
git pull
183203

204+
205+
### Flatpak
206+
207+
cd ~/.var/app/org.darktable.Darktable/config/darktable/lua
208+
git pull
209+
184210
### Linux and MacOS
185211

186212
cd ~/.config/darktable/lua/

0 commit comments

Comments
 (0)