Added readme with packages used and links to their docs

This commit is contained in:
Thaum
2014-11-16 10:27:05 +00:00
parent e2a812cc63
commit c1f96bd4a7
2 changed files with 29 additions and 34 deletions

34
TODO.md
View File

@@ -1,34 +0,0 @@
sxissues
------
Characters attributes and buffs
-------------------------------
Characters currently have attributes and skills that can take bonuses and multipliers.
When a feature is activated or enabled on a characer or a piece of equipment is equipped
the buffs and effects should be applied to the correct attribute or skill. When the
equipment or feature is removed or deactivated, the effects should be removed as well.
Effects need the following data as a bare minimum:
* attribute or skill to effect
* name
* value
For example, plate would be an object like this:
{
name: "Plate Armor" ,
effects: [
{stat: "skills.dexArmor.min", value: 0},
{stat: "skills.dexArmor.max", value: 0},
{stat: "attributes.armor.min", value: 18},
{stat: "skills.stealth.disadvantage", value 1} //disadvantage doesn't need a value
]
}
See Conditions for this implemented.
The effects ultimately need to be pushed to the correct array when applied: `attributes.armor.min.push({name: "Plate Armor", type: "Equpiment", value: 18})`
They will also need to be removed correctly by the thing that applied them, or after some time.

29
rpg-docs/readme.md Normal file
View File

@@ -0,0 +1,29 @@
Packages used
=============
* meteor-platform
Base Meteor. [Docs](http://docs.meteor.com/#/full/)
* autopublish
Publishes everything to the client. Must be removed before release
* insecure
Allows the client the freedom to modify any colleciton. Must be removed before release
* iron:router
Enables pagination and URL's to direct to specific templates. [Tutorial](http://www.manuel-schoebel.com/blog/iron-router-tutorial)
* accounts-password
Lets users create accounts with a simple password
* accounts-ui
Adds simple UI for logging in
* random
Somewhat decent cryptographically strong psuedo random number generation. [readme](https://atmospherejs.com/meteor/random)
* dburles:collection-helpers
Adds template-style helpers to collections. [github page](https://github.com/dburles/meteor-collection-helpers)
* reactive-var
Friendly reactive variables [Meteor Docs](http://docs.meteor.com/#/full/reactivevar_pkg)
* cw4gn3r:jquery-event-drag
Adds jquery drag events
* underscore
Handy javascript utilities [Docs](http://underscorejs.org/)
* aldeed:collection2
Extends collections with Schemas [(gitHub page)](https://github.com/aldeed/meteor-collection2) using [SimpleSchema](https://github.com/aldeed/meteor-simple-schema)
* aldeed:autoform
Automatically generates bootstrap forms for collection2 Schemas. [github](https://github.com/aldeed/meteor-autoform)