Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 2.96 KB

README.md

File metadata and controls

55 lines (38 loc) · 2.96 KB
Raw

Glyphs Packages

Repository for collecting all available plug-ins for Glyphs. What is registered here will end up in Window > Plugin Manager. If you have written a plug-in and want to share it with the community, consider adding it to the .plist file.

Window

Format

Separate multiple entries with commas. Best place to put it is right behind the closing curly brace } at the end of the entry.

Required Fields

  • name: the file name of the plug-in in the repository, including the dot suffix. The name until the dot will be used as title in the Plugin Manager window, unless a title is set (see below).
  • url: the URL to the repository. On GitHub, this will be https://github.com/username/repositoryname.
  • description: a short text explaining the plug-in. It supports basic Markdown. Attention: Do not use linebreaks here, but keep the text on a single line. If you want a linebreak in your description, use \n instead.

Optional Fields

  • title: the human-readable name, if different from the file name of the plug-in. Useful for storing a name containing spaces when the filename does not.
  • screenshot: the URL to an image or screenshot illustrating the plug-in.
  • minVersion: the minimum Glyphs version required for running the plug-in. Use the three- or four-digit build number as displayed between parentheses next to the version string in Glyphs > About Glyphs, e.g., 895.
  • maxVersion: build number of the last version of Glyphs capable of running the plug-in. This can be used for older versions of the plug-in.

Conventions

  • Use emphasis (text surrounded by by single asterisks * or underscores _) for text that appears in the UI, like a menu command. E.g., File > Save.
  • Use code (text surrounded by single backticks \``) for text entered by the user, e.g. Python commands like Glyphs.defaults["x"]=y`.
  • Do not stylize keyboard commands. Capitalise key names (Cmd, Ctrl, Shift, Opt), and use dashes between keys, e.g. Cmd-Shift-B.

Example

{
	name = "Noodler.glyphsFilter";
	url = "https://github.com/mekkablue/Noodler";
	description = "*Filter > Noodler* turns monolines of all selected glyphs into noodles.";
	screenshot = "https://raw.githubusercontent.com/mekkablue/Noodler/master/Noodler.png";
	minVersion = 895;
},
{
	title = "Noodler (outdated version)";
	name = "Noodler_OLD.glyphsFilter";
	url = "https://github.com/mekkablue/Noodler";
	description = "This is an old version of Noodler. Consider updating Glyphs to use the latest version of the plug-in.";
	screenshot = "https://raw.githubusercontent.com/mekkablue/Noodler/master/Noodler.png";
	maxVersion = 894;
}

How to add your own plug-ins

To add your own plug-in, fork this repository, add your plug-in to the packages.plist and send a pull request.

Credits

The plug-in is based on the Xcode plug-in manager Alcatraz.