keyrune/README.md

# Keyrune v3.1.1

## The Magic: the Gathering set symbol font!

**Check it out:** our documentation page is online at [andrewgioia.github.io/Keyrune](https://andrewgioia.github.io/Keyrune)!

Keyrune is the first suite of complete Magic: the Gathering expansion and set symbols as a pictographic font. You can use this font anywhere you want to display set symbols&mdash;in your MtG app or website, documents, card images, anything!

## Usage

Each set symbol has its own font character. Display them in a manner similar to [Font Awesome](http://fontawesome.io) using the `<i class="ss ss-exp"></i>` element. Class name codes are based on the expansion codes from [MTG JSON](http://mtgjson.com).

To use Keyrune via source, NPM, or Bower, move the font files to your `/fonts` directory and include the keyrune.css stylesheet in your `<head>`:

```html
<link href="css/keyrune.css" rel="stylesheet" type="text/css" />
```

**NEW:** you can now include Keyrune via CDN thanks to the amazing [jdDelivr](http://jsdelivr.com) project! To include the latest version, reference:

```html
<link href="//cdn.jsdelivr.net/keyrune/latest/css/keyrune.css" rel="stylesheet" type="text/css" />
```

**Note:** as of v2.2.3 jsDelivr now DOES maintain the directory structure. **You no longer need to explicitly include the font-family via `@font-face`**, but if you still would like to here is the css ruleset:

```css
@font-face {
  font-family: 'Keyrune';
  src: url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.eot');
  src: url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.eot?#iefix') format('embedded-opentype'),
    url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.woff2') format('woff2'),
    url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.woff') format('woff'),
    url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.ttf') format('truetype'),
    url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.svg') format('svg');
  font-weight: normal;
  font-style: normal;
}
```

## Editing the Source

Feel free to edit the source files and compile Keyrune to fit your needs. Currently LESS is supported, with Sass coming soon.

## Using Keyrune on the Desktop

To copy Keyrune symbols into your desktop software (or access to vectors directly), go to the [Cheatsheet](http://andrewgioia.github.io/Keyrune/cheatsheet.html) on the documentation site, copy the character (not the unicode representation), and then paste it into your desktop application after installing keyrune.ttf.

If you're having trouble and want step-by-step instructions and a [sample Word document](https://www.dropbox.com/s/gp45uuuejfy089n/Keyrune_desktop_example.docx?dl=1) to use, head on over to the [documentation page](https://andrewgioia.github.io/Keyrune)!

## License

All set symbol images are copyright Wizards of the Coast ([http://magicthegathering.com](http://magicthegathering.com))

The Keyrune font is licensed under the the SIL OFL 1.1 ([http://scripts.sil.org/OFL](http://scripts.sil.org/OFL))

Keyrune CSS, LESS, and Sass files are licensed under the MIT License ([http://opensource.org/licenses/mit-license.html](http://opensource.org/licenses/mit-license.html))

Attribution is **greatly appreciated** but not required!

## Changelog

* v3.1.1 - Minor corrections for versioning
* v3.1.0 - Slew of new icons for Ixalan, Rivals of Ixalan, Explorers of Ixalan, and Unstable; corrected Hour of Devastation icon based on official release
* v3.0.3 - Adding new (correct) Archenemy: Nicol Bolas symbol with confirmed set code (e01)
* v3.0.2 - Fixing BRB path issue
* v3.0.1 - Adding IDW Promo icon and clenaing up some core set icons
* v3.0.0 - [Big update!](https://github.com/andrewgioia/Keyrune/milestone/1) Many symbols were compared and corrected to the original card version, 6 unofficial icons added, and new preview on doc site
* v2.3.0 - Adding Hour of Devastation symbol (awaiting higher resolution source)
* v2.2.3 - Adding Welcome Deck 2017 symbol
* v2.2.2 - Adding Amonkhet Invocation symbol; correcting Portal: Second Age set code and leaving alias
* v2.2.1 - Adding alias for Nemesis
* v2.2.0 - Duel Deck: Mind vs. Might added thanks to @csuhta
* v2.1.6 - Foil rarity added; corrected Kaladesh Inventions code to mps (mp1 alias remains)
* v2.1.5 - FTV: Vaults icon added (April Fools 2009 set); Archenemy: Nicol Bolas is now the same exact glyph as Archenemy
* v2.1.4 - Timeshifted rarity added
* v2.1.3 - Archenemy: Nicol Bolas added
* v2.1.2 - Magic Online Treasure Chest added, thanks to @csuhta
* v2.1.1 - Commander Anthology
* v2.1.0 - A whole slew of new promo and digital symbols thanks to @fenhl
* v2.0.1 - Xbox Media Promo symbol from original Duels of the Planeswalkers on Xbox
* v2.0.0 - Keyrune, now with sass! Thanks to @jordanbrauer
* v1.8.0 - Amonkhet icon added; re-organized Readme with new updates at top
* v1.7.2 - Added Kaladesh Inventions icon (labeled as MP1)
* v1.7.1 - Cleaned up icon files to remove any with multiple paths; fixed UNH icon
* v1.7.0 - Lots of new sets! Kaladesh, Aether Revolt, Modern Masters 2017, Planechase Anthology, Commander 2016, and Duel Decks: Nissa v. Ob Nixilis added
* v1.6.2 - Added Legendary Cube icon; unfortunately there's no official set code
* v1.6.1 - Updated EMN with the official high-res source image
* v1.6.0 - Eldritch Moon icon added (based on low-res WOTC graphic)
* v1.5.6 - Added forgotten Salvat 2005 and 2011 (inserts into MTG Encyclopedias)
* v1.5.5 - Duel Deck: Blessed vs. Cursed added
* v1.5.4 - Welcome Deck 2016
* v1.5.3 - FTV: Angels and FTV: Lore
* v1.5.2 - Conspiracy 2: Take the Crown added
* v1.5.1 - Eternal Masters added
* v1.5.0 - Oath of the Gatewatch and Shadows Over Innistrad added
* v1.4.3 - Beginning of white border add-on with .ss-border class; renamed font to Keyrune for desktop
* v1.4.2 - Commander 2015 added
* v1.4.1 - Zendikar Expeditions added
* v1.4.0 - Battle for Zendikar added
* v1.3.1 - Duel Decks: Zendikar v. Eldrazi added
* v1.3.0 - Magic Origins icon added
* v1.2.0 - Cheatsheet added to documentation site; variables changed in LESS files to be Keyrune specific
* v1.1.0 - Woff2 support added; Vintage Masters icon added
* v1.0.2 - Modern Masters 2015 added
* v1.0.1 - Tempest Remastered added (non major set version)
* v1.0.0 - public launch via /r/magicTCG! added Dragons of Tarkir (DTK)
* v0.2.0 - all fonts are fluid width now so they will scale correctly without scaled padding; fixed width class added
* v0.1.0 - initial font creation and CSS/LESS files for all sets up to Fate Reforged

## Todo

* New [Coming Soon](http://magic.wizards.com/en/game-info/products/coming-soon) product page has symbols but not the necessary higher res versions
* Figure out what the Legendary Cube official set code is; currently using `xLCU`
Adding Ixalan, Rivals of Ixalan, Explorers of Ixalan, and Unstable; official icon for Hour of Devastation 2017-06-17 13:08:32 +00:00			`# Keyrune v3.1.1`
Initial font and css/less files added up to Fate Reforged 2015-03-14 21:50:15 +00:00
			`## The Magic: the Gathering set symbol font!`

Adding the documentation page url to the readme 2016-12-16 02:25:40 +00:00			`Check it out: our documentation page is online at [andrewgioia.github.io/Keyrune](https://andrewgioia.github.io/Keyrune)!`

Initial font and css/less files added up to Fate Reforged 2015-03-14 21:50:15 +00:00			`Keyrune is the first suite of complete Magic: the Gathering expansion and set symbols as a pictographic font. You can use this font anywhere you want to display set symbols—in your MtG app or website, documents, card images, anything!`

			`## Usage`

			Each set symbol has its own font character. Display them in a manner similar to [Font Awesome](http://fontawesome.io) using the `<i class="ss ss-exp"></i>` element. Class name codes are based on the expansion codes from [MTG JSON](http://mtgjson.com).

Adding Amonkhet Invocations symbol and correcting Portal 2 code 2017-03-30 13:18:39 +00:00			To use Keyrune via source, NPM, or Bower, move the font files to your `/fonts` directory and include the keyrune.css stylesheet in your `<head>`:
Initial font and css/less files added up to Fate Reforged 2015-03-14 21:50:15 +00:00
			```html
			`<link href="css/keyrune.css" rel="stylesheet" type="text/css" />`
			```

Updating readme to reference CDN fixes 2017-04-19 15:28:23 +00:00			`NEW: you can now include Keyrune via CDN thanks to the amazing [jdDelivr](http://jsdelivr.com) project! To include the latest version, reference:`
Adding Amonkhet Invocations symbol and correcting Portal 2 code 2017-03-30 13:18:39 +00:00
			```html
Updating readme to reference CDN fixes 2017-04-19 15:28:23 +00:00			`<link href="//cdn.jsdelivr.net/keyrune/latest/css/keyrune.css" rel="stylesheet" type="text/css" />`
Adding Amonkhet Invocations symbol and correcting Portal 2 code 2017-03-30 13:18:39 +00:00			```

Updating readme to reference CDN fixes 2017-04-19 15:28:23 +00:00			Note: as of v2.2.3 jsDelivr now DOES maintain the directory structure. You no longer need to explicitly include the font-family via `@font-face`, but if you still would like to here is the css ruleset:
Adding Amonkhet Invocations symbol and correcting Portal 2 code 2017-03-30 13:18:39 +00:00
			```css
			`@font-face {`
			`font-family: 'Keyrune';`
Updating readme to reference CDN fixes 2017-04-19 15:28:23 +00:00			`src: url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.eot');`
			`src: url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.eot?#iefix') format('embedded-opentype'),`
			`url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.woff2') format('woff2'),`
			`url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.woff') format('woff'),`
			`url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.ttf') format('truetype'),`
			`url('//cdn.jsdelivr.net/keyrune/latest/fonts/keyrune.svg') format('svg');`
Adding Amonkhet Invocations symbol and correcting Portal 2 code 2017-03-30 13:18:39 +00:00			`font-weight: normal;`
			`font-style: normal;`
			`}`
			```

Initial font and css/less files added up to Fate Reforged 2015-03-14 21:50:15 +00:00			`## Editing the Source`

			`Feel free to edit the source files and compile Keyrune to fit your needs. Currently LESS is supported, with Sass coming soon.`

LESS prefixes are now keyrune-specific and not generic; cheatsheet documentation added for desktop use 2015-04-13 15:34:53 +00:00			`## Using Keyrune on the Desktop`

Updating readme with desktop info 2017-03-10 15:20:40 +00:00			`To copy Keyrune symbols into your desktop software (or access to vectors directly), go to the [Cheatsheet](http://andrewgioia.github.io/Keyrune/cheatsheet.html) on the documentation site, copy the character (not the unicode representation), and then paste it into your desktop application after installing keyrune.ttf.`

			`If you're having trouble and want step-by-step instructions and a [sample Word document](https://www.dropbox.com/s/gp45uuuejfy089n/Keyrune_desktop_example.docx?dl=1) to use, head on over to the [documentation page](https://andrewgioia.github.io/Keyrune)!`
LESS prefixes are now keyrune-specific and not generic; cheatsheet documentation added for desktop use 2015-04-13 15:34:53 +00:00
Initial font and css/less files added up to Fate Reforged 2015-03-14 21:50:15 +00:00			`## License`

Updated the Readme 2015-03-14 21:52:27 +00:00			`All set symbol images are copyright Wizards of the Coast ([http://magicthegathering.com](http://magicthegathering.com))`
Initial font and css/less files added up to Fate Reforged 2015-03-14 21:50:15 +00:00
Updated the Readme 2015-03-14 21:52:27 +00:00			`The Keyrune font is licensed under the the SIL OFL 1.1 ([http://scripts.sil.org/OFL](http://scripts.sil.org/OFL))`
Initial font and css/less files added up to Fate Reforged 2015-03-14 21:50:15 +00:00
Updated the Readme 2015-03-14 21:52:27 +00:00			`Keyrune CSS, LESS, and Sass files are licensed under the MIT License ([http://opensource.org/licenses/mit-license.html](http://opensource.org/licenses/mit-license.html))`
Initial font and css/less files added up to Fate Reforged 2015-03-14 21:50:15 +00:00
			`Attribution is greatly appreciated but not required!`

			`## Changelog`

Adding Ixalan, Rivals of Ixalan, Explorers of Ixalan, and Unstable; official icon for Hour of Devastation 2017-06-17 13:08:32 +00:00			`* v3.1.1 - Minor corrections for versioning`
			`* v3.1.0 - Slew of new icons for Ixalan, Rivals of Ixalan, Explorers of Ixalan, and Unstable; corrected Hour of Devastation icon based on official release`
Adding new icon for Archenemy: Nicol Bolas with confirmed set code; still awaiting higher resolution source image 2017-06-06 01:03:49 +00:00			`* v3.0.3 - Adding new (correct) Archenemy: Nicol Bolas symbol with confirmed set code (e01)`
Fixing BRB open path issue 2017-05-16 19:14:30 +00:00			`* v3.0.2 - Fixing BRB path issue`
Adding IDW Promo symbol and cleaning up some core set icons 2017-05-03 17:14:24 +00:00			`* v3.0.1 - Adding IDW Promo icon and clenaing up some core set icons`
v3.0.0 update with a slew of icon corrections for some older symbols, new unofficial icons, and an icon preview on the doc site 2017-05-02 22:33:09 +00:00			`* v3.0.0 - [Big update!](https://github.com/andrewgioia/Keyrune/milestone/1) Many symbols were compared and corrected to the original card version, 6 unofficial icons added, and new preview on doc site`
First draft symbol for Hour of Devastation added 2017-04-20 14:22:47 +00:00			`* v2.3.0 - Adding Hour of Devastation symbol (awaiting higher resolution source)`
Adding Welcome Deck 2017 symbol 2017-04-17 16:48:34 +00:00			`* v2.2.3 - Adding Welcome Deck 2017 symbol`
Adding Amonkhet Invocations symbol and correcting Portal 2 code 2017-03-30 13:18:39 +00:00			`* v2.2.2 - Adding Amonkhet Invocation symbol; correcting Portal: Second Age set code and leaving alias`
Adding alias for Nemesis 2017-03-29 17:59:00 +00:00			`* v2.2.1 - Adding alias for Nemesis`
Duel Deck: Mind vs. Might added 2017-03-22 12:15:36 +00:00			`* v2.2.0 - Duel Deck: Mind vs. Might added thanks to @csuhta`
Correcting Kaladesh Inventions code; new foil rarity 2017-03-14 19:16:38 +00:00			`* v2.1.6 - Foil rarity added; corrected Kaladesh Inventions code to mps (mp1 alias remains)`
Adding FTV: Vaults icon and resetting Archenemy: Nicol Bolas symbol to exact same glyph as original Archenemy 2017-03-14 13:42:30 +00:00			`* v2.1.5 - FTV: Vaults icon added (April Fools 2009 set); Archenemy: Nicol Bolas is now the same exact glyph as Archenemy`
Timeshifted rarity class added 2017-03-14 13:03:40 +00:00			`* v2.1.4 - Timeshifted rarity added`
Archenemy: Nicol Bolas icon added 2017-02-28 14:57:29 +00:00			`* v2.1.3 - Archenemy: Nicol Bolas added`
Magic Online Treasure Chest icon added, thanks to @csuhta 2017-02-24 11:52:59 +00:00			`* v2.1.2 - Magic Online Treasure Chest added, thanks to @csuhta`
Adding Commander Anthology and some aliases 2017-02-11 21:44:47 +00:00			`* v2.1.1 - Commander Anthology`
			`* v2.1.0 - A whole slew of new promo and digital symbols thanks to @fenhl`
Adding Xbox Media Promo symbol from Duels of the Planesalkers on Xbox 2017-02-02 20:41:09 +00:00			`* v2.0.1 - Xbox Media Promo symbol from original Duels of the Planeswalkers on Xbox`
Incrementing the version and recompiling assets after final sass merge 2016-12-14 23:32:23 +00:00			`* v2.0.0 - Keyrune, now with sass! Thanks to @jordanbrauer`
New Amonkhet icon, reconfiguring the readme 2016-12-05 00:43:32 +00:00			`* v1.8.0 - Amonkhet icon added; re-organized Readme with new updates at top`
Adding Kaladesh Inventions icon from the new Masterpiece series 2016-09-29 14:55:35 +00:00			`* v1.7.2 - Added Kaladesh Inventions icon (labeled as MP1)`
New Amonkhet icon, reconfiguring the readme 2016-12-05 00:43:32 +00:00			`* v1.7.1 - Cleaned up icon files to remove any with multiple paths; fixed UNH icon`
			`* v1.7.0 - Lots of new sets! Kaladesh, Aether Revolt, Modern Masters 2017, Planechase Anthology, Commander 2016, and Duel Decks: Nissa v. Ob Nixilis added`
			`* v1.6.2 - Added Legendary Cube icon; unfortunately there's no official set code`
			`* v1.6.1 - Updated EMN with the official high-res source image`
			`* v1.6.0 - Eldritch Moon icon added (based on low-res WOTC graphic)`
			`* v1.5.6 - Added forgotten Salvat 2005 and 2011 (inserts into MTG Encyclopedias)`
			`* v1.5.5 - Duel Deck: Blessed vs. Cursed added`
			`* v1.5.4 - Welcome Deck 2016`
			`* v1.5.3 - FTV: Angels and FTV: Lore`
			`* v1.5.2 - Conspiracy 2: Take the Crown added`
			`* v1.5.1 - Eternal Masters added`
			`* v1.5.0 - Oath of the Gatewatch and Shadows Over Innistrad added`
			`* v1.4.3 - Beginning of white border add-on with .ss-border class; renamed font to Keyrune for desktop`
			`* v1.4.2 - Commander 2015 added`
			`* v1.4.1 - Zendikar Expeditions added`
			`* v1.4.0 - Battle for Zendikar added`
			`* v1.3.1 - Duel Decks: Zendikar v. Eldrazi added`
			`* v1.3.0 - Magic Origins icon added`
			`* v1.2.0 - Cheatsheet added to documentation site; variables changed in LESS files to be Keyrune specific`
			`* v1.1.0 - Woff2 support added; Vintage Masters icon added`
			`* v1.0.2 - Modern Masters 2015 added`
			`* v1.0.1 - Tempest Remastered added (non major set version)`
			`* v1.0.0 - public launch via /r/magicTCG! added Dragons of Tarkir (DTK)`
			`* v0.2.0 - all fonts are fluid width now so they will scale correctly without scaled padding; fixed width class added`
			`* v0.1.0 - initial font creation and CSS/LESS files for all sets up to Fate Reforged`
Updating the Readme 2015-03-15 21:55:24 +00:00
			`## Todo`

Adding Eldritch Moon icon and cleaning up the prefix/outline classes in rarities 2016-06-21 00:43:22 +00:00			`* New [Coming Soon](http://magic.wizards.com/en/game-info/products/coming-soon) product page has symbols but not the necessary higher res versions`
Adding Legendary Cube icon 2016-08-31 17:32:31 +00:00			* Figure out what the Legendary Cube official set code is; currently using `xLCU`