Kai/habitica
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update formatting for gear style guidelines

Browse Source
This commit is contained in:
Alice Harris
2014-12-23 06:34:57 +10:00
parent e30ff2eebb
commit 36a552b4a3
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
locales/en/gear_README.md
+11 -10
View File
@@ -1,20 +1,21 @@
# 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)
#### Order of elements
1. Description
2. Stat Effect
3. Event/Origin (if needed)
#### Stat Effect
Examples of wording:
* No bonus:
* Confers no benefit.
"Confers no benefit."
* Single or all stat bonus:
* Increases (Strength/Intelligence/Constitution/Perception/all attributes) by (<%= str %>/<%= int %>/<%= con %>/<%= per %>/<%= attrs %>).
"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 %>)].
"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 %>)].