*********************************************
*********************************************
****                                     ****
****         FONTCREATOR HOTKEYS         ****
****               v.0.0.0               ****
****   FOR FONTCREATOR PROFESSIONAL 11   ****
****                                     ****
*********************************************
*********************************************

FontCreator Hotkeys v.0.0.0 by Tyler Dickinson
Built with AutoHotkey v.1.1.25.01
This documentation is best viewed in Chrome, Internet Explorer, or Edge.
There are known display issues in Firefox.

Information

About FontCreator Hotkeys

FontCreator already has a number of keyboard shortcuts (or hotkeys), but many frequently used features do not have keyboard shortcuts currently built into the program. FontCreator Hotkeys (FCHK) more than doubles the number of hotkeys available to the program, and modifies some of the preexisting hotkeys for easier use or for compatibility with the newly created shortcuts.

FCHK is a script wrapped into an executable (.exe) file. It is not a program, and it does not install on your system. As such, the files need to be stored on your computer or on a USB stick in a safe place. It is recommended to create a folder called FCHK in the user directory C:\Users\[User]\ (replace [User] with your username), or on your Desktop, and to unzip the contents of FCHK.zip into it. When downloading updates, replace the files in that directory with the updated files.

Please note: FCHK and its developer are not associated with High‑Logic B.V. or with AutoHotkey Foundation LLC.

Compatibility

This script is developed for High‑Logic B.V.’s FontCreator Professional 11. Because of FCHK’s dependency on the screen layout, it may not be compatible with older or newer versions, or with other editions, of FontCreator. Click here to buy or upgrade to the latest version of FontCreator.

Note: While FontCreator 11 is necessary to ensure compatibility, the Professional version may not be absolutely necessary. In theory, the hotkeys should still work with Home or Standard version. However, keep in mind that certain features of the program itself are not available on the Home or Standard licenses.

FontCreator and AutoHotkey are currently only available for Windows operating systems. These programs, and this FCHK script, will not work on non‑Windows platforms.

Contact

To report any bugs, mistakes, typos, or any other issues; to ask questions about how to use FCHK; or to make suggestions for improvements to FCHK or its documentation, please create an issue on the FCHK GitHub page. You will need to create a free GitHub account to post an issue. Also, inasmuch as it is reasonably possible, please check the already reported and solved issues to see if there is a solution to your problem before creating a new issue.

To contact the developer directly, send an email. Please do not use email to report bugs, to ask questions, or to suggest improvements; instead, use the GitHub page, so others can benefit from your input.

Please do not contact the developer, or post issues on the GitHub repository, regarding FontCreator or AutoHotkey. The developer is not able to provide any assistance with these programs and will only respond to issues regarding FCHK. For help with FontCreator, see the FontCreator Forum; for help with AutoHotkey, see the AutoHotkey forum.

Printing this Documentation

This documentation is currently only designed to be printed on A4 sized paper. If you would like to print this documentation on a different size of paper, it is recommended that you print the file to PDF from your web browser (and choose A4 as your page size), and then print from the PDF to your printer on an alternate page size (such as Letter); this will preserve the margins and layout for easier readability.

The internal page structure of this documentation is also designed so you can easily print only the pages containing the list of hotkeys, with no extra clutter.

How to Use FontCreator Hotkeys

FontCreator Layout

Because the current version of FontCreator does not include every tool in the main menu, some shortcuts are mapped to precise coordinates within the window. In other words, typing the hotkey tells the mouse to move to a certain place on the screen, to click in that location, and then to return to its starting position. For the script to work properly, therefore, it is necessary that your FontCreator window has the layout FCHK needs. Otherwise, there is no way for the mouse to find the correct button.

Understandably, this may be inconvenient for some users. You are welcome to make changes to the script, but remain aware of compatibility issues and updates. The developer is not able to resolve bugs or issues caused by modifications to the script.

The window layout should be arranged as follows:

FontCreator toolbar layout
  1. The main menu bar (File, Edit, View…), highlighted yellow in the image, must be at the top of the screen.
  2. The standard toolbar (New Document, Open, Save, Print…), highlighted orange, must be directly underneath the menu bar, aligned to the left of the window.
  3. The overview toolbar, highlighted green, must be to the right of and in‑line with the standard toolbar, ensuring that all of the standard toolbar buttons are visible, and there are no gaps between the two toolbars.
  4. The align or distribute toolbar, highlighted red, must be immediately to the right of the overview toolbar, again, with no gaps, and ensuring all the buttons are visible.
  5. The drawing toolbar (Selection, Measure, Knife…), highlighted blue, must be docked immediately below the standard toolbar, also aligned flush to the left.
  6. The glyphs toolbar, highlighted in purple, must be docked immediately to the right of the drawing toolbar, ensuring all buttons in both toolbars remain visible, and that there are no gaps between the toolbars.

This top area of the screen is absolute, and FCHK will not function correctly if it is not laid out as described. Other toolbars and windows may be open and docked below these toolbars, or to the right, left, or bottom of the screen, provided that the layout, button size, and visibility of the top‑frame toolbars is not changed or impeded or obscured.

Currently, no hotkeys are designed to work in the tool windows, but a future update will incorporate this feature. Some shortcuts, but not many, are already available by default for some FontCreator tool windows (such as the OpenType Designer), and these hotkeys will continue to function.

Enabling Access Keys

For the script to work properly, access keys must also be enabled on your system. Access keys are the small underline you can see in menus and on windows, indicating a key to press to access that function. Sometimes, the keys are only visible when you press Alt. If access keys are not currently enabled on your system, or if you don’t know if they are enabled, follow these steps:

  1. Navigate to the Ease of Access settings on your operating system
    • Press Win+U, or
    • Go to the control panel and click on “Ease of Access Center”
  2. On Windows 10:
    • Click on Keyboard in the left panel
    • Scroll down to “Other Settings”
    • Turn on “Enable Shortcut Underlines”
  3. Or, from the Control Panel (older versions of Windows):
    • Scroll down to and click on “Make the keyboard easier to use”
    • Scroll down to “Make it easier to use keyboard shortcuts”
    • Check “Underline keyboard shortcuts”

If the access keys are not turned on, FCHK may not be able to access many menu items assigned to the hotkeys.

Running the Script

To use FCHK, download FCHK.zip from GitHub. In it, you will find three files: FCHK.exe, FCHK.ahk, and this README.html. After downloading, unzip the files to a safe and memorable location (such as C:\Users\[User]\FCHK\ or C:\Users\[User]\Desktop\FCHK\). Note that you do not need an internet connection to access this documentation file after it is saved to your computer.

To run the script, double‑click on FCHK.exe, or right‑click the file and choose “Open”. The script will immediately start running in the background of the operating system. There is no installation, but a message box should open to indicate the script is running. Neither FontCreator nor the computer need to be restarted. (In fact, restarting the computer stops the script, and the script will need to be re‑executed each time the system boots.)

To verify the script is running successfully, a green icon should appear in the system tray. If there is no icon in the tray, check Task Manager to see that FCHK.exe is running.

To launch the file automatically when Windows boots:

  1. Go to the .exe file, right‑click on it, and select “Copy”
  2. Navigate to C:\Users\[User]\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup\
  3. Right‑click in the window and choose “Paste Shortcut”

Note that changing the location or name of the .exe file will create an error in the shortcut destination. If you change the location of the .exe file, then you will have to recreate or remap the shortcut accordingly.

Interface Note

While using FCHK, you might notice your mouse jumping around the screen. This is normal behavior and not anything to be concerned about. As previously mentioned, some of the hotkeys need to simulate mouse clicks. For example, when pressing Shift+D (Free Draw Contour tool), the script tells the mouse to move to certain coordinates on the screen (over the button for the Free Draw Contour tool). Although this movement happens instantaneously, for a brief moment, you might see your mouse arrow move to the button. FCHK is programmed to return the mouse cursor to the same position it started in, so you never lose track of your pointer.

Stopping the Script

To temporarily pause the script, right‑click the tray icon and choose “Suspend Hotkeys”. The icon will turn red. Do not click “Pause Script”, as this has a different effect. Click again on “Suspend Hotkeys” to turn them on again; the icon will change back to green.

To exit the script, right‑click on the tray icon and choose “Exit”. This closes the script. To re‑enable the hotkeys, run the program again by double‑clicking the executable file.

To remove the script, simply delete the file either by selecting it and pressing “Delete” on the keyboard, or by dragging and dropping it into the Recycle Bin. Since it is not a program, it does not need to (and, in fact, cannot) be uninstalled, and it cannot be found in the list of installed applications on the system. Note that deleting the file completely removes it from your system, and you will need to download it again from the GitHub repository.

Modifying the Script

Under the Open Source license, users are allowed to modify FCHK. To modify the script, AutoHotkey needs to be installed. After installation, navigate to the folder containing the file FCHK.ahk. Right‑click the file and choose “Edit Script”. (Alternately, choose “Open with…” and select “Notepad”.) Do not double‑click, as this will launch the script.

You may wish to modify the hotkeys either to change the hotkey (ex. to press S to activate the Selection tool), or to modify the coordinates for a different screen layout. If you change a hotkey, ensure that it is not also assigned to another function, as this will cause the script to fail. Modifying the coordinates is a more complicated process, involving using a “window spy” to find the coordinate values. See the AutoHotkey documentation for help with modifying the script.

Please note: remember to send bug reports to the developer before trying to modify or fix them yourself. If you make any modifications, it is recommended that you also save them in a separate .txt file. When FCHK updates are available, you can then copy and paste your customizations into the new code. Otherwise, your changes will be lost when you use a newer release of the script.

Also note: if you modify the script, you will have to use FCHK.ahk to launch the script, not the .exe file. Simply double‑click on the file to run it. You can also target a shortcut to the file to automatically run it at startup, just as with the .exe file.

Setting Custom External Programs

FontCreator allows the user to choose up to three external programs to be able to launch from within FontCreator. By default, MainType, Windows Fonts, and Windows Character Map are set, and these three cannot be changed. However,the user may add up to three more programs, and FCHK is right there to give you hotkeys to launch your external programs.

To take advantage of this feature, first set up the external programs within FontCreator.

  1. Navigate to the “Tools” menu at the top of the screen, and from the “Launch Externals” flyout, click on “Configure Externals”.
  2. Click the folder icon next to one of the three locations boxes, and navigate to the .exe file of your choice, and then select “Open”.
  3. In the corresponding title box, type in the name of the program (if it is not automatically filled).
  4. Place an & before any character in the title; the letter after the & becomes the access key. IMPORTANT: Each access key has to be unique. Do not use M, F, or C, as those are already assigned to the default options.
  5. Make a note of your access key(s) so you don't forget.

Then, navigate to FCHK.ahk, right‑click it, and choose “Edit Script” (or “Open with…” and choose “Notepad”). At the top of the file is a predesignated area for adding your own hotkeys. Three keys are already prepared in this section, but they need more information for their function to be carried out.

The first line of each sequence defines the hotkey; in this case, it is Ctrl+Shift+F10 or F11 or F12. The second line of the function tells the computer what to do when the hotkey is pressed. The sequence tells the script to “Send” a key sequence, namely: F10, which opens the main menu, then L, which targets the Tools menu, and X, which flies open the Launch Externals panel. The only thing left is to define which item in that panel will be targeted by which hotkey.

Next to the x in the Send command, type in the access key for one of your external programs. It might look something like:

Send {F10}lxi

Now copy the whole section, and paste it into a new .txt (Notepad) file. Save the new file with whatever name you like, such as my_hotkeys.txt. Keep this file together with your FCHK script so you can easily access them again whenever you update FCHK. Now back in FCHK.ahk, save the file, and double‑click on it to run the script.

Updates

Updating FCHK

FCHK will not update automatically. You will need to manually download and “install” (i.e. save to your computer) the updated files. To be notified when updates are available, click here and choose “Watch”. Then go to your notification settings and ensure “Watching>>Email” and “Pull Request pushes” are checked. (The other boxes can be checked or unchecked according to your preference.) Then you will receive an email whenever a new version is uploaded to GitHub.

To get the update, simply download the new .zip folder as you did when you first downloaded FCHK, and extract the files to the same location (ex. C:\Users\[User]\FCHK\). Overwrite any duplicate files and delete any old files. If you created a shortcut to run FCHK at windows startup, rename the new .exe file to match the shortcut target, or update the shortcut to target the new .exe file.

Known Issues

Unfortunately, for many reasons, there are some already known and unavoidable issues. Perhaps the most glaring issue is that some functions are only available in certain modes (ex. only in Color mode, or only in the Font Overview window), and the access keys used to map hotkeys to functions are reused in different modes.

For example, pressing Alt+U in Contour mode opens the “Used by” window. To do this, the script actually tells the computer to open the context menu and type Y, which is the access key for “Used by”. However, in Point mode, the access key is U, and in the Font Overview window, the access key Y is mapped to “Type” in the context menu.

Currently, the only possible workaround is to just ensure you are in the correct view mode when using a hotkey. See the notes in the List of Hotkeys for more information.

Other known issues:

  • Unable to access “Decolorize” from Font Overview window.
    • Workaround: Use Shift+F10, O, D.
  • “Used by” hotkey only works in Contour mode, not in Point mode. Conflicts with Type menu in Font Overview.
    • Workaround: In Point mode, use Shift+F10, U.
  • Ctrl+Tab does not navigate open tabs in the order displayed, but rather in the order they are clicked, opened, or most recently used.
    • Note: This is an issue within FontCreator, not an issue caused by FCHK.
  • Remove code points (Ctrl+Backspace) in Font Overview window will trigger Redo if deployed in Contour or Point mode.
  • Shortcuts for caption options will trigger Add Anchor in Contour or Point mode.
  • Arrange hotkeys (bring forward, send backward, send to back, bring to front) conflicts with on‑curve point in Point mode.
  • Add Color Glyph Member (Ctrl+Shift+L) conflicts with Add Point in Point mode and Tag in Contour mode.
  • Colorize to Selected Color (Alt+B) in Font Overview window; conflicts with on‑curve point in Point mode and Order in Contour and Color mode.
  • Smooth and align curves (S) conflicts with Convert in Contour mode.
  • Smooth curves (Shift+S) will target select all in Font Overview window.
  • Extend corner (X) will open the Glyph Edit window if deployed in Font Overview and Change Direction in Contour mode.
  • Split contour (Shift+X) will target Clear Selection in Font Overview window.
  • Glyph Type hotkeys will open Used By window in Contour mode.

To help avoid conflicts, keep FontCreator and FCHK updated regularly. The FCHK developer will do his best to release updates to FCHK as quickly as possible when FontCreator has been updated. However, please be advised that the more complex the FontCreator update is, the more complicated it is to revise the hotkeys, and the longer it may be before an update is released. (For example: FCHK was first developed for FontCreator 10.1, and it took approximately five full days of working to update it for FontCreator 11. When FontCreator 11 was updated to version 11.0.02366, it took approximately two to three days to update FCHK.)

Planned Updates

A future update will include hotkeys for each tool window in FontCreator, as well as a full set of hotkeys for the OpenType Developer window. Because of the complexity of these windows, it is a difficult and time‑consuming task to write the scripts for them. At this point, there is no anticipated release date for the update, but it will certainly come.

Change Log

v.1.0.0 (22/05/17)
This is the first version! There are no changes to record.

List of Hotkeys

Notes: Default hotkeys (those preset in FontCreator) are marked with ¹. Hotkeys which have been redefined (i.e. the given hotkey has a different default function in FontCreator) are marked with ². Hotkeys which are reassigned (i.e. the given function has a different default hotkey in FontCreator) are marked with ³.

For example: In FontCreator, Ctrl+Shift+S is the default hotkey for “Save all”. However, in FCHK, Ctrl+Shift+S has been redefined as “Save as”. The function “Save all” has been reassigned to the hotkey Ctrl+Alt+S.

As mentioned in the Known Issues, some hotkeys are only accessible or only work correctly in certain modes. Most hotkeys are available globally, meaning that they function in the Font Overview window and in the Glyph Edit window, whether in Contour, Point, or Color mode. Other hotkeys are context specific, and may cause unexpected results if used outside their proper contexts.

To help you work most efficiently with FCHK, the hotkey list is marked with the following notation:

Hotkeys accessible in Contour mode are marked with ∗. Hotkeys accessible in Point mode are marked with †. Hotkeys accessible in Color mode are makred with ‡. Hotkeys accessible only in the Font Overview window are marked with §. Hotkeys without any corresponding notation are globally accessible.

File
F1
Help¹
Ctrl+N
New project¹
Ctrl+O
Open font/project¹
Ctrl+S
Save¹
Ctrl+Shift+S
Save project as²
Ctrl+Alt+S
Save all³
Ctrl+P
Print glyph/font/properties¹
Ctrl+I
Open installed font¹
Ctrl+Z
Undo¹
Ctrl+Shift+Z
Redo¹
Ctrl+Y
Repeat²
Alt+U
Used by∗
F10
Activate main menu¹
Shift+F10
Activate context menu¹
Shift+F1
Open FontCreator manual
Ctrl+F1
Check for updates
Validate and Export
Alt+P
Validate font
F7
Glyph validation toolbar¹
F5
Test font as TFF/OTF¹
Ctrl+F5
Test font as WOFF¹
Ctrl+E
Export settings²
Ctrl+Shift+E
Export as TFF/OTF¹
Ctrl+Shift+W
Export as WOFF¹
Ctrl+Shift+A
Export in all formats¹
Ctrl+Alt+E
Export all
Ctrl+Alt+I
Install font
Properties and Options
Ctrl+K
Options²
Alt+Enter
Font properties¹
Alt+I
Font info
Ctrl+6
Grid options
Ctrl+7
Guideline options
Ctrl+8
Metrics options
Externals
Ctrl+F10
Launch MainType¹
Ctrl+F11
Launch Windows font folder¹
Ctrl+F12
Launch Windows character map¹
Ctrl+Shift+F10
Custom external program 1
Ctrl+Shift+F11
Custom external program 2
Ctrl+Shift+F12
Custom external program 3
Edit
Ctrl+C
Copy¹
Ctrl+X
Cut¹
Ctrl+V
Paste¹
Ctrl+Shift+V
Paste special³§
Del
Delete¹
Backspace
Clear selected glyph¹
Enter
Open Glyph Edit window¹§
Ctrl+Backspace
Remove code points§
Ctrl+Shift+C
Make simple§
Ctrl+Del
Make empty¹
Ctrl+1
Tag selected as “Important”¹
Ctrl+2
Tag selected as “Incomplete”¹
Ctrl+3
Tag selected as “Completed”¹
Ctrl+4
Tag selected as “Review”¹
Ctrl+5
Tag selected as “Workspace”¹
P
Load first 255 selected glyphs into preview¹§
Shift+P
Append first 255 selected glyphs to preview¹§
Select
Ctrl+A
Select all¹
Ctrl+Alt+A
Select composites§
Ctrl+T
Invert selection¹
Ctrl+U
Clear selection¹
Ctrl+Shift+1
Select all tagged “Important”§
Ctrl+Shift+2
Select all tagged “Incomplete”§
Ctrl+Shift+3
Select all tagged “Completed”§
Ctrl+Shift+4
Select all tagged “Review”§
Ctrl+Shift+5
Select all tagged “Workspace”§
W
Select next contour/point¹∗†
Shift+W
Select next contour/point, including current selection¹∗†
Q
Select previous contour/point¹∗†
Shift+Q
Select previous contour/point, including current selection¹∗†
Visibility and Display
Ctrl+9
Display values as hex³
Alt+9
Display values as dec³
H
Hide all except glyph¹∗†‡
Ctrl+H
Toggle fill outlines¹
P
Toggle point/contour mode¹∗†‡
Alt+1
Automatic captions§
Alt+2
Glyph name captions§
Alt+3
Glyph index captions§
Alt+4
Codepoint captions§
Alt+5
Unicode name captions§
Zoom
Z
Zoom‑in selector tool∗†‡
Alt+Z
Zoom to selected∗†‡
+
Ctrl+ +
Increase cell size/zoom in¹
Ctrl+Shift+ +
Increase character size¹
-
Ctrl+ -
Decrease cell size/zoom out¹
Ctrl+Shift+ -
Decrease character size¹
/
Fit to window¹
Ctrl+0
Reset zoom to default¹
Ctrl+Tab
Next tab/window¹
Ctrl+Shift+Tab
Previous tab/window¹
Ctrl+F4
Close tab¹
Ctrl+W
Close window¹
Ctrl+F
Find¹
F3
Find next¹
Shift+F3
Find previous¹
Alt+ 
Previous glyph¹∗†‡
Alt+ 
Next glyph¹∗†‡
Grids, Guidelines, and Anchors
G
Add guideline through selected point¹∗†
Shift+G
Toggle grid visibility∗†‡
Alt+Shift+G
Toggle snap to grid∗†
Ctrl+G
Toggle guideline visiblity∗†‡
Ctrl+Alt+G
Toggle snap to guidelines∗†
Alt+G
Toggle lock guidelines∗†‡
Alt+A
Add anchor∗†
Alt+Shift+A
Toggle anchor visibility∗†‡
Ctrl+Alt+Shift+A
Toggle loch anchors∗†‡
Ctrl+Alt+M
Toggle metrics visibility∗†‡
Ctrl+Alt+Shift+M
Toggle lock metrics∗†‡
Arrange
PgUp
Bring forward∗‡
Shift+PgUp
Bring to front∗‡
PgDn
Send backward∗‡
Shift+PgDn
Send to back∗‡
Alt+L
Align left∗†
Alt+E
Align center∗†
Alt+R
Align right∗†
Alt+T
Align top∗†
Alt+M
Align middle∗†
Alt+B
Align bottom∗†
Alt+H
Distribute horizontally∗†
Alt+V
Distribute vertically∗†
Color
C
Toggle standard/color mode¹
Shift+L
Colorize∗†
Ctrl+Shift+L
Add color glyph member‡
Alt+Shift+L
Decolorize‡
Alt+Shift+B
Colorize to selected color§
Transform
F6
Glyph Transformer¹
Shift+M
AutoMetrics
Shift+K
AutoKern
O
Optimize contours∗†
Alt+D
Change directions∗
Ctrl+J
Join (contour union)∗†
Alt+J
Join (contour intersection)∗†
Ctrl+Alt+J
Join (contour exclusion)∗†
, (comma)
Rotate 90° CCW
. (period)
Rotate 90° CW
Shift+ ,
Flip (over x‑axis)
Shift+ .
Mirror (over y‑axis)
S
Smooth and align curves†
Shift+S
Smooth curves∗†
Split self‑intersecting∗
X
Extend corner†
Shift+X
Split contour†
Shift+/
Round xy coordinates†
N
Change point to on‑curve¹
F
Change point to off‑curve¹
Alt+Q
Convert to quadratic Bézier curves
Alt+Shift+Q
Convert to cubic Bézier curves
Tools
V
Selection tool
Shift+V
Freehand selection tool
R
Rectangle tool
L
Elipse tool
D
Draw contour
Shift+D
Free draw contours
K
Knife¹
M
Measure¹
B
Paint bucket¹
Toolbars and Panels
F2
User notes¹
Shift+F2
Palette¹
F4
Glyph properties¹
Shift+F4
Anchors¹
F7
Glyph validation¹
Shift+F7
Toggle status bar¹
Ctrl+L
Toggle categories/scripts panel¹
F8
Preview¹
Shift+F8
Members¹
Ctrl+F8
OpenType Designer/code editor¹
F9
Background image¹
F11
Comparison¹
F12
Samples¹
Create
Alt+C
Insert character
Shift+C
Insert glyph
Alt+Shift+C
Insert composite glyph
Ctrl+Alt+C
Complete composites
Ctrl+D
Import image
Shift+F
Insert point
A
Add point(s) after selected¹
Ctrl+Alt+1
Set glyph type to “Automatic”§
Ctrl+Alt+2
Set glyph type to “Unassigned”§
Ctrl+Alt+3
Set glyph type to “Simple”§
Ctrl+Alt+4
Set glyph type to “Ligature”§
Ctrl+Alt+5
Set glyph type to “Mark”§
Ctrl+Alt+6
Set glyph type to “Component”§
Mouse
Ctrl+Wheel
Change cell size¹
Ctrl+Shift+Wheel
Change character size¹
Ctrl+Left‑click+drag (background)
Pan around glyph edit window¹
Double‑left‑click (guideline)
Adjust guideline¹
Shift+Left‑click (guideline)
Rotate guideline¹
Ctrl+Drag (an object)
Duplicate¹

License Agreement

View the license online.

GNU GENERAL PUBLIC LICENSE

Version 3, 29 June 2007

Copyright © 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Preamble

The GNU General Public License is a free, copyleft license for software and other kinds of works.

The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program — to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.

For the developers’ and authors’ protection, the GPL clearly explains that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.

Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.

Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general‑purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non‑free.

The precise terms and conditions for copying, distribution and modification follow.

TERMS AND CONDITIONS

0. Definitions.

“This License” refers to version 3 of the GNU General Public License.

“Copyright” also means copyright‑like laws that apply to other kinds of works, such as semiconductor masks.

“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.

To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.

A “covered work” means either the unmodified Program or a work based on the Program.

To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.

To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.

1. Source Code.

The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non‑source form of a work.

A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general‑purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.

The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.

The Corresponding Source for a work in source code form is that same work.

2. Basic Permissions.

All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.

3. Protecting Users’ Legal Rights From Anti‑Circumvention Law.

No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.

When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.

4. Conveying Verbatim Copies.

You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non‑permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.

5. Conveying Modified Source Versions.

You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:

  1. The work must carry prominent notices stating that you modified it, and giving a relevant date.
  2. The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
  3. You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
  4. If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.

A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.

6. Conveying Non‑Source Forms.

You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine‑readable Corresponding Source under the terms of this License, in one of these ways:

  1. Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
  2. Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
  3. Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
  4. Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
  5. Convey the object code using peer‑to‑peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.

A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.

A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non‑consumer uses, unless such uses represent the only significant mode of use of the product.

”Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.

If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).

The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.

7. Additional Terms.

”Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:

  1. Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
  2. Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
  3. Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
  4. Limiting the use for publicity purposes of names of licensors or authors of the material; or
  5. Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
  6. Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.

All other non‑permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.

Additional terms, permissive or non‑permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.

8. Termination.

You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.

9. Acceptance Not Required for Having Copies.

You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer‑to‑peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.

10. Automatic Licensing of Downstream Recipients.

Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.

An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross‑claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.

11. Patents.

A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.

A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.

Each contributor grants you a non‑exclusive, worldwide, royalty‑free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.

In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.

If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.

A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non‑exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.

12. No Surrender of Others’ Freedom.

If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.

13. Use with the GNU Affero General Public License.

Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.

14. Revised Versions of this License.

The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.

If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.

Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.

15. Disclaimer of Warranty.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

16. Limitation of Liability.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

17. Interpretation of Sections 15 and 16.

If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS