Home Set Icons Examples GitHub Project
Created by Andrew Gioia

### Keyrune is a complete set of scalable vector icons for Magic set symbols. Drop them into your application, website, or custom cards (like this ) and control their size, color, drop shadow, or any dimension just as you would with text!

#### Using Keyrune in your project

Keyrune is CSS and font package you can use in your project to easily display MTG set symbols as font icons. You can download the source and manually include it in your application, or include it via Bower or NPM (project name "keyrune" for both).

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

##### Including Keyrune in your project

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

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

New! You can also now use Keyrune via CDN thanks to the amazing jsDelivr project! Include the latest version, reference:

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

Note: as of v3.1.1 (June 2017) the URL structure at jsDelivr changed to the above. Also, you do not need to explicitly include the font-family via @font-face, but if you still would like to here is the css ruleset:

> <link href="//cdn.jsdelivr.net/npm/keyrune@latest/css/keyrune.min.css" rel="stylesheet" type="text/css" />
> <style type="text/css">
> @font-face {
> font-family: 'Keyrune';
> src: url('//cdn.jsdelivr.net/npm/keyrune@latest/fonts/keyrune.eot');
> src: url('//cdn.jsdelivr.net/npm/keyrune@latest/fonts/keyrune.eot?#iefix') format('embedded-opentype'),
> url('//cdn.jsdelivr.net/npm/keyrune@latest/fonts/keyrune.woff2') format('woff2'),
> url('//cdn.jsdelivr.net/npm/keyrune@latest/fonts/keyrune.woff') format('woff'),
> url('//cdn.jsdelivr.net/npm/keyrune@latest/fonts/keyrune.ttf') format('truetype'),
> url('//cdn.jsdelivr.net/npm/keyrune@latest/fonts/keyrune.svg') format('svg');
> font-weight: normal;
> font-style: normal;
> }
> </style>

##### Creating icons in your project

Insert set symbol icons by using the `.ss` class and then the set code class, such as `.ss-mor` for Morningtide:

> <i class="ss ss-mor"></i>

#### Using Keyrune in desktop software

You can also install Keyrune just like you would with any font, for use in desktop applications like Word, Pages, or Illustrator. This can be useful if you're designing and printing binder covers or set dividers.

Note: For those unfamiliar with CSS projects like this, none of the styling in the documentation will be available when using Keyrune in a desktop app—you have to style everything manually like you would with any other font or "Word Art", for instance.

Follow these steps to work with Keyrune on your desktop:

1. Install the Keyrune font. To do this, click the "Download" button above, unzip the archive that downloads, then navigate to Keyrune-master/fonts. Double click on keyrune.ttf and install it.
2. Open up your desktop application. Check to see that "Keyrune" shows up in your list of available fonts.
3. Go to the Cheatsheet. Copy the symbol that you want to use and then paste it into the application you're using. You should see it show up correctly in there, with the font "Keyrune" active. You can't "type" this font like you would with any other (like Times New Roman), as it uses a reserved character set; you can only copy and paste from the Cheatsheet.
4. Style the symbol however you want. Unfortunately you're going to have to do this manually :( I've created a sample Word document that you can use as a reference with rare Urza's Saga, mythic Morningtide, and uncommon Mercadian Masques symbols as examples. In that doc, each symbol has a 2.5pt black border (on 144pt font) and a gradient applied to each one for their rarities.

Every time new set symbols are added to Keyrune you need to reinstall the keyrune.ttf. If you don't see the updated glyphs, try uninstalling the font first and then installing it.

Feel free to use the font and symbols however you like in your project, subject to the license terms below.

#### Editing the Source

Feel free to edit the source files and compile Keyrune to fit your needs. All SVG glyphs are compiled into font files using the wonderful IcoMoon app. For styling, currently LESS is supported with Sass coming soon.

#### License

Please review the following licenses for each component of Keyrune:

- All set symbol images are copyright Wizards of the Coast (http://magicthegathering.com)
- The Keyrune font is licensed under the the SIL OFL 1.1 (http://scripts.sil.org/OFL)
- Keyrune CSS, LESS, Sass, and other project files are licensed under the GPL 3.0 License at (https://opensource.org/licenses/GPL-3.0)

Attribution is greatly appreciated but not required!