9c271be8e6f9bf144c394486f011746b3a83bcf3
[sheet.git] / sc.plp
1 <(common.inc.plp)><:
2
3 my %scver = (
4         id => 'bw',
5         name => 'Brood War',
6         title => 'starcraft',
7         game => 'StarCraft',
8         major => 1,
9 );
10
11 if ($ENV{PATH_INFO} and $ENV{PATH_INFO} eq '/2') {
12         %scver = (
13                 id => 'hots',
14                 name => 'Heart of the Swarm',
15                 title => 'starcraft2',
16                 game => 'StarCraft II',
17                 major => 2,
18         );
19 }
20 my $datafile = "sc-units-$scver{id}.inc.pl";
21
22 Html({
23         title => "$scver{title} unit cheat sheet",
24         version => 'v1.1',
25         description => [
26                 "Reference of $scver{game} unit properties,"
27                 . " comparing various statistics of all the units in $scver{name}"
28                 . ' including costs, damage, defense, speed, ranges, and abilities.',
29         ],
30         keywords => [
31                 qw'
32                 starcraft game unit statistics stats comparison table sheet cheat
33                 reference software attributes properties
34                 ',
35                 $scver{major} < 2 ? qw' bw broodwar brood war ' : qw' starcraft2 hots ',
36         ],
37         stylesheet => [qw'light'],
38         raw => '<link rel="stylesheet" type="text/css" media="all" href="/sc.css?1.1" title="light">',
39         data => [$datafile],
40 });
41
42 print "<h1>$scver{game} units</h1>\n\n";
43
44 my $units = do $datafile;
45 die "Cannot open unit data: $_\n" for $@ || $! || ();
46 my $patch = shift @{$units}
47         or die "Cannot open unit data: metadata not found\n";
48
49 print "<p>Unit properties as seen or measured in $scver{name}\n$patch.\n</p>\n\n";
50
51 sub coltoggle {
52         my ($name, $id) = @_;
53         return sprintf(
54                 (defined $get{order} ? $get{order} eq $id : !$id) ? '%2$s ▼'
55                         : '<a href="?%s">%s</a>',
56                 $id && "order=$id", $name
57         );
58 }
59 :><table class="units">
60 <thead><tr>
61         <th></th>
62         <th><:= coltoggle('name', '') :></th>
63         <th class="val min"><img src="/minerals.png" alt="min"></th>
64         <th class="val gas"><img src="/gas.png" alt="gas"></th>
65         <th class="val time"><:= coltoggle(qw'build cost') :></th>
66         <th class="unit" colspan="4"><:= coltoggle(qw'size size') :></th>
67         <th class="val unit-hp">HP</th>
68         <th class="val unit-shield">shield</th>
69         <th class="val unit-armor" title="armor">⛨</th>
70         <th class="val hurt">ground</th>
71         <th class="hurt hurtrel">dps</th>
72         <th class="val hurt">air</th>
73         <th class="hurt hurtrel">dps</th>
74         <th class="val unit-range">range</th>
75         <th class="val unit-sight">sight</th>
76         <th class="val unit-speed">speed</th>
77         <th class="unit-magic">specials</th>
78 </tr></thead>
79 <:
80 sub showrange {
81         my ($min, $max) = @_;
82         $_ = int($_ + .5) for $min, $max;  # round halves up
83         return $min == $max ? $min : "$min-$max";
84 }
85
86 sub showval {
87         my ($row, @elements) = @_;
88         my ($min, $max);
89
90         my $value = $row;
91         $value = ref $value eq 'HASH' && $value->{$_} or last for @elements;
92         if (ref $value eq 'ARRAY') {
93                 $min = $value->[0];
94                 $max = $value->[-1];
95         }
96         else {
97                 $min = $max = $value;
98         }
99         defined $min or return '';
100
101         if ($row->{upgrade}) {
102                 for (@{ $row->{upgrade} }) {
103                         my $increase = $_ or next;
104                         $increase = ref $increase eq 'HASH' && $increase->{$_} or last for @elements;
105                         $increase = $increase->[-1] if ref $increase eq 'ARRAY';
106                         $max += $increase if $increase;
107                 }
108         }
109
110         if ($elements[0] eq 'attack' and $elements[1] ne 'range' and $elements[2] eq 'dps') {{
111                 my $attack = $row->{ $elements[0] }->{ $elements[1] };
112                 ref $attack or $attack = $row->{ $elements[0] }->{$attack}; # follow
113                 my $type = $attack->{type} or next;
114                 if ($type eq 'explosive') {
115                         $min /= 2;
116                 }
117                 elsif ($type eq 'implosive') {
118                         $min /= 4;
119                 }
120         }}
121         return showrange($min, $max);
122 }
123
124         sub showattack {
125                 my ($row, $area) = @_;
126                 my $attack = $row->{attack}->{$area};
127                 if (not ref $attack) {
128                         # reference to another area
129                         $area = $attack;
130                         $attack = $row->{attack}->{$area};
131                 }
132
133                 return '<td colspan="2" class="hurt">' unless $attack;
134
135                 my $tagbase = '<td class="val hurt';
136                 if (ref $attack and $attack->{type}) {
137                         if ($attack->{type} eq 'explosive') {
138                                 $tagbase .= ' unit-l';
139                         }
140                         elsif ($attack->{type} eq 'implosive') {
141                                 $tagbase .= ' unit-s';
142                         }
143                 }
144                 $tagbase .= '">';
145
146                 my $out = showval($row, 'attack', $area, 'damage');
147                 $out .= '<span class="unit-splash">+</span>' if $attack->{splash};
148                 $attack->{dps} = $attack->{cooldown} && [
149                         map { 24 * $_ / $attack->{cooldown} * ($attack->{count} // 1) }
150                         map { ref $_ ? @{$_} : $_ }
151                         $attack->{damage}
152                         #TODO: upgrade (zergling)
153                 ];
154                 $out .= '<td class="val hurt hurtrel">' . showval($row, 'attack', $area, 'dps');
155                 return $tagbase . $out;
156         }
157
158         sub showmagic {
159                 my ($row) = @_;
160                 my $specials = $row->{special} or return '';
161                 return join ' ', map {
162                         sprintf '<span%s title="%s">%s</span>',
163                                 $_->{duration} < 0 && ' class="magic-perma"',
164                                 join('',
165                                         $_->{name},
166                                         $_->{desc} ? ": $_->{desc}" : '',
167                                         $_->{range} || $_->{cost} ? sprintf(' (%s)', join ', ',
168                                                 $_->{range} ? "range $_->{range}" : (),
169                                                 $_->{cost} ? sprintf('cost %.0f%%%s',
170                                                         100 * $_->{cost} / $row->{energy},
171                                                         defined $_->{maint} && sprintf('+%.1f%%/s',
172                                                                 100 * $_->{maint} / $row->{energy},
173                                                         ),
174                                                 ) : (),
175                                         ) : '',
176                                 ),
177                                 sprintf($_->{build} ? '(%s)' : '%s', $_->{abbr}),
178                 } grep { defined $_->{abbr} } @{$specials};
179         }
180
181         sub showunitcols {
182                 my ($row) = @_;
183                 local $_ = $row;
184                 $_->{hp} += $_->{shield} if $_->{shield};
185                 my $suitchar = '';
186                 if ($_->{attr}->{structure}) {
187                         $suitchar = 'b';
188                 }
189                 elsif ($_->{suit}) {
190                         $suitchar = [qw/? s m l/]->[$_->{suit}];
191                 }
192                 elsif ($_->{cargo} > 0) {
193                         $suitchar = [qw/? s m l l h h h h/]->[abs $_->{cargo}];
194                 }
195                 elsif ($_->{size}) {
196                         $suitchar = [qw/s m l h h h/]->[$_->{size}];
197                 }
198                 elsif ($_->{attr} and $_->{attr}->{light}) {
199                         $suitchar = 's';
200                 }
201                 elsif ($_->{attr} and $_->{attr}->{armored}) {
202                         $suitchar = 'l';
203                 }
204
205                 return (
206                         '<td class="val min">' . ($_->{min} // ''),
207                         '<td class="val gas">' . ($_->{gas} || ''),
208                         !defined $_->{build} ? '<td>' : sprintf('<td class="val time">%s%.0f',
209                                 !!$_->{base} && '<span class="unit-composed">+</span>',
210                                 $_->{build} || '0',
211                         ),
212                         !$suitchar ? '<td>' : sprintf('<td class="unit unit-%s">%s', $suitchar, ucfirst $suitchar),
213                         '<td class="val unit">' . (
214                                 defined $_->{unit} && $_->{unit} == .5 ? '½' : $_->{unit}
215                         ),
216                         '<td class="unit unit-type">' . join('', grep { $_ }
217                                 (defined $_->{organic} ? !$_->{organic} : $_->{attr}->{mech})
218                                         && '<span class="unit-u" title="mechanic">m</span>',
219                                 ($_->{organic} || $_->{attr}->{organic})
220                                         && '<span class="unit-o" title="organic">o</span>',
221                                 $_->{attr}->{psionic}
222                                         && '<span class="unit-p" title="psionic">ψ</span>',
223                         ),
224                         '<td class="unit unit-attr">' . join('', grep { $_ }
225                                 $_->{attr}->{armored}
226                                         && '<span class="unit unit-l" title="armored">A</span>',
227                                 $_->{attr}->{light}
228                                         && '<span class="unit unit-s" title="light">L</span>',
229                         ),
230                         '<td class="val unit-hp">' . $_->{hp} // '',
231                         $_->{shield} ? sprintf('<td class="val unit-shield">%.0f%%<td',
232                                 100 * $_->{shield} / $_->{hp}
233                         ) : '<td colspan=2',
234                         ' class="val unit-armor">' . showval($_, 'armor'),
235                         showattack($_, 'ground'),
236                         showattack($_, 'air'),
237                         '<td class="val unit-range">' . showval($_, 'attack', 'range'),
238                         '<td class="val unit-sight">' . sprintf(
239                                 $_->{detect} ? '<strong class="unit-detect">%s</strong>' : '%s',
240                                 showval($_, 'sight')
241                         ),
242                         '<td class="val unit-speed">' . showval($_, 'speed'),
243                         $_->{attr}->{massive}
244                                 && '<span class="unit-massive" title="massive">⚓</span>',
245                         '<td class="unit-magic">' . showmagic($_),
246                         "\n"
247                 );
248         }
249
250         my $grouped = 1;  # race headers
251         if (exists $get{order}) {
252                 $grouped = 0;
253                 $get{order} ||= '';
254                 if ($get{order} eq 'size') {
255                         $_->{order} = $_->{unit}*8 + $_->{suit} + $_->{hp}/512 + $_->{min}/8192 for @$units;
256                 }
257                 elsif ($get{order} eq 'cost') {
258                         $_->{order} = $_->{gas}*1.5 + $_->{min} + $_->{unit}/8 + $_->{build}/256/8 for @$units;
259                 }
260                 else {
261                         $units->[$_]->{order} = $_ for 0 .. $#$units;
262                 }
263         }
264         my @rows = @{$units};
265         @rows = sort {$a->{order} <=> $b->{order}} @rows unless $grouped;
266
267         my ($race, $cat) = ('', '');
268         for (@rows) {
269                 if ($grouped) {
270                         printf '<tbody id="%s"><tr class="race"><th colspan="20"><h2>%s</h2>'."\n",
271                                 $race = $_->{race}, ucfirst $race
272                                         unless $race eq $_->{race};
273                 }
274                 else {
275                         $_->{cat} = $_->{race};
276                 }
277
278                 print(
279                         '<tr>',
280                         '<th class="cat">', $cat ne $_->{cat} && ($cat = $_->{cat}),
281                         '<td>', $_->{name},
282                         showunitcols($_),
283                 );
284
285                 for my $subrow (@{ $_->{special} }) {
286                         $subrow->{alt} or next;
287                         print(
288                                 '<tr class="alt"><td class="cat"><td>', $subrow->{alt},
289                                 showunitcols($subrow),
290                         );
291                 }
292         }
293 :>
294 </table>
295
296 <div class="legend">
297 <h2>Legend</h2>
298
299 <dl>
300 <dt>cost
301         <dd>minerals+gas required to create one unit
302         <dd>includes total expenses if based on existing units
303 <dt>build
304         <dd>relative time needed to create at least one unit
305         <dd>excludes construction of dependencies such as buildings
306                 and <span class="unit-composed">+</span>parent units
307 <dt>size
308         <dd><:
309 if ($scver{major} > 1) {
310                 :>transports can fit 8 <span class="unit unit-s">S</span>mall,
311                 4 <span class="unit unit-m">M</span>edium,
312                 2 <span class="unit unit-l">L</span>arge,
313                 or a single <span class="unit unit-h">H</span>uge unit<:
314 } else {
315                 :>affected by <span class="unit unit-s">S</span>mall,
316                 <span class="unit unit-m">M</span>edium, or
317                 <span class="unit unit-l">L</span>arge unit damage<:
318 } :>
319         <dd>number of command points taken per unit
320         <dd><:
321 if ($scver{major} > 1) {
322                 :>received damage depends on
323                 <span class="unit unit-o">o</span>rganic,
324                 <span class="unit unit-u">m</span>echanic,
325                 <span class="unit unit-p">ψ</span>(ps)ionic,
326                 <span class="unit unit-s">L</span>ight, and
327                 <span class="unit unit-l">A</span>rmored
328                 attributes<:
329 } else {
330                 :><span class="unit unit-o">o</span>rganic/<span class="unit unit-u">m</span>echanic unit<:
331 } :>
332 <dt>HP<dd>
333         total number of hitpoints (including shields)
334 <dt>shield
335         <dd>percentage of HP in shields
336         <dd>shields always take full damage, irrelevant of unit size
337         <dd>does not take armor bonuses, but upgrades can decrease damage to any shield hit by upto 3
338 <dt>armor
339         <dd>base unit armor
340         <dd>can be increased by upto 3 at various facilities
341         <dd>each point decreases damage per hit by one, upto a minimum of ½
342         <dd>reduction applies to initial damage, before size penalties <small>(so a plasma hit of 12 to 4 armor large deals 2 damage, not ½)</small>
343 <dt>ground/air
344         <dd>damage done per single attack against ground/air units
345         <dd>2nd column indicates relative amount of damage done in
346                 1 second of fastest game time
347         <dd>splash damage<span class="unit-splash">+</span> hits nearby objects as well
348         <dd><span class="hurt unit-l">explosive</span> damage does only
349                 50% damage to small units, 75% to medium, 100% to large
350         <dd><span class="hurt unit-s">concussive/plasma</span> damage does
351                 25% to large, 50% medium, 100% to small units
352 <dt>sight
353         <dd>range in which the unit detects other units
354         <dd><strong class="unit-detect">emphasis</strong> indicates ability to detect cloaked units
355 <dt>range
356         <dd>maximum range of weapon (note siege tank also has a minimum range)
357 <dt>speed
358         <dd>relative speed of movement (when in full motion, startup speed ignored)
359 <dt>specials
360         <dd>special abilities are usually casted manually, but some are <span class="magic-perma">always active</span>
361         <dd>parentheses () indicate that it needs to be researched first
362         <dd>hover for description
363         <dd>range is maximum range required to activate
364         <dd>cost is percentage of total energy lost
365 </dl>
366
367 <p>
368 When two values are given (1-2), second value indicates attribute after all
369 possible upgrades.
370 </p>
371
372 </div>
373