habitica-self-host/README.md

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

You only need to include algos.coffee
It will include the rest as necessary.

Note how to invoke scoring function:
 * algos.score = function (user, task, direction) {}


##Installation
 * Node.js - just include as usual.
 * Browser - use requre.js with "cs" plugin to include files directly into your index.html see require.js-example folder. (run plain http-server from within equire.js-example folder and point your browser to index.html to see how it works)

##CSS
Shared CSS between the website and the mobile app is a fuzzy area. For now we'll have the website define canonical CSS, and share that down the mobile app.

To do so,
 * go to the website repo
 * remove the first line `@import nib/vendor` from index.styl
 * `stylus styles/app/index.styl`
 * copy the output index.css into this shared/css directory
 * remove bootstrap @improrts, find/replace "img/" with "../img/"
update the readme 2013-03-12 21:46:36 +00:00			`Shared resources useful for the multiple HabitRPG repositories, that way all the repositories remain in-sync with common charactaristics. Includes things like:`
			`* Assets - sprites, images, etc`
			`* CSS - especially, esp. sprite-sheet mapping`
			`* Algorithms - level up algorithm, scoring functions, etc`
			`* 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
Requred items.js from algos.coffee We do not need to pass items{} to scoring function anymore. Alogos are still BROKEN. I'm deploying them here for testing. 2013-05-15 13:59:01 +00:00			`You only need to include algos.coffee`
			`It will include the rest as necessary.`

			`Note how to invoke scoring function:`
			`* algos.score = function (user, task, direction) {}`

update the readme 2013-03-12 21:46:36 +00:00
			`##Installation`
Requred items.js from algos.coffee We do not need to pass items{} to scoring function anymore. Alogos are still BROKEN. I'm deploying them here for testing. 2013-05-15 13:59:01 +00:00			`* Node.js - just include as usual.`
Require.js example. Alogos are still BROKEN. I'm deploying them here for testing. 2013-05-15 05:27:17 +00:00			`* Browser - use requre.js with "cs" plugin to include files directly into your index.html see require.js-example folder. (run plain http-server from within equire.js-example folder and point your browser to index.html to see how it works)`
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`
			`Shared CSS between the website and the mobile app is a fuzzy area. For now we'll have the website define canonical CSS, and share that down the mobile app.`

			`To do so,`
			`* go to the website repo`
			* remove the first line `@import nib/vendor` from index.styl
			* `stylus styles/app/index.styl`
modify css to work with mobile img directory 2013-04-10 19:06:44 +00:00			`* copy the output index.css into this shared/css directory`
			`* remove bootstrap @improrts, find/replace "img/" with "../img/"`