andrew/keyrune
andrew/keyrune
1
0
Fork 0
mirror of https://github.com/andrewgioia/keyrune.git synced 2024-12-22 15:39:56 +00:00
Code Issues Projects Releases Wiki Activity

New section on using Keyrune in desktop applications

Browse Source
This commit is contained in:
Andrew Gioia 2017-03-10 10:17:52 -05:00
parent bd674b54af
commit 2071f701d3
2 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
css/main.css
View File

@ -93,6 +93,10 @@ li {
margin: 0 0 10px;
}
ol li {
line-height: 1.6em;
}
h1 {
color: #444;
margin: 0;

16
index.html
View File

@ -56,7 +56,8 @@
<h3><strong>Keyrune is a complete set of scalable vector icons for Magic set symbols.</strong> Drop them into your application, website, or custom cards (like this <i class="ss ss-tmp"></i>) and control their size, color, drop shadow, or any dimension just as you would with text!</h3>
</section>
<section class="content">
<h4>Using Keyrune</h4>
<h4>Using Keyrune in your project</h4>
<p>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 Composer (project name "keyrune" for both).</p>
<p>Each set symbol has its own font character. Display them in a manner similar to <a href="http://fontawesome.io">Font Awesome</a> using the <code>&lt;i class="ss ss-exp"&gt;&lt;/i&gt;</code> element. Class name codes are based on the expansion codes from <a href="http://mtgjson.com">MTG JSON</a>.</p>
<p>To use Keyrune, move the font files to your /fonts directory and include the <code>keyrune.css</code> stylesheet in your <code>&lt;head&gt;</code>:</p>
<blockquote>
@ -67,6 +68,19 @@
&lt;<span class="e">i</span> <span class="a">class</span>=<span class="v">"ss ss-mor"</span>&gt;&lt;/<span class="e">i</span>&gt;
</blockquote>
</section>
<section class="content">
<h4>Using Keyrune in desktop software</h4>
<p>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.</p>
<p<strong>Note:</strong>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&mdash;you have to style everything manually like you would with any other font or "Word Art", for instance.</p>
<p>Follow these steps to work with Keyrune on your desktop:</p>
<ol>
<li><strong>Install the Keyrune font.</strong> To do this, click the "Download" button above, unzip the archive that downloads, then navigate to Keyrune-master/fonts. Double click on <strong>keyrune.ttf</strong> and install it.</li>
<li><strong>Open up your desktop application.</strong> Check to see that "Keyrune" shows up in your list of available fonts.</li>
<li><strong>Go to the <a href="cheatsheet.html">Cheatsheet</a>.</strong> 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.</li>
<li><strong>Style the symbol however you want.</strong> Unfortunately you're going to have to do this manually :( I've created a <a href="https://www.dropbox.com/s/gp45uuuejfy089n/Keyrune_desktop_example.docx?dl=1">sample Word document</a> 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.</li>
</ol>
<p>Feel free to use the font and symbols however you like in your project, subject to the license terms below.</p>
</section>
<section class="content">
<h4>Editing the Source</h4>
<p>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 <a href="http://icomoon.io">IcoMoon</a> app. For styling, currently LESS is supported with Sass coming soon.</p>