Changes between Version 61 and Version 62 of EnglishStyleGuide

Timestamp:

Aug 26, 2019, 9:00:19 AM (5 years ago)

Author:

Nescio

Comment:

Separate tooltip sections

EnglishStyleGuide

@@ -202 +202 @@
 
 
-== Phrasing
+== Tooltips
+In general, start with a capital, end each statement with a full stop, and capitalize classes.
+
+=== Auras
+Auras are JSON files located inside `simulation/data/auras/`.
 
 Use a standarized phrasing in the following contexts:
@@ -208 +212 @@
 ||='''context'''=||='''phrasing'''=||='''examples'''=||
 ||Aura description||[class] [change] [attributes] ([requirements])||Garrisoned Siege Engines +3 health regeneration rate.[[br]]Structures −10% technology resource costs and research time.[[br]]Garrisoned Soldiers +3 armor and +20 vision range.[[br]]+40 maximum population limit (requires the “Glorious Expansion” technology).||
-||Civilization bonus tooltip||[class] [change] [attributes]||Carthaginian Walls +100% build time, +100% stone cost, and +200% health.[[br]]Briton and Gaulish Structures −20% build time, −20% health, and −20% capture points.||
 ||Hero aura description||[class] [change] [attributes]||Workers +15% build rate.[[br]]Temples −25% stone cost and +2 garrison heal rate.[[br]]Soldiers in his formation +3 armor and +15% movement speed.[[br]]Ship he is garrisoned in −30% batch training time and +50% movement speed.[[br]]Champions +2.0 capture attack strength, +20% melee and ranged attack damage, and +10% movement speed.[[br]]Temple of Amun +20% resource costs and build time; Amun Guards +20% resource costs and training time.||
-||Technology tooltip||[class] [change] [attributes]||Siege Engines +2 hack armor.[[br]]Siege Engines −20% metal cost.[[br]]Siege Engines −25% pack and unpack time.||
+
+=== Technologies
+Technologies are JSON files located inside `simulation/data/technologies/`. All technologies are global and irreversible. Please follow the **"[player] [class] [change] [attributes]"** format, e.g.:
+
+`       "tooltip": "Siege Engines +2 hack armor.",` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/data/technologies/siege_armor.json siege armor])
+
+=== Templates
+Entity templates are XML files located inside `simulation/templates/`. They can have a <Tooltip> string inside the <Identity> node, to summarize what makes them unique. Be brief and precise. A few examples:
+* Resource supplier: `<Tooltip>Catch fish for food.</Tooltip>` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/templates/template_gaia_fish.xml fish])
+* Structures: `<Tooltip>Construct Siege Engines and research Siege Engine technologies.</Tooltip>` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/templates/template_structure_military_workshop.xml workshop])
+* Units: `<Tooltip>Garrison units for transport and to increase firepower.</Tooltip>` ([https://trac.wildfiregames.com/browser/ps/trunk/binaries/data/mods/public/simulation/templates/template_unit_siege_tower.xml siege tower])