Difference between revisions of "Template:GearList/doc"

From SpiralKnights

Jump to: navigation, search
m (→‎See Also)
m (→‎Level 1: Understanding the Templates: icon data prep)
Line 19: Line 19:
  
 
The following logic explanations describe icons, their inspiration, and how they are designed.
 
The following logic explanations describe icons, their inspiration, and how they are designed.
−
{{Showhide|Icons|content= icon blahblah NOVA REMEMBER TO GET IT OUT OF YOUR SANDBOX }}
+
{{Showhide|Icons|content=
 +
:See the [[:Category:GearList images|GearList Images Category]] to keep track of these icons, and use them in the future as needed. I've uploaded potential icons too, for abils that don't exist yet. There are also other "options" in this category. Thus not every image in this category is being used.
 +
 
 +
:[http://forums.spiralknights.com/en/node/105837?page=1#comment-967452 Forum Node 105837 Comment #93] is the main part of the GearList Feedback thread where we discuss simple colored icons.
 +
 
 +
'''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.
 +
 
 +
: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.
 +
::[[Perk]]s and "[[Consumables#Ability Boosters|Ability Booster]]s" have heavily influenced the color symbolism in these columns.
 +
 
 +
:Low/Med/High/VH values etc. Have no bearing on an icon's design, just know that these variables can be changed in the tooltip as needed. An icon is merely an indicator, the tooltip serves to clarify things for new users (and provide details for new and old users) about intensity levels.
 +
 
 +
'''Why name the icons this way?'''
 +
----
 +
:Ability order follows the order of tooltip popupinfo (top to bottom) in-game.
 +
:Other parts of the name attempt to follow consistency so they can be found easily on the wiki and used easily in tables.
 +
<!--===============================
 +
 
 +
 
 +
 
 +
 
 +
Coloring Icons
 +
 
 +
 
 +
 
 +
 
 +
===============================-->
 +
'''Why Color the ABILITY column icons with these 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.
 +
:::Relevant "Real" Icons:
 +
::::[[File:Sword Focus.png|36px]]
 +
 
 +
 
 +
: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.
 +
 
 +
 
 +
: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.
 +
 
 +
 
 +
:Orange = Movement Speed. This matches the color you get when you're MSI is boosted (orange thrashing vapor tendril things). It's also the color of the runner guy in the MS icon itself, whether it's a buff or a debuff. Perks don't follow this color...they just use blue for speed in general I guess.
 +
 
 +
'''Why color Weapon (HANDGUN) icons this way?'''
 +
:Blue = AS = on handle for attack speed (the perfect gun's limit is how fast you click = pull trigger)
 +
 
 +
:Red = DMG = on the barrel for attack. Barrel gets this color because it's the most aggressive-looking part of a gun. I mean people write songs about staring down the barrel of a gun, and you see it in televised entertainment quite frequently...you get my point.
 +
 
 +
:Yellow = CT = on the last remaining bit for charging up. Makes sense too, where's that energy gonna balance itself with your knight's focus anyway? Backing up the attack of course! Yellow would work on handle, for sure, but then blue wouldn't make sense anywhere else to me. Maybe barrel...naw. That's too realistic for game logic. I mean barrel even influences range and spread and *rambles on.*
 +
<!--===============================
 +
 
 +
 
 +
 
 +
 
 +
Coloring Icons/Armor Abils
 +
 
 +
 
 +
 
 +
 
 +
===============================-->
 +
'''Why color Armor (UNIFORM BONUSES) icons this way?'''
 +
 
 +
:Blue = I figure this takes some smarts and finesse, so it's closer to the inside of a knight than the outside, but not as central as CTR since it's used more often (and therefore more "outside" and doesn't require as much focus.
 +
 
 +
: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...
 +
 
 +
: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.
 +
 
 +
 
 +
 
 +
 
 +
}}
 
<br/><br/><br/><br/>
 
<br/><br/><br/><br/>
 
<!--===============================
 
<!--===============================
Line 32: Line 106:
  
 
===============================-->
 
===============================-->
 +
 
===Level 2: Populating the Templates===
 
===Level 2: Populating the Templates===
 
----
 
----

Revision as of 00:14, 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=181986"
Personal tools