mirror of https://github.com/andrewgioia/keyrune.git synced 2024-11-13 02:44:46 +00:00

Magic: the Gathering set symbol pictographic font https://keyrune.andrewgioia.com

css font icon-font icons magic-the-gathering mtg

Go to file

Andrew Gioia 90a70f8fd2 Merge branch vito-royeca-dev into dev		2024-03-04 11:58:07 -05:00
css	Adds set symbols for Murders at Karlov Manor (MKM), MKM Commander (MKC), and Ravnica: Clue Edition (CLU) (#223 ); adds set symbols for Outlaws of Thunder Junction (OTJ), OTJ Commander (OTC), Breaking News (OTP), The Big Score (BIG), Bloomburrow (BLB), BLB Commander (BLC), Universes Beyond: Assassin's Creed (ACR), Modern Horizons III (MH3), and MH3 Commander (M3C) (#225 ); merges in doc fix for WOE (#224 )	2024-03-03 12:08:41 -05:00
docs	Merges BIG unicode fix in docs by @vito-royeca	2024-03-04 11:57:43 -05:00
fonts	Moves BIG to expansions (#227 ), attempts to fix font embedability	2024-03-04 11:54:25 -05:00
less	Adds set symbols for Murders at Karlov Manor (MKM), MKM Commander (MKC), and Ravnica: Clue Edition (CLU) (#223 ); adds set symbols for Outlaws of Thunder Junction (OTJ), OTJ Commander (OTC), Breaking News (OTP), The Big Score (BIG), Bloomburrow (BLB), BLB Commander (BLC), Universes Beyond: Assassin's Creed (ACR), Modern Horizons III (MH3), and MH3 Commander (M3C) (#225 ); merges in doc fix for WOE (#224 )	2024-03-03 12:08:41 -05:00
sass	Adds set symbols for Murders at Karlov Manor (MKM), MKM Commander (MKC), and Ravnica: Clue Edition (CLU) (#223 ); adds set symbols for Outlaws of Thunder Junction (OTJ), OTJ Commander (OTC), Breaking News (OTP), The Big Score (BIG), Bloomburrow (BLB), BLB Commander (BLC), Universes Beyond: Assassin's Creed (ACR), Modern Horizons III (MH3), and MH3 Commander (M3C) (#225 ); merges in doc fix for WOE (#224 )	2024-03-03 12:08:41 -05:00
svg	Adds set symbols for Murders at Karlov Manor (MKM), MKM Commander (MKC), and Ravnica: Clue Edition (CLU) (#223 ); adds set symbols for Outlaws of Thunder Junction (OTJ), OTJ Commander (OTC), Breaking News (OTP), The Big Score (BIG), Bloomburrow (BLB), BLB Commander (BLC), Universes Beyond: Assassin's Creed (ACR), Modern Horizons III (MH3), and MH3 Commander (M3C) (#225 ); merges in doc fix for WOE (#224 )	2024-03-03 12:08:41 -05:00
.gitignore	Incrementing the version and recompiling assets after final sass merge	2016-12-14 18:32:23 -05:00
bower.json	Moves BIG to expansions (#227 ), attempts to fix font embedability	2024-03-04 11:54:25 -05:00
CHANGELOG.md	Moves BIG to expansions (#227 ), attempts to fix font embedability	2024-03-04 11:54:25 -05:00
index.html	Rename both Innistrads, and put them with the rest of the Standard sets	2021-10-01 22:24:36 +10:00
LICENSE.md	Updating license for non-font files to GPL	2019-10-30 11:29:34 -04:00
package-lock.json	Updates docs to 3.7.1, moves documentation site to directory in master, adds back in the previous placeholder codes for KHM and STX backwards compatibility	2020-12-11 15:53:16 -05:00
package.json	Moves BIG to expansions (#227 ), attempts to fix font embedability	2024-03-04 11:54:25 -05:00
README.md	Version bump for Sass fix (#220 )	2023-11-21 15:14:50 -05:00

README.md

Keyrune v3.13.1

The Magic: the Gathering set symbol font!

Heads up: the documentation page has been moved to keyrune.andrewgioia.com!

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 using the <i class="ss ss-exp"></i> element. Class name codes are based on the expansion codes from MTG JSON.

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>:

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

NEW: you can now include Keyrune via CDN thanks to the amazing jsDelivr project! To 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 format for jsDelivr changed to the above. They still maintain backwards compatibility for everything prior to that but going forward please use the above URL. You no longer need to explicitly include the font-family via @font-face as well, but if you still would like to here is the css ruleset:

@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;
}

Editing the Source

Feel free to edit the source files and compile Keyrune to fit your needs. Both LESS and Sass are supported.

Using Keyrune on the Desktop

To copy Keyrune symbols into your desktop software (or access to vectors directly), go to the Cheatsheet 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 to use, head on over to the documentation page!

License

All set symbol images are trademarks of Wizards of the Coast (http://magicthegathering.com). Please see the LICENSE.md file for a complete description of the licenses that Keyrune is distributed under. Public attribution is greatly appreciated but not required!

Changelog

The Changelog and todo items have been moved to a dedicated file, CHANGELOG.md.