Difference between revisions of "Template:GearList/doc"

From SpiralKnights

Jump to: navigation, search
m (→‎Level 1: Understanding the Templates: data data data)
m (→‎Level 1: Understanding the Templates: data data data)
Line 26: Line 26:
 
'''General Design''':
 
'''General Design''':
 
----
 
----
−
:Why use icons at all? Text seems easier to code. Spiral Knights is a highly visual game with lots of data, even if that data is simple, there's a lot of it. Icons. Icons everywhere. Icons allow for compressed data too...once someone knows what an icon means, well, the image takes scare of all those words...so tables can be very compressed when using icons.
+
:Why use icons at all? Text seems easier to code. Spiral Knights is a highly visual game with lots of data, even if that data is simple, there's a lot of it. Icons. Icons everywhere. Icons allow for compressed data too...once a person knows what an icon means, well, the image takes scare of all those words...so tables can be very compressed when using icons.
  
 
:Icons are derived from in-game icons, usually colored [[arsenal]] icons. The simplistic, familiar shapes allow easy scanning of a large table. The simplistic color meanings remain consistent in different column groups, further facilitating visual cues. Amusingly, the arsenal icons are usually divided into enough distinct smaller "shapes" to allow very clear coloring of various well-known abilities, such as "charge time reduction" and so on.  
 
:Icons are derived from in-game icons, usually colored [[arsenal]] icons. The simplistic, familiar shapes allow easy scanning of a large table. The simplistic color meanings remain consistent in different column groups, further facilitating visual cues. Amusingly, the arsenal icons are usually divided into enough distinct smaller "shapes" to allow very clear coloring of various well-known abilities, such as "charge time reduction" and so on.  
Line 48: Line 48:
  
 
===============================-->
 
===============================-->
−
'''Why Color the ABILITY column icons with these colors?'''
+
'''The Colors'''
 
----
 
----
−
:Yellow = Charge Time. Yellow is the color your knight gets when fully charged, and perks follow this too...It is the most central thing of most combat, I think. Center center center...self and soul. Glowing light. Focus. And whaddaya know, perks use the word "Focus" to mean CTR too. Dat logic.
+
:Blue...Orange...Purple...Red...Yellow...What do they mean for abilities? For defenses? Offenses? What about status? It's important to keep groups completely separate in your head. Yellow means one thing for defenses (piercing) but another for abilities ([[Charge attack|charge time]]), AND YET ANOTHER FOR STATUS ([[Stun|stun]]). And in-game yellow has even more meanings too, battle sprite and [[mineral]] behavior...anyway, you must keep these three categories separate and distinct in your mind when using the tables:
−
::Relevant "Real" Images:
+
−
:::Icons: [[File:Bomb Focus.png|36px]], [[File:Handgun Focus.png|36px]], [[File:Sword Focus.png|36px]]  
+
−
:::Gameplay: [[File:Charge attack.png|100px]]
+
  
 +
:-Defenses
 +
:-Status
 +
:-Abilities
  
−
:Red = DMG = threat = be obvious. DMG buffs are red, your knight gets red rings when dmg is buffed...perks follow this behavior, but it's more firey yellowy/orangey/reddish than RED red. Anyway... DMG power is influenced by how the knight enforces their actions. What part of an item enables a knight to...play the game really? - so it is usually a large area on the outside of the item, or the part that does the pewpew or the boom boom or the slash slash.
+
'''Why Color the ABILITY column icons with these colors?'''
−
::Relevant "Real" Images:
+
−
:::Icons: [[File:Item-Attack Booster.png|36px]]
+
−
:::Gameplay: [[File:Attack booster rings.png|100px]]
+
−
 
+
  
−
:Blue = Attack Speed. Perks use blue to indicate speed in general (MS and AS). I figure fighting with "perfect speed" takes some smarts and finesse, so it's closer to the inside, but not as central as CTR since it's used more often and doesn't require as much focus. For weapons, put it on the part that determines AS the most. Handles, or how the weapon is held and used, basically. You can have a fatty hold a thin light sword incorrectly, they'll be as slow with it as they would with a broadsword.
+
:Blue = Attack Speed. Perks use blue to indicate speed in general (MS and AS).  
 
:::Icons: [[File:Quick Draw.png|36px]], [[File:Quick Strike.png|36px]]
 
:::Icons: [[File:Quick Draw.png|36px]], [[File:Quick Strike.png|36px]]
  
Line 69: Line 65:
 
:::Icons: [[File:Item-Speed Booster.png|36px]]
 
:::Icons: [[File:Item-Speed Booster.png|36px]]
 
:::Gameplay: [[File:Speed booster tails.png|100px]]
 
:::Gameplay: [[File:Speed booster tails.png|100px]]
 +
 +
 +
:Red = DMG = threat = be obvious. DMG buffs are red, your knight gets red rings when dmg is buffed...perks follow this behavior, but it's more firey yellowy/orangey/reddish than RED red. Anyway... DMG power is influenced by how the knight enforces their actions. What part of an item enables a knight to...play the game really? - so it is usually a large area on the outside of the item, or the part that does the pewpew or the boom boom or the slash slash.
 +
::Relevant "Real" Images:
 +
:::Icons: [[File:Item-Attack Booster.png|36px]]
 +
:::Gameplay: [[File:Attack booster rings.png|100px]]
 +
 +
 +
:Yellow = Charge Time. Yellow is the color your knight gets when fully charged, and perks follow this too...It is the most central thing of most combat, I think. Center center center...self and soul. Glowing light. Focus. And whaddaya know, perks use the word "Focus" to mean CTR too. Dat logic.
 +
::Relevant "Real" Images:
 +
:::Icons: [[File:Bomb Focus.png|36px]], [[File:Handgun Focus.png|36px]], [[File:Sword Focus.png|36px]]
 +
:::Gameplay: [[File:Charge attack.png|100px]]
  
  
Line 106: Line 114:
 
:Red = DMG is influenced by how the knight enforces their actions. what part of an item enables a knight to...play the game really? - so it is usually a large area on the outside of the item. There are two things that matter the most to the general community in sk - how sexy you are, and how much damage you can deal. Another reason large icon parts are red.
 
:Red = DMG is influenced by how the knight enforces their actions. what part of an item enables a knight to...play the game really? - so it is usually a large area on the outside of the item. There are two things that matter the most to the general community in sk - how sexy you are, and how much damage you can deal. Another reason large icon parts are red.
  
−
:Yellow = CTR...
+
:Yellow = CT...picked central things. Eyes. Heart. Etc.
−
 
+
−
:Orange = MSI. Picked things on the extremities - aerodynamics like curves and fins and such. You also moves your arms (shoulder area) a lot when you run.
+
−
 
+
−
 
+
  
 +
:Orange = MS. Picked things on the extremities - aerodynamics like curves and fins and such. You also moves your arms (shoulder area) a lot when you run.
  
 
}}
 
}}

Revision as of 00:35, 22 December 2014

Usage

To organize combat items for searching, comparison, and general knowledge. This template is part of a large system of templates - so read this documentation carefully before making changes. There is a template for Armor, Helmets, Shields, Trinkets, Bombs, Handguns, and Swords. These are all related to each other with icon symbolism, several #switch templates, and header-sortable table behavior. I consider the total usage (using and editing) difficulty of this "template system" to be in three levels - the first being the easiest, and the last being the "hardest" in that it is "risky" and can "break" the system. But an editor should be able to use this template and change it easily after reading this documentation. I hope. Grab some popcorn and settle in, because it's a big read!



Level 1: Understanding the Templates

The following Note is on every page that uses one of these lists (implemented by placing {{Note-GearList}} in the page code). It explains the general behavior of the template for users who may be unfamiliar with it:

The following logic explanations describe icons, their inspiration, and how they are designed.





Level 2: Populating the Templates

The game has suddenly updated with new armor items, or something. We need to add them to the appropriate list. Here's what the values mean, and where they should go:





Level 3: Updating the Templates with New Values

The game has suddenly updated with new helmet items, or something. They have stat values and intensity levels of abilities that we've never seen before. Here's how to get them into the template smoothly, so they can be sorted in with the older items:





See Also

Forum Node 105837 contains feedback and other user contributions for this enormous project. Thank you all for your time and effort.

Example GearList Image GearList Images - all images used in this template system except for actual icons of gear items. Not all images in this category are being used at the moment - some of them are "in preparation for potential future things" or "options."

Retrieved from "https://wiki.spiralknights.com/index.php?title=Template:GearList/doc&oldid=181990"
Personal tools