2014-12-22 20:34:57 +00:00
# Style Guide for Equipment Descriptions
2014-12-22 20:28:34 +00:00
To maintain consistency in equipment descriptions, the following guidelines have been proposed (https://github.com/HabitRPG/habitrpg-shared/pull/372):
2014-12-22 20:43:05 +00:00
## Order of elements
2014-12-22 20:34:57 +00:00
1. Description
2. Stat Effect
3. Event/Origin (if needed)
2014-12-22 20:28:34 +00:00
2014-12-22 20:43:05 +00:00
## Stat Effect
2014-12-22 20:42:10 +00:00
* **No bonus:**
2014-12-22 20:34:57 +00:00
"Confers no benefit."
2018-01-11 22:09:31 +00:00
* **Single or all Stat bonus:**
2020-08-11 19:33:24 +00:00
"Increases (Strength/Intelligence/Constitution/Perception/all Stats) by (< %- str %>/< %- int %>/< %- con %>/< %- per %>/< %- attrs %>)."
2018-01-11 22:09:31 +00:00
* **Two Stats, same bonus:**
2020-08-11 19:33:24 +00:00
"Increases (Strength/Intelligence/Constitution) and (Intelligence/Constitution/Perception) by < %- attrs %> each."
2018-01-11 22:09:31 +00:00
* **Two Stats, different bonus:**
2020-08-11 19:33:24 +00:00
"Increases (Strength/Intelligence/Constitution) by (< %- str %>/< %- int %>/< %- con %>) and (Intelligence/Constitution/Perception) by (< %- int %>/< %- con %>/< %- per %>)]."
2014-12-22 20:28:34 +00:00
2014-12-22 20:43:05 +00:00
## Event/Origin
2014-12-22 20:28:34 +00:00
Examples of wording:
2014-12-22 20:42:10 +00:00
* "[Month] [Year] Subscriber Item." (_e.g., "November 2014 Subscriber Item."_)
* "Limited Edition [Year] [Season] Gear." (_e.g., "Limited Edition 2014 Spring Gear."_)