habitica/README.md

[![Build Status](https://travis-ci.org/HabitRPG/habitrpg-shared.png?branch=master)](https://travis-ci.org/HabitRPG/habitrpg-shared)

Shared resources useful for the multiple HabitRPG repositories, that way all the repositories remain in-sync with common characteristics. Includes things like:
 * Assets - sprites, images, etc
 * CSS - especially, esp. sprite-sheet mapping
 * Algorithms - level up algorithm, scoring functions, etc
 * View helper functions that may come in handy for multiple client MVCs
 * Item definitions - weapons, armor, pets 

##Installation
* `npm install`
* `grunt` - after you've made modifications and want to compile the dist files for browser

* Node.js
    * `require ('coffee-script')`
    * `require('./script/algos.coffee')`, `require('./script/helpers.coffee')`, etc.
* Browser
    * Use `<script/>` tag to include ./dist/habitrpg-shared.js it will export `window.habitrpgShared` object.
    * // Use `browser.debug.js' if you want to have sourcemaps. - EDIT: Only one file now, and it has sourcemaps. Fix this

* Note how to invoke scoring function:
  * `algos.score(user, task, direction)`, etc
  * TODO document all the functions

##Tests
* `npm install`

##CSS
Shared CSS between the website and the mobile app is a fuzzy area. Spritesheets definitely go in habitrpg-shared (since mobile
uses them too). Other things, like customizer buttons, *may* want to go here? As you find sharable components, (1) move them
from the website into habitrpg-shared, (2) remove from website & make sure all html/css references are updated.

Currently, all or most spritesheets are available. They're in css/*.css, but that's not what you want. You want `/spritesheets.css`
which is the concat'd file (using `grunt`) which includes all the spritesheets. I'd prefer this be in /dist/spritesheets.css
for consistency, but it's having image referencing weirdness
add travis build status to readme 2013-11-10 01:30:24 +00:00			`[![Build Status](https://travis-ci.org/HabitRPG/habitrpg-shared.png?branch=master)](https://travis-ci.org/HabitRPG/habitrpg-shared)`

move browserify step to Grunt instead of Make (for consistency). Build files now in dist/ as dist/habitrpg-shared.js & dist/spritesheets.css 2013-08-27 01:54:08 +00:00			`Shared resources useful for the multiple HabitRPG repositories, that way all the repositories remain in-sync with common characteristics. Includes things like:`
update the readme 2013-03-12 21:46:36 +00:00			`* Assets - sprites, images, etc`
			`* CSS - especially, esp. sprite-sheet mapping`
			`* Algorithms - level up algorithm, scoring functions, etc`
update readme 2013-08-27 02:33:56 +00:00			`* View helper functions that may come in handy for multiple client MVCs`
readme.fix Alogos are still BROKEN. I'm deploying them here for testing. 2013-05-15 14:08:35 +00:00			`* Item definitions - weapons, armor, pets`
reverting back to commonjs format, using browserify to compile index-browser.js which will load into window.habitrpgShared. Not the best method, we'll move to requirejs (r.js?) later 2013-03-12 21:41:32 +00:00
update the readme 2013-03-12 21:46:36 +00:00			`##Installation`
move browserify step to Grunt instead of Make (for consistency). Build files now in dist/ as dist/habitrpg-shared.js & dist/spritesheets.css 2013-08-27 01:54:08 +00:00			* `npm install`
update readme 2013-08-27 02:33:56 +00:00			* `grunt` - after you've made modifications and want to compile the dist files for browser
CS all the way! 2013-05-17 02:30:19 +00:00
			`* Node.js`
Coffeeify plugin for browserify to compile .coffee into browser.js. 2013-05-24 05:29:04 +00:00			* `require ('coffee-script')`
update readme 2013-08-27 02:33:56 +00:00			* `require('./script/algos.coffee')`, `require('./script/helpers.coffee')`, etc.
Coffeeify plugin for browserify to compile .coffee into browser.js. 2013-05-24 05:29:04 +00:00			`* Browser`
move browserify step to Grunt instead of Make (for consistency). Build files now in dist/ as dist/habitrpg-shared.js & dist/spritesheets.css 2013-08-27 01:54:08 +00:00			* Use `<script/>` tag to include ./dist/habitrpg-shared.js it will export `window.habitrpgShared` object.
			* // Use `browser.debug.js' if you want to have sourcemaps. - EDIT: Only one file now, and it has sourcemaps. Fix this
Coffeeify plugin for browserify to compile .coffee into browser.js. 2013-05-24 05:29:04 +00:00
readme.fix Alogos are still BROKEN. I'm deploying them here for testing. 2013-05-15 14:08:35 +00:00			`* Note how to invoke scoring function:`
update readme 2013-08-27 02:33:56 +00:00			* `algos.score(user, task, direction)`, etc
			`* TODO document all the functions`
add in temp compiled stylus css, full index.css from the website (we need to come up with something better) 2013-04-10 19:00:40 +00:00
show how to run tests in readme 2013-11-01 01:07:19 +00:00			`##Tests`
			* `npm install`

add in temp compiled stylus css, full index.css from the website (we need to come up with something better) 2013-04-10 19:00:40 +00:00			`##CSS`
move browserify step to Grunt instead of Make (for consistency). Build files now in dist/ as dist/habitrpg-shared.js & dist/spritesheets.css 2013-08-27 01:54:08 +00:00			`Shared CSS between the website and the mobile app is a fuzzy area. Spritesheets definitely go in habitrpg-shared (since mobile`
			`uses them too). Other things, like customizer buttons, may want to go here? As you find sharable components, (1) move them`
update readme 2013-08-27 02:33:56 +00:00			`from the website into habitrpg-shared, (2) remove from website & make sure all html/css references are updated.`

			Currently, all or most spritesheets are available. They're in css/*.css, but that's not what you want. You want `/spritesheets.css`
			which is the concat'd file (using `grunt`) which includes all the spritesheets. I'd prefer this be in /dist/spritesheets.css
			`for consistency, but it's having image referencing weirdness`