RPG Awesome

Icon generation is handled in a separate repository: nagoshiashumari/rpg-awesome-raw.

To add a new icon to this project:

1. Add the icon to the rpg-awesome-raw repository first.
2. Follow the generation steps in that repository to create .eot, .svg, .ttf, and .woff files.
3. Update scss/_variables.scss in this repository with the new icon offsets.
4. Update the gh-pages branch to include the new icon in the web documentation.

After installation, you can include the toolkit in your project by referencing the compiled CSS or importing the SCSS files.

CSS Reference

If you are linking directly to the CSS file, use the path to the minified file: ./node_modules/rpg-awesome/css/rpg-awesome.min.css

Sass/SCSS Import

If you are using Sass, you can import the source files directly into your stylesheet:

@import "node_modules/rpg-awesome/scss/rpg-awesome";

To develop on this project, you need NPM, Grunt, and Ruby installed. The project uses Grunt to compile SCSS into browser-usable CSS. Run the following commands to install dependencies and compile the assets:

1. Install NPM dependencies.
2. Update Ruby gems and install scss-lint.
3. Run Grunt to compile.

npm install
gem update --system && gem install scss-lint
grant

You can install the RPG Awesome toolkit using your preferred package manager:

• Bower: bower install rpg-awesome
• NPM: npm add --save rpg-awesome
• Meteor: meteor add rpg-awesome