From e30ff2eebb6162ad365f82067b95b3f4324c2dbb Mon Sep 17 00:00:00 2001 From: Alice Harris Date: Tue, 23 Dec 2014 06:28:34 +1000 Subject: [PATCH] create style guide for gear/equipment descriptions based on ShilohT's suggestions in https://github.com/HabitRPG/habitrpg-shared/pull/372 --- locales/en/gear_README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 locales/en/gear_README.md diff --git a/locales/en/gear_README.md b/locales/en/gear_README.md new file mode 100644 index 0000000000..81a48213a2 --- /dev/null +++ b/locales/en/gear_README.md @@ -0,0 +1,25 @@ +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 +Examples of wording: +* 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 %>)]. + +Long form: +* Confers no benefit. / Increases (Strength/Intelligence/Constitution/Perception/all attributes) [and (Intelligence/Constitution/Perception)] by (<%= str %>/<%= int %>/<%= con %>/<%= per %>/<%= attrs %>) [each/and (Intelligence/Constitution/Perception) by (<%= int %>/<%= con %>/<%= per %>)]. + +#### Event/Origin: +Examples of wording: +* (Month) (Year) Subscriber Item. +* Limited Edition (Year) (Season) Gear.