Difference between revisions of "Template:GearList/doc"

Revision as of 08:44, 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:

Note

This page is a candidate for speedy deletion.

If you disagree with its speedy deletion, please explain why at Category talk:Candidates for speedy deletion or improve the page and remove the {{delete}} tag.

Remember to check what links here and the the page history before deleting. Editors should also consider external sources, such as the Spiral Knights Forums, that might link here. Consider redirecting instead of deletion if possible.

Only Admins can permanently delete wiki articles. Content associated with or replaced by this deletion notice can be accessed via this page's "history" tab until the page is fully deleted.

- obsolete

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

Icons

See the 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.

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 a person knows what an icon means, well, the image takes scare of all those words...and tooltips can be used...yeah, 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 GearLists, further facilitating visual cues. Amusingly, most of 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.

Perks and "Ability Boosters" 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. For a while, I wanted to scale icons to intensity, but this was generally voted out in the feedback thread.

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.

Why shape the icons this way?

Decided do "square = good" and "circle=bad" regarding these gearlists. While this is not always the case in-game, I feel like for the table, a clear shape difference really helps quick scanning. Chose square because perks. Could be any shape really. Also squares and circles are easy to work with.

The Colors

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 time), AND YET ANOTHER FOR STATUS (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:

-Damage Type (defenses and offenses)

-Status

-Abilities

DEFENSES and OFFENSES - why color these icons this way?

Simply colored the entire arsenal icon for an item to match its in-game color in stats images.

Example (armor): - that red and yellow shield? Normal and yellow defenses.

Example (sword): - that red and green sword? Normal and elemental offenses.

But I didn't like that a sword is also used in stats images - a bomb is a bomb, not a sword! Same with shields and armor items. So I came up with this option:

Defenses:

Helmets:

, , ,

Armor:

, , ,

Shields:

, , ,

Offenses:

Bombs:

, , ,

Handguns:

, , ,

Swords:

,

STATUS - why color these icons this way?

Simply colored the icons used in defenses like the status, following the color pattern - one on top, one as background. Like fire has bright orange on top and dark orange-red in the back. Resistances and Weaknesses follow the same color patterns, but weaknesses are in a circle with a down arrow to distinguish them.

You can see these in action at: Armor/5 Star.

ABILITIES - why color these icons this way?

Blue = Attack Speed. Perks use blue to indicate speed in general (MS and AS).

Relevant "Real" Images:

Icons:

,

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.

Relevant "Real" Images:

Icons:

Gameplay:

- orange thrashing tails = movement speed boost.

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:

Gameplay:

- red rings around the knight = damage boost.

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:

,

Gameplay:

Not all the perks in the game are consistently colored, nor are items and behaviors. The "Swiftstrike Buckler" is yellow...you'd think it would be blue based on its ability. Ah well. You'd think swift steps would be orange, not blue. But Spiral Knights is a dynamic game, sort of like the real world - there are rules, and then these rules are broken. In the meantime, we try to make sense of it all.

Why color Armor, Helmet, and Shield "UNIFORM BONUS" and "ITEM BONUS" icons this way?

, , ,

, , , and so on...

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? Important stuff - 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 = Charge Time...picked central things. Eyes. Heart. Etc.

Orange = Movement Speed...Picked things on the extremities - aerodynamics like curves and fins and such. You also moves your arms (shoulder area) a lot when you run.

Whitish areas = ability not affected

Note: mouseover the icons to see what items the abilities could pertain to. There are many items in the game that have the same abilities with different defenses and so on, these are just examples. Though some abilities (when considering intensity level too) are rare...even unique...

, , and so on...

Blue = Attack Speed = well bombs have a detonation speed, and I imagine the ticker/fuse is on the top. Though this isn't really going to be used due to the available UVs/perks not having bomb AS...it still makes sense!

Red = DMG = on the body. Boom boom, that's what we like right?

Yellow = Charge Time = Where's that energy gonna balance itself with your knight's focus anyway? Backing up the attack of course!

Whitish areas = ability not affected

, , and so on...

Blue = Attack Speed = 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 = Charge Time = 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.*

Whitish areas = ability not affected

, , and so on...

Blue = Attack Speed = sword's not gonna move if you don't hold it, and other colors make more sense in other places.

Red = DMG = on the blade.

Yellow = Charge Time = 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.

Whitish areas = ability not affected

Now how to do status, like Fang of Vog? Well! Just color the sword icon like the fire icon, using the same logic as the DEFENSE and OFFENSE icons above.

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:

Parameters

blahblah nowiki blahblah parameters

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:

Adding Values: ListAbilities (Armor, Helmet, Shield)

A fundamental thing to remember: tables sort the lowest numerical value to the top first. I've looked, and as far as I can tell, there's not a simple way to just reverse it without internal span stuff. But we are using icons - which actually makes this easier!

To permit flexibility in a changing game, the template is designed to sort via numbers while showing icons. These numbers seem to be "huge" numbers...do they signify damage or resistance values in-game? Nay! They are a system of placeholder values so that new values (which could show up with a game update, and have before many times) can be added without disrupting an entire numerically sorted column. This also saves a small amount of space in the templates that use them, at least until we see every possible intensity level of ability type and combination. These "placeholder" numbers have no numerical value in relation to combat statistics in-game.

Italicized things are just examples of future slots that can be filled with this placeholder system.

For the number placeholder "##.#####" each column in the table below corresponds to a digit in this "big number," left to right:

1) Use 0 for a placeholder if the field doesn't apply at all to the relevant item. This allows the "ability types" to sort together better if they're in a single column.

These interrelated "placeholder values" might seem redundant when it comes to certain placeholder values, but in a world where templates are dynamic, we want to keep the possibility of merging columns and templates together as time goes on. This number sorting system permits some flexibility for these changes - meaning that the data entries can stay the same while editors change the display. although such a change would likely require changes to the list entry, which would be quite disruptive as time goes on and I wouldn't recommend it.

2) We just use 7 and 9 for the buffs/debuffs because they are very different values, easy to see when working with large amounts of data that just blurs together after a while...using negative and positive abilities royally screws up a sortable table if you want to keep the intensities in the same order for both buffs and debuffs, at least when the table is set up like this. 7 is less than 9, so it's a "positive" ability and sorts to the top first...so above 9, so, above negative abilities (negative abilities are penalties).

8 is just a blankspace separator, so that negative and positive abilities are clearly separated in the table, with any armor items that don't have abilities of any kind between items that have bonuses and penalties. This only applies to a table that has a single column for all abilities, and has a bad effect on a table with multiple ability columns. Currently, with a multi-column table, |=<span style="display: none;">9999</span> is in place ... 9999 is being used instead of 8. So change the 99999 value to 800.0000 if using a single column. Which I don't recommend but yeah, I like being flexible!

3) Keep in mind that negative and positive levels of intensity are determined earlier in the placeholder sequence, with 1 or 9 in the first column, so keep using 1-6 for intensity, no matter if they are penalties or bonuses :D

4) For health, intensity is a bit weird, just calibrate the "low-max" values to existing HP-unusual items and make sure the tooltip is clear and succinct.

5) For monster bonuses that have a limitation to an item type (like only handguns get a bonus and such), ignore the first weapon value placeholder, make it 0, and only use the slot near the end, labelled "Ability C Subclass: Monster Specific Item."

6) For double or triple or even more abilities of the same type, the other columns lose some sorting integrity. To keep things at least at least somewhat consistent, use the name and intensity of the first ability type listed in the tooltip in-game. So use MSI for Black Kat and so on.

7) There's plenty of room if different kinds of penalties are put into the game later. Oh, yeah we don't really see Ultra. If we ever do, it has a placeholder - so things can be updated easily.

8) In general, the "Ability Type" values have priority Monster > Item Type > Uniform, since terminology can get a little weird, I mean really, some monster abils are uniform, but wholistically (including weapon bonuses like Wild Hunting Blade), it's best to think about this column in this manner.

You see how it all works wonderfully with things that don't exist yet? Oh well in case you don't, here's a few examples in action:

Examples:

A value of 93.00103105 means:

Penalty...one ability of this type...uniform...no specific items affected...damage penalty...vs fiends...medium

This number applies to Armor of the Fallen and Crown of the Fallen.

Some Specificity:

9 = penalty

3 = monster

0 = placeholder, does not apply

1 = damage affected

0 = placeholder, does not apply

3 = monster type Fiend

1 = only one ability of this type

0 = placeholder, does not apply (ability is technically uniform)

5 = intensity level of: Medium

If your defenses were affected (like fiends dealt more damage to you), then the number would probably be 93.00603105, using the italicized potential in the "Ability B" column.

A value of 72.23300006 means:

Bonus...item...handgun...3 abilities...first ability is CTR...first ability is low level...

This number applies to several of the new 5* gunner items which feature handgun CTR, ASI, and DMG.

notice how the "Ability A Subclass" overrides the rest of the placeholders with 0s. This should help sorting if the above 6) is maintained.

So yep! This will work smoothly as long as we don't get more than 10 variants (0-9) of a thing. Then we might have to, I don't know, use letters or something. Hurray!

@@ Line 37: / Line 37: @@
 :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.
+'''Why shape the icons this way?'''
+----
+Decided do "square = good" and "circle=bad" regarding these gearlists. While this is not always the case in-game, I feel like for the table, a clear shape difference really helps quick scanning. Chose square because perks. Could be any shape really. Also squares and circles are easy to work with.
 <!--===============================
@@ Line 52: / Line 57: @@
 :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:
-:-Defenses
+:-Damage Type (defenses and offenses)
 :-Status
 :-Abilities
+<!--===============================
+Coloring Icons/Defenses
+===============================-->
+{{Showhide|DEFENSES and OFFENSES - why color these icons this way?|content=
+Simply colored the entire arsenal icon for an item to match its in-game color in stats images.
+Example (armor): [[File:Equipment-Ice Queen Mail Stats.png]] - that red and yellow shield? Normal and yellow defenses.
+Example (sword): [[File:Equipment-Divine Avenger Stats.png]] - that red and green sword? Normal and elemental offenses.
+But I didn't like that a sword is also used in stats images - a bomb is a bomb, not a sword! Same with shields and armor items. So I came up with this option:
+'''Defenses''':
+Helmets:
+[[File:Wiki Image-HelmetList-Defense-Normal icon.png|36px]], [[File:Wiki Image-HelmetList-Defense-Elemental icon.png|36px]], [[File:Wiki Image-HelmetList-Defense-Piercing icon.png|36px]], [[File:Wiki Image-HelmetList-Defense-Shadow icon.png|36px]]
+Armor:
+[[File:Wiki Image-ArmorList-Defense-Normal icon.png|36px]], [[File:Wiki Image-ArmorList-Defense-Elemental icon.png|36px]], [[File:Wiki Image-ArmorList-Defense-Piercing icon.png|36px]], [[File:Wiki Image-ArmorList-Defense-Shadow icon.png|36px]]
+Shields:
+[[File:Wiki Image-ShieldList-Defense-Normal icon.png|36px]], [[File:Wiki Image-ShieldList-Defense-Elemental icon.png|36px]], [[File:Wiki Image-ShieldList-Defense-Piercing icon.png|36px]], [[File:Wiki Image-ShieldList-Defense-Shadow icon.png|36px]]
+'''Offenses''':
+----
+Bombs:
+[[File:Wiki Image-BombList-Offense-Normal icon.png|36px]], [[File:Wiki Image-BombList-Offense-Elemental icon.png|36px]], [[File:Wiki Image-BombList-Offense-Piercing icon.png|36px]], [[File:Wiki Image-BombList-Offense-Shadow icon.png|36px]]
+Handguns:
+[[File:Wiki Image-HandgunList-Offense-Normal icon.png|36px]], [[File:Wiki Image-HandgunList-Offense-Elemental icon.png|36px]], [[File:Wiki Image-HandgunList-Offense-Piercing icon.png|36px]], [[File:Wiki Image-HandgunList-Offense-Shadow icon.png|36px]]
+Swords:
+[[File:Wiki Image-SwordList-Offense-Normal icon.png|36px]], [[File:Wiki Image-SwordList-Offense-Elemental icon.png|36px]], [[File:Wiki Image-SwordList-Offense-Piercing icon.png|36px]], [[File:Wiki Image-SwordList-Offense-Shadow icon.png|36px]]
+}}
+<!--===============================
+Coloring Icons/Status
+===============================-->
+{{Showhide|STATUS - why color these icons this way?|content=
+Simply colored the icons used in defenses like the status, following the color pattern - one on top, one as background. Like fire has bright orange on top and dark orange-red in the back. Resistances and Weaknesses follow the same color patterns, but weaknesses are in a circle with a down arrow to distinguish them.
+You can see these in action at: [[Armor/5 Star]].
+}}
+<!--===============================
+Coloring Icons/Abilities
+===============================-->
 {{Showhide|ABILITIES - why color these icons this way?|content=
@@ Line 88: / Line 168: @@
-Coloring Icons/Armor+Helmet+Shield Abils
+Coloring Icons/Abilities/Armor+Helmet+Shield
@@ Line 117: / Line 197: @@
-Coloring Icons/Armor+Helmet+Shield Abils/Sword
+Coloring Icons/Abilities/Armor+Helmet+Shield/Bomb
@@ Line 138: / Line 218: @@
-Coloring Icons/Armor+Helmet+Shield Abils/Handgun
+Coloring Icons/Abilities/Armor+Helmet+Shield/Handgun
@@ Line 159: / Line 239: @@
-Coloring Icons/Armor+Helmet+Shield Abils/Sword
+Coloring Icons/Abilities/Armor+Helmet+Shield/Sword
@@ Line 174: / Line 254: @@
 :Whitish areas = ability not affected
+----
+Now how to do status, like Fang of Vog? Well! Just color the sword icon like the fire icon, using the same logic as the DEFENSE and OFFENSE icons above.
 }}

Difference between revisions of "Template:GearList/doc"

From SpiralKnights

Revision as of 08:44, 22 December 2014

Contents

Usage

Level 1: Understanding the Templates

Level 2: Populating the Templates

Level 3: Updating the Templates with New Values

See Also

Views

Personal tools

Navigation

Search

Tools