G Assignments

Overview, Warnings, Limitations and Installation

See the G Assignments web site.

Legal

You accept the risk that G Assignments could break your computer and/or stuff up its software, data, etc.

Usage

Normal Use

Short answer: you don’t need to do anything!

Longer answer: whenever you change application profile (by changing the application you’re using) or M-key mode (by pressing an M-key), G Assignments will normally display the G-key assignments you’ve set for that application and M-key mode using the Logitech Gaming Software (LGS). (Alternatively, you can get G Assignments to display arbitrary information relevant to the current application and, optionally, M-key mode: see here.)

Start-up and After Suspension

G Assignments can only determine which profile and M-key mode are active when a change is made to either of those states. Therefore, on start-up, you’ll need to switch profiles or press an M-key before G Assignments can update the LCD. This will also be necessary if G Assignments has been suspended (eg, due to a conflict). The LCD will notify you of this requirement.

G-Key Assignment Changes

If you’ve selected ‘Update on profile activation’ in G AssignmentsSettings, G Assignments should detect assignment changes you make to a profile when the profile is reselected (ie, when switching to the application to which the profile applies). If this is done too quickly, the applet may not see some or all of the changes because LGS may not have written them out to disk yet. In this case, swap away from the application and then back to it again.

If you haven’t selected ‘Update on profile activation’, you can get G Assignments to rescan the profile using the ‘Reload current profile now’ or ‘Reload all profiles now’ buttons on G AssignmentsSettings dialog box.

This behaviour also applies to changes made to text files.

Backlight Colour Changes

Depending on your settings, G Assignments can display the profile name and/or assignments in the backlight colour of the active profile and (if applicable) M-key mode. The LGS colour settings are normally only read when G Assignments is started. You can get a rescan of LGS’ colour assignments by clicking ‘Reload all profiles now’ from G AssignmentsSettings dialog box.

Profile Creation

If you create a new profile in LGS, G Assignments will need to be prompted to look for it. You can do this by clicking ‘Reload all profiles now’ from G AssignmentsSettings dialog box.

When G Assignments detects the new profile, it will make changes to the profile to enable communication with it. When it does so, it will exit and prompt you to restart LGS and G Assignments to ensure that its changes are not overwritten. To do so, follow these steps:

Profile Name Changes

If you rename a profile after G Assignments has inserted the script it needs, there will be a mismatch between the name in the script and the new name of the profile. G Assignments will report an ‘unknown profile’. You can get G Assignments to detect and correct this problem by following the process described for profile creation.

Script Changes

G Assignments makes changes to each profile’s Lua script. You can still write and edit scripts to do other things. When doing so, be careful not to damage the Lua code involving the GApplet() function.

Background Images

G Assignments displays an image behind the list of G-key assignments. Different images can be displayed for each profile and (optionally) M-key mode. Images could be screen captures, the application’s icon or splash screen, or anything else.

Images must be exactly 320 × 240 pixels, PNG or JPG format. To allow the text to be visible against the background image, you will probably need to adjust the image’s brightness.

Images must be stored in %LOCALAPPDATA%\Logitech\Logitech Gaming Software\Images (which will be something like C:\Users\Peter\AppData\Local\Logitech\Logitech Gaming Software\Images). The easiest way to open this folder is to use the ‘Open image/text file folder’ button on the Settings dialog box.

Warning

The contents of this folder will be deleted if you update LGS (even automatically), or if you uninstall G Assignments. Therefore, keep a copy of any files that you store here.

Image filenames depend on whether you want different images for different M-key modes:

Images are reread whenever a new profile or M-key mode comes into effect. Therefore, to see a new background image, you will need to switch applications or press an M-key.

Text Files

In addition to listing G-key assignments, G Assignments can display user-generated text files on the keyboard’s LCD. You can have more than one text file per profile and M-key mode. Text files can be used to display mouse button assignments, joystick assignments, other keyboard shortcuts, etc.

Text file formatting options are described here.

Text files must be stored in %LOCALAPPDATA%\Logitech\Logitech Gaming Software\Images (which will be something like C:\Users\Peter\AppData\Local\Logitech\Logitech Gaming Software\Images). The easiest way to open this folder is to use the ‘Open image/text file folder’ button on the Settings dialog box.

Warning

The contents of this folder will be deleted if you update LGS (even automatically), or if you uninstall G Assignments. Therefore, keep a copy of any files that you store here.

Filenames depend on whether you want to display different files for different M-key modes:

G Assignments may not notice any changes you make to text files immediately. It rescans text files under the same circumstances in which it rescans application profiles (see G-Key Assignment Changes).

To cycle the LCD to the next text file, or back to the G-key assignments, press the left/right buttons near the LCD.

To scroll a text file up/down, press the up/down buttons near the LCD. By default, files are scrolled one page (8 lines) at a time; to scroll line-by-line, untick ‘Scroll by page’ in Settings.

Possible Issues

Unresponsive at Start

Initial start-up of G Assignments could take a few seconds, since it has to parse every profile (and may need to make updates to them). It will be unresponsive while this is occurring. In normal use, this only happens when you log into your computer. However, it will also apply if you have to restart G Assignments because you’ve added or renamed profiles.

Doesn’t Start

Whenever you exit LGS, G Assignments will be stopped (as it should be). Unfortunately, LGS can’t restart G Assignments, so if you restart LGS manually, you’ll also need to manually restart G Assignments from the Start Menu.

Conflicts with LGS

G Assignments may detect conflicts between itself and LGS (eg, when creating a new profile). When a conflict is detected, the applet suspends its operation (or you can pre-emptively do this yourself). This should allow LGS to continue to run. A notice to this effect will be displayed on the LCD.

When you’ve finished interacting with LGS, you can re-enable G Assignments by pressing the LCD OK button. You will then need to switch profiles or press an M-key so that G Assignments will know which profile to display.

Conflicts don’t occur when creating or changing G-key assignments in LGS, so you should rarely encounter this issue.

Unknown Profiles

See Profile Name Changes.

Menu

Pressing the MENU button near the LCD gives the following options:

Settings

To access G Assignments’ settings, press the MENU button near the LCD, then press the OK button near the LCD. G Assignments will be suspended while the settings dialog box is displayed.

Title colour. The colour to use on the LCD’s title line (unless over-ridden). Options are:

Text colour. The colour to use for normal text lines on the LCD (unless over-ridden). Options are as above.

Scroll by page. Scrolls text files one page (8 lines) at a time when an up/down button is pressed.

Open image/text file folder. Opens the folder in which you should store background images and text files.

Display M mode. Determines whether M1/M2/M3 will be shown in the upper right corner of assignment lists on the LCD.

Display G labels. Specifies the format in which G-key labels (eg, G7) will be shown on assignment lists on the LCD.

Update on profile activation. Causes G Assignments to check for profile updates whenever a profile is activated. This causes a tiny delay but ensures that the display is always up to date. This is convenient if you make frequent changes to your profiles. If you seldom change your profiles, you can deselect this option. If this option isn’t selected, you can get G Assignments to reload changed profiles using the ‘Reload current profile now’ or ‘Reload all profiles now’ buttons.

Check profile scripts. Causes G Assignments to verify that profile Lua scripts have been modified to communicate with the applet whenever the profile is reloaded. Deselecting this option will save some time, and can be done after all of your profiles have been converted. If you see Unknown Profile errors, you will want to re-enable this at least once.

Reload current profile now. Reloads G-key assignments and checks for text file changes for the currently-active profile. Does not check for global backlight colour changes.

Reload all profiles now. Reloads G-key assignments and checks for text file changes for all profiles. Also reloads colour settings that are not profile-specific.

Text File Format

This section describes the file format options you can use for text files to be displayed by G Assignments.

Files must be plain text, so use Notepad or equivalent, rather than a word processor. Avoid non-English characters.

G Assignments does not peform any word wrapping. Text lines can contain up to 29 characters and will be left-justified. Because a fixed-width font is used, you can simulate other forms of line justification through judicious use of spaces. Similarly, you can arrange information into columns using spaces (but not tabs).

Although the LCD can only display 8 lines of normal text, text files can contain more than 8 lines. Use the up/down buttons near the LCD to scroll text files up/down.

A trivial text file:

Line 1
Line 2
Line 3
Line 4
Line 5
Line 6
Line 7
Line 8
Line 9
Line 10

Page Breaks

A page break can be effected by placing ‘#!’ on a line of its own. For example:

Page 1 Line 1
Page 1 Line 2
Page 1 Line 3
#!
Page 2 Line 1
Page 2 Line 2

Titles

The LCD can display a single title line. Titles can contain up to 17 characters and will be centred (although you can use spaces to influence this). To indicate that a line in a text file should be displayed as a title, precede it with ‘#! ’. For example:

#! Page 1's Heading
Page 1 Line 1
Page 1 Line 2
Page 1 Line 3
#!
#! Page 2's Heading
Page 2 Line 1
Page 2 Line 2

Colours

Title and normal text lines can be prepended with a colour specification, in the form of a hex triplet. The colour applies for the whole line. For example:

#! #FF0000 Red Heading
#00FF00 Green line
#0000FF Blue line
#FFFFFF White line

If you don’t explicitly specify the colour of a title or normal line in this manner, the settings for title colour and text colour in G Assignmentssettings will be applied.

Background Images

To display a background image, specify the image filename (without path) after ‘#! ’. Each page of a text file can have a different background image. If no image is specified for a page, the image applicable to the previous page is used. For example:

#! Page 1
#! Page1Image.png
Page 1 text
#!
#! Page 2
Page 2 has same image.
#!
#! Page 3
#! Page3Image.png
Page 3 has new image.

Images must be formatted the same as assignment list background images, and must be stored in the same folder. However, they can be named whatever you like.

Warning

The contents of this folder will be deleted if you update LGS (even automatically), or if you uninstall G Assignments. Therefore, keep a copy of any files that you store here.

Removal

Uninstalling G Assignments won’t affect your profiles or LGS settings. To remove the applet:

Support

For general information, see the G Assignments web site.

If this application turns out to be useful, I’ll set up a contact page and (maybe) forum (probably somewhere here). In the meantime, try posting on the Logitech ‘Scripting and SDK’ forum.