habitica/website/common/locales/en/gear_README.md
Blade Barringer 81b7eeeb71 Common reorg (#8025)
* Re-organize common folder

* fix: Correct paths in tests

* fix: move new content to proper folder

* chore: Move audio folder to assets

* Move sprites to sprites assets directory

* Move css sprites to assets directory

* Split out readmes for common code and sprites

* Move images to assets directory

* Move destinatin of shared browserified file

* remove unused file

* move compiled js to client-old

* Fix karma tests

* fix: Correct paths for sprites
2016-09-16 17:18:07 +02:00

1 KiB

Style Guide for Equipment Descriptions

To maintain consistency in equipment descriptions, the following guidelines have been proposed (https://github.com/HabitRPG/habitrpg-shared/pull/372):

Order of elements

  1. Description
  2. Stat Effect
  3. Event/Origin (if needed)

Stat Effect

  • No bonus: "Confers no benefit."
  • Single or all stat bonus: "Increases (Strength/Intelligence/Constitution/Perception/all attributes) by (<%= str %>/<%= int %>/<%= con %>/<%= per %>/<%= attrs %>)."
  • Two stats, same bonus: "Increases (Strength/Intelligence/Constitution) and (Intelligence/Constitution/Perception) by <%= attrs %> each."
  • Two stats, different bonus: "Increases (Strength/Intelligence/Constitution) by (<%= str %>/<%= int %>/<%= con %>) and (Intelligence/Constitution/Perception) by (<%= int %>/<%= con %>/<%= per %>)]."

Event/Origin

Examples of wording:

  • "[Month] [Year] Subscriber Item." (e.g., "November 2014 Subscriber Item.")
  • "Limited Edition [Year] [Season] Gear." (e.g., "Limited Edition 2014 Spring Gear.")