Paddy_user_guide

• PDF Version
• Version remarks
• Registering Paddy
  • Summary of the policy
  • Philosophy
  • 50 days to play
  • How it Works
  • Important Details
• Key Aspects of working with Paddy
• Where to get help
• Installing Paddy and getting started
  • GUI section
    • Hotkey section
  • Legal Remarks

PDF Version

A PDF version of this guide can be found here: https://sourceforge.net/projects/paddy/files/98%20Documentation/

The PDF is often a few edits behind the online version.

Version remarks

This version of the user guide reflects Paddy 4.2 as of November 20, 2012.

Registering Paddy

Summary of the policy

• You will need to register Paddy after 50 days by donating through a PayPal account or a credit card via PayPal. Use this link to donate: Donate and register
• The minimum donation is 1 cent (though I would like you to consider something appropriate)
• You will get an email with the registration code. If did not get that email after 2 hours, let me know.
• You can register 2 PCs max per PayPal transaction code(you need to be online for the process but not afterwards)
• If you do not have a PayPal or credit card account, or you administer many computers (e.g., in a school or a large business), contact me and I will take care of you so you don't have a big hassle.

Philosophy

Paddy is open source. Anybody can get the source code and try to run Paddy from it. It is not easy, but it is doable. Paddy had been free for several years. However, Paddy takes a lot of time to work on. I have traced bugs for hours, and every Lightroom change requires several days of investment to make Paddy work again. Moreover, I invested in hardware and software I would otherwise not have bought. On the other hand, Paddy can save Photographers hundreds of hours of work, depending on workflow and number of pictures per week. Alternatives to Paddy costs hundreds of Dollars. The cost/benefit balance didn't seem right any more, as I have most of the cost in time and real dollars.

So Paddy is now mandatory registration with a 1 cent donation minimum. Essentially, I would like to encourage reasonable donations. As a guideline, I would like you to consider that some wedding photographers have donated sums that are equivalent to a reasonably important packaged software. Think about how much time Paddy saves you. If none, stick with the one cent (whic goes completely to Paypal). If significant, donate appropriately.

50 days to play

Paddy will work for 50 days without any registration. You will get a pop-up reminder at each start of Paddy, though. After 50 days, you will have to register for Paddy to work. You can do it for 1 cent via PayPal (not that I will see that - anything up to about $1 goes to Paypal), but it would be nice if at that point, you asked yourself how much you would pay for a software with this functionality if it was a commercial solution.

How it Works

You can register Paddy by making a payment of at least $0.01 (or your local minimum) using PayPal. You will get two emails: one from PayPal, and one from me with your registration code to enter into Paddy. So keep that ID.

You do not need a PayPal account: if you don't have one, you can pay through PayPal using a credit card.

If you choose to make a payment of $0.01 (or whatever minimum PayPal allows for your currency), PayPal takes that as a fee and I receive nothing, and that's perfectly acceptable. If you choose to make a larger payment, PayPal takes its fees off the top – at least the first fifty cents or so – and what remains goes to me.

If you don't have a PayPal account and don't have a credit card, you won't be able to register Paddy in this way. Send me a note and I'll take care of you. Not a problem, please reach out

Important Details

You can at the moment register two computers with each PayPal ID. When you upgrade computers, you will need to donate another cent to get a new ID. Given that you just bought a new computer, I hope that's acceptable. If you administer Lightroom on a bunch of computers (e.g. at a school or large business), send me a note (dorfl68 [at] gmail.com) and I will get you a series of registration codes. If you are indeed a large business, a large donation would be nice, though (one can dream, right?).

The only information stored online is the registration ID key and a random string that is associated with your computer. It is impossible for me or anybody to identify anything about you or your computer from this information. Your email address is not stored. Your Lightroom serial number is not stored. The upside is, no privacy issues. The downside is, should you lose the registration ID, you have to register again.

Lastly, you are not purchasing anything or any rights when you register the plugin. I give no guarantees other than the registration code will work to remove the limitations of the copy you have, for the version of Lightroom you have. I reserve the right to stop Paddy development, and bugs might not be resolved the minute I receive the report (although I think I have a record of trying hard and being fast)

Key Aspects of working with Paddy

Paddy intercepts keystrokes from internal and external keyboards as well as Midi input and assigns tasks in Lightroom to them. As such, it tries to work in the background all you should see normally is a little logo in the windows tray. Some functions tell you what's happening (e.g., when running a script) but it's easy to forget that there is a plugin running all the time. It is therefore important to realize a few things before you start

1. You will have to configure Paddy to your liking. This includes deciding what keys to map (or not), and whether to use an external keyboard (or not). Paddy supports several key maps that you can freely switch over, so you can always experiment
2. All you see of Paddy after the start (if all goes well) is a little logo in the windows tray. In order to customize the functions, edit, run, or record a script, setup hardware etc, right-click that logo and a menu pops up. Alternatively, you can use a Menu in LR under File->Plugin Extras.
3. If you use an external keyboard, you will have to assign a keyboard layout to those. For the four keyboards that Paddy supports directly at the moment(Genovation682, Genovation683, XKeys Professional Keypad, Logitech G13), these files are provided in the Paddy download but they are not automatically installed. You will have to do that (see Setting Up External Keypads below)
4. If you use an unsupported external keyboard, Paddy helps you through defining the keyboard layout. See under User defined external keyboards in this guide
5. If you use MIDI, in theory, any controller will work. In practice, the Behringer BCF2000 controller and Behringer BCR2000 controller are natively supported by Paddy with a user interface and thus preferred by most users
6. If you use a MIDI keyboard, such as the Axiom 25, You probably need to understand how to tell the keyboard what MIDI channel to use, but not much more.
7. Paddy is donationware and a fun project for me. I am not a corporation or sponsored by one. The good thing is, that makes Paddy free (other than a minimum 1 cent for registration and any hardware you might want or indeed, a higher donations). On the other hand, neither the quality control nor the support is on a level that you would expect from a company (not that I am impressed with the quality of some professional software support). I will do all I can and we have a good user community to improve the product, and I have several years of good track record now. But in general, no guarantee for anything
8. I do appreciate donations, which you can send my way via a menu entry in Paddy. I continue to invest in hardware and software for this.

Where to get help

If this user guide feels incomplete, incomprehensible, or both, please go to to help forum here: https://sourceforge.net/apps/phpbb/paddy/

Video tutorials are on the YouTube Channel: http://www.youtube.com/user/PaddyforLightroom

Installing Paddy and getting started

Download Paddy here:https://sourceforge.net/downloads/paddy/

The code you want is in "latest version". This will download a .zip file that you have to install in the Lightroom Module directory

1. Download the file and remember where you put it
2. Open this location, right click the file and select "extract here". This will create a directory called Paddy.lrdevplugin in this location
3. In Lightroom, go to >File >Plug-In Manager. In the Plug-In Manager, on the left side click on <Add>. Navigate to the download location and select the Paddy folder. Hit OK
4. Close and restart Lightroom

Alternatively

1. On most computers, the Lightroom module directory is at C:\Users\[user name]\AppData\Roaming\Adobe\Lightroom\Modules
2. Copy the .zip to this directory, extract there. This shoudl create Paddy.lrdevplugin
3. Retsart Lightroom

Under Windows 7 and 8 , you might have to run Lightroom as administrator for Paddy to work well (this is due to some low level functions for Midi and other areas). To set this property, just iright-click on any shortcut, and click the Advanced button on the Shortcut page to get to the Advanced Properties dialog. You’ll see a dialog with a checkbox for “Run as administrator”. Check that, and Lightroom will always run as administrator if you use the shortcut to launch it. (You might be be prompted by Windows as you start LR

selection_name=Genovation 683    ; The name that will appear in the Menu to select a keyboard

menu_name=Genovation 683         ; The name that will apear in the "Assign" menu

gui_name=Genovation 683          ; The name used in the actual menu title

key_name=g683                    ; This is the name Paddy will use internally for the keys. No Spaces or special characters allowed.

GUI section

number_of_layers=2                                            ;The number of layers this keyboard supports (here, one basic and one "Shift"

horizontal_count=4                                            ;How many keys across

vertical_count=6                                              ;How many rows of keys

max_interface_keys=23                                         ;This is the number of keys that can be assigned. Here, less than 6*4 (=24), since one key is used to shift between layers

button_x=0,1,2,3,0,1,2,3,0,1,2,3,0,1,2,3,0,1,2,3,1,2,3        ;The X Coordinates of all keys that can be assigned. starts at 0. Note that the last set misses "0", as this is where the toggle key sits

button_y=0,0,0,0,1,1,1,1,2,2,2,2,3,3,3,3,4,4,4,4,5,5,5        ;The Y coordinates for the buttons that can be assigned

button_w=1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1        ;The width of the buttons. At the moment, only "1" is supported

button_h=1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1        ;The height of the buttons. At the moment, only "1" is supported

toggle_x=0                                                    ;X coordinates for toggle keys, separated by comma

toggle_y=5                                                    ;Y coordinates for toggle keys, separated by comma

layerbox_x=0                                                  ;X coordinates for the box that shows the different layers in the GUI

layerbox_y=7                                                  Y coordinates for the box that shows the different layers in the GUI

Hotkey section

this sections defines the keys that the keyboard will send. See here in the AutoHotkey help for a list of allowed hotkeys. Some combinations are especially interesting as they are not readily available in Paddy's designer. For instance, "Pause & 1" treats the Pause key like a shift key. If the external keyboard is able to send the macro "Pause down,1 down, 1 up, Pause up", you could map it by creating the hotkey "Pause & 1". This way, the external keyboard will never interfere with your real keyboard. See here in the AutoHotkey documentation for more. In general, if it is allowed in AutoHotKey (AHK), it is allowed here.

The section contains one variable per layer, with comma-separated keys in the order of the keys as defined in the GUI. Note that leading and trailing spaces lead to errors. "A,SPACE,B" is OK, "A,SPACE , B" will result in trouble because of the leading space for "B" and trailing space for "Space".

layer_1_hotkeys=F13,F14,F15,F16,F17,F18,F19,F20,F21,F22,F23,F24,!F13,!F14,!F15,!F16,!F17,!F18,!F19,!F20,!F21,!F22,!F23
layer_2_hotkeys=^F13,^F14,^F15,^F16,^F17,^F18,^F19,^F20,^F21,^F22,^F23,^F24,^!F13,^!F14,^!F15,^!F16,^!F17,^!F18,^!F19,^!F20,^!F21,^!F22,^!F23

Example from a more sophisticated file, here a G13 model that uses PrintScreen and Pause as Shift keys:

---

[NAME]

selection_name=Logitech G13 (Alternate)

menu_name=G13

gui_name=G13

key_name=g13

[GUI]

number_of_layers=3

horizontal_count=11

vertical_count=6

max_interface_keys=29

button_x=0,1,2,3,4,5,6,0,1,2,3,4,5,6,1,2,3,4,5,2,3,4,7,8,9,9,10,9,8

button_y=0,0,0,0,0,0,0,1,1,1,1,1,1,1,2,2,2,2,2,3,3,3,3,5,3,2,3,4,3

button_w=1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,2,1,1,1,1,1

button_h=1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,2,1,1,1,1,1,1

toggle_x=

toggle_y=

layerbox_x=1

layerbox_y=-1

[HOTKEYS]
layer_1_hotkeys=PrintScreen & 1,PrintScreen & 2,PrintScreen & 3,PrintScreen & 4,PrintScreen & 5,PrintScreen & 6,PrintScreen & 7,PrintScreen & 8,PrintScreen & 9,PrintScreen & 0,PrintScreen & A,PrintScreen & B,PrintScreen & C,PrintScreen & D,PrintScreen & E,PrintScreen & F,PrintScreen & G,PrintScreen & H,PrintScreen & I,PrintScreen & J,PrintScreen & K,PrintScreen & L,PrintScreen & M,PrintScreen & N,PrintScreen & O,PrintScreen & P,PrintScreen & Q,PrintScreen & R,PrintScreen & S

layer_2_hotkeys=PrintScreen & T,PrintScreen & U,PrintScreen & V,PrintScreen & W,PrintScreen & X,PrintScreen & Y,PrintScreen & Z,PrintScreen & F1,PrintScreen & F2,PrintScreen & F3,PrintScreen & F4,PrintScreen & F5,PrintScreen & F6,PrintScreen & F7,PrintScreen & F8,PrintScreen & F9,PrintScreen & F10,PrintScreen & F11,PrintScreen & F12,PrintScreen & SPACE,PrintScreen & TAB,PrintScreen & ENTER,PrintScreen & DEL,PrintScreen & backspace,PrintScreen & home,PrintScreen & UP,PrintScreen & RIGHT,PrintScreen & Down,PrintScreen & Left

layer_3_hotkeys=PrintScreen & Numpad0,PrintScreen & Numpad1,PrintScreen & Numpad2,PrintScreen & Numpad3,PrintScreen & Numpad4,PrintScreen & Numpad5,PrintScreen & Numpad6,PrintScreen & Numpad7,PrintScreen & Numpad8,PrintScreen & Numpad9,PrintScreen & Numpadmult,PrintScreen & Numpaddiv,PrintScreen & Numpadadd,PrintScreen & Numpadsub,PrintScreen & Numpadenter,PrintScreen & Numpaddot,PrintScreen & End,PrintScreen & pgup,PrintScreen & pgdn,PrintScreen & ESC,Pause & 1,Pause & 2,Pause & 3,Pause & 4,Pause & 5,Pause & 6,Pause & 7,Pause & 8,Pause & 9

---

Legal Remarks

Paddy is a third party product for use with Adobe Lightroom. Adobe, the Adobe logo, Lightroom and Photoshop are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. X-keys is a trade mark of P.I. Engineering, Inc. GENOVATION is a registered trade mark of Genovation Incorporated. BEHRINGER is a trademark of Behringer corporation. Logitech and G13 are a registered Trademark of Logitech. Novation and Nocturn are trademarks by Novation, IPad is an Applke trademark, and I probably forgot a few.

Paddy is licensed under CC BSD

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the programmer nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.