sudoxreboot/habitica
1
0
Fork 0
mirror of https://github.com/sudoxnym/habitica.git synced 2026-08-03 08:21:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Tyler Renelle 2013-08-26 22:33:56 -04:00
parent d29f267425
commit 83a711e796
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -2,24 +2,29 @@ Shared resources useful for the multiple HabitRPG repositories, that way all the
* 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're done and you want to create the dist files
* `grunt` - after you've made modifications and want to compile the dist files for browser
* Node.js
* `require ('coffee-script')`
* `var shared = require('./index.js')` or `require('./script/algos.coffee')` if you only need one file.
* `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 = function (user, task, direction) {}
* `algos.score(user, task, direction)`, etc
* TODO document all the functions
##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.
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