sc: read version number from data include
[sheet.git] / sc.plp
diff --git a/sc.plp b/sc.plp
index 6b08c9477acb304665a865dc57178ca2f95d5013..13248fbb256afea92f25b287db48f48b14e01bd5 100644 (file)
--- a/sc.plp
+++ b/sc.plp
 <(common.inc.plp)><:
 
+my %scver = (
+       id => 'bw',
+       name => 'Brood War',
+       title => 'starcraft',
+       game => 'StarCraft',
+       major => 1,
+);
+
+if ($ENV{PATH_INFO} and $ENV{PATH_INFO} eq '/2') {
+       %scver = (
+               id => 'hots',
+               name => 'Heart of the Swarm',
+               title => 'starcraft2',
+               game => 'StarCraft II',
+               major => 2,
+       );
+}
+my $datafile = "sc-units-$scver{id}.inc.pl";
+
 Html({
-       title => 'starcraft unit cheat sheet',
-       version => 'v1.0',
+       title => "$scver{title} unit cheat sheet",
+       version => 'v1.1',
        description => [
-               'Reference of StarCraft unit properties,'
-               . ' comparing various statistics of all the units in Brood War'
+               "Reference of $scver{game} unit properties,"
+               . " comparing various statistics of all the units in $scver{name}"
                . ' including costs, damage, defense, speed, ranges, and abilities.',
        ],
-       keywords => [qw'
+       keywords => [
+               qw'
                starcraft game unit statistics stats comparison table sheet cheat
                reference software attributes properties
-       '],
+               ',
+               $scver{major} < 2 ? qw' bw broodwar brood war ' : qw' starcraft2 hots ',
+       ],
        stylesheet => [qw'light'],
+       raw => '<link rel="stylesheet" type="text/css" media="all" href="/sc.css?1.1" title="light">',
+       data => [$datafile],
 });
 
-:>
-<h1>StarCraft units</h1>
-
-<p>
-Unit properties as seen or measured in Brood War
-<span title="no known changes as of v1.16.1">version≥1.08</span>.
-</p>
-
-<style type="text/css">
-       .units {
-               border-collapse: separate;
-               border-spacing: 0;
-               margin: 0 auto;
-               white-space: nowrap;
-       }
-       .units th, .units td {
-               border: 0;
-               padding: 0 0.2em;
-               background: transparent;
-               text-align: left;
-       }
-       tr.alt td {
-               font-size: 70%;
-               border-top-style: dashed;
-       }
-       .units tr th:first-child {
-               padding-left: 0;
-       }
-       .units tr:hover:not(.race) {
-               background: #EEE;
-       }
-
-       table h2 {
-               padding: 1ex 0;
-               margin: 0;
-               text-align: center;
-       }
-       .units thead th, .units tfoot th {
-               font-size: 70%;
-               font-weight: normal;
-       }
-
-       .unit-o {color: #C08} /* organic */
-       .unit-u {color: #44C} /* mechanic */
-       img.unit-o, img.unit-u {
-               margin-left: 0.2em;
-               vertical-align: middle;
-       }
-       .unit-composed {
-               color: #C88;
-               font-size: 70%;
-       }
-       .unit {
-               text-align: center;
-               white-space: nowrap;
-       }
-       .unit.unit-s {color: #770}
-       .unit.unit-m {color: #C70}
-       .unit.unit-l {color: #D22}
-       .hurt.unit-s::before {
-               content: '~';
-               color: #773;
-       }
-       .hurt.unit-l::before {
-               content: '*';
-               color: #C66;
-       }
-       .hurt .unit-splash {
-               position: absolute;
-       }
-       .hurtrel, .units .hurtrel {
-               padding-left: 1em;
-               font-size: 70%;
-               color: #778;
-       }
-       .unit-splash {
-               color: #4A0;
-       }
-       .unit-detect::before {
-               content: '!';
-               color: #0A8;
-               font-size: 70%;
-               vertical-align: super;
-       }
-       .unit-magic {
-               padding-left: 0.5em;
-       }
-
-       .units .val {
-               text-align: right;
-       }
+print "<h1>$scver{game} units</h1>\n\n";
 
-       .legend dt {
-               float: none;
-               text-align: left;
-               margin-top: 1ex;
-               font-weight: bold;
-       }
-       .legend dd:before {
-               content: '• ';
-       }
-       .legend dd {
-               text-indent: -1em;
-               margin-left: 1em;
-               break-before: avoid;
-               -webkit-column-break-before: avoid;
-       }
+my $units = do $datafile;
+die "Cannot open unit data: $_\n" for $@ || $! || ();
+my $patch = shift @{$units}
+       or die "Cannot open unit data: metadata not found\n";
 
-       .units, .legend {
-               display: table-cell;
-       }
-       .legend {
-               min-width: 20em;
-               text-align: left;
-       }
-       .units {
-               float: left;
-               padding-bottom: 1em;
-               margin-right: 2em;
-       }
-       .footer {
-               clear: left;
-       }
-</style>
+print "<p>Unit properties as seen or measured in $scver{name}\n$patch.\n</p>\n\n";
 
-<:
 sub coltoggle {
        my ($name, $id) = @_;
        return sprintf(
@@ -169,6 +76,12 @@ sub coltoggle {
 </tr></thead>
 <:
 sub showrange {
+       my ($min, $max) = @_;
+       $_ = int($_ + .5) for $min, $max;  # round halves up
+       return $min == $max ? $min : "$min-$max";
+}
+
+sub showval {
        my ($row, @elements) = @_;
        my ($min, $max);
 
@@ -193,7 +106,9 @@ sub showrange {
        }
 
        if ($elements[0] eq 'attack' and $elements[1] ne 'range' and $elements[2] eq 'dps') {{
-               my $type = $row->{$elements[0]}->{$elements[1]}->{type} or next;
+               my $attack = $row->{ $elements[0] }->{ $elements[1] };
+               ref $attack or $attack = $row->{ $elements[0] }->{$attack}; # follow
+               my $type = $attack->{type} or next;
                if ($type eq 'explosive') {
                        $min /= 2;
                }
@@ -201,31 +116,40 @@ sub showrange {
                        $min /= 4;
                }
        }}
-       $_ = int($_ + .5) for $min, $max;  # round halves up
-
-       return $min == $max ? $min : "$min-$max";
+       return showrange($min, $max);
 }
 
        sub showattack {
                my ($row, $area) = @_;
-               local $_ = $row->{attack}->{$area};
+               my $attack = $row->{attack}->{$area};
+               if (not ref $attack) {
+                       # reference to another area
+                       $area = $attack;
+                       $attack = $row->{attack}->{$area};
+               }
 
-               return '<td colspan="2" class="hurt">' unless $_;
+               return '<td colspan="2" class="hurt">' unless $attack;
 
                my $tagbase = '<td class="val hurt';
-               if (ref $_ and $_->{type}) {
-                       if ($_->{type} eq 'explosive') {
+               if (ref $attack and $attack->{type}) {
+                       if ($attack->{type} eq 'explosive') {
                                $tagbase .= ' unit-l';
                        }
-                       elsif ($_->{type} eq 'implosive') {
+                       elsif ($attack->{type} eq 'implosive') {
                                $tagbase .= ' unit-s';
                        }
                }
                $tagbase .= '">';
 
-               my $out = showrange($row, 'attack', $area, 'damage');
-               $out .= '<span class="unit-splash">+</span>' if $_->{splash};
-               $out .= '<td class="val hurt hurtrel">' . showrange($row, 'attack', $area, 'dps');
+               my $out = showval($row, 'attack', $area, 'damage');
+               $out .= '<span class="unit-splash">+</span>' if $attack->{splash};
+               $attack->{dps} = $attack->{cooldown} && [
+                       map { 24 * $_ / $attack->{cooldown} * ($attack->{count} // 1) }
+                       map { ref $_ ? @{$_} : $_ }
+                       $attack->{damage}
+                       #TODO: upgrade (zergling)
+               ];
+               $out .= '<td class="val hurt hurtrel">' . showval($row, 'attack', $area, 'dps');
                return $tagbase . $out;
        }
 
@@ -233,57 +157,41 @@ sub showrange {
                my ($row) = @_;
                my $specials = $row->{special} or return '';
                return join ' ', map {
-                       sprintf '<span title="%s">%s</span>',
+                       sprintf '<span%s title="%s">%s</span>',
+                               $_->{duration} < 0 && ' class="magic-perma"',
                                join('',
                                        $_->{name},
                                        $_->{desc} ? ": $_->{desc}" : '',
-                                       $_->{range} ? sprintf(' (%s)', join ', ',
-                                               "range $_->{range}",
-#                                              "cost $_->{cost}",
+                                       $_->{range} || $_->{cost} ? sprintf(' (%s)', join ', ',
+                                               $_->{range} ? "range $_->{range}" : (),
+                                               $_->{cost} ? sprintf('cost %.0f%%',
+                                                       100 * $_->{cost} / $row->{energy}
+                                               ) : (),
                                        ) : '',
                                ),
-                               $_->{abbr},
-               } @$specials;
+                               sprintf($_->{build} ? '(%s)' : '%s', $_->{abbr}),
+               } grep { defined $_->{abbr} } @{$specials};
        }
 
-       my $units = do 'sc-units.inc.pl';
-       die "Cannot open unit data: $_\n" for $@ || $! || ();
-       my $grouped = !exists $get{order};
-       if (exists $get{order}) {
-               $get{order} ||= '';
-               if ($get{order} eq 'size') {
-                       $_->{order} = $_->{unit}*8 + $_->{suit} + $_->{hp}/512 + $_->{min}/8192 for @$units;
-               }
-               elsif ($get{order} eq 'cost') {
-                       $_->{order} = $_->{gas}*1.5 + $_->{min} + $_->{unit}/8 + $_->{build}/256/8 for @$units;
-               }
-               else {
-                       $units->[$_]->{order} = $_ for 0 .. $#$units;
+       sub showunitcols {
+               my ($row) = @_;
+               local $_ = $row;
+               $_->{hp} += $_->{shield} if $_->{shield};
+               my $suitchar = '';
+               if ($_->{suit}) {
+                       $suitchar = [qw/? s m l/]->[$_->{suit}];
                }
-       }
-       my @rows = $grouped ? @$units : sort {$a->{order} <=> $b->{order}} @$units;
 
-       my ($race, $cat) = ('', '');
-       for (@rows) {
-               $race = $_->{race},
-               printf '<tbody id="%s"><tr class="race"><th colspan="18"><h2>%s</h2>'."\n", $race, ucfirst $race
-                       if $grouped and $race ne $_->{race};
-               $_->{cat} = $_->{race} if not $grouped;
-               $_->{hp} += $_->{shield};
-               my $suitchar = [qw/? s m l/]->[$_->{suit}];
-               print(
-                       '<tr>',
-                       sprintf('<t%s class="cat">%s', $cat ne $_->{cat} ? ('h', $cat = $_->{cat}) : ('d', '&nbsp;')),
-                       '<td>' . $_->{name},
-                       '<td class="val min">' . ($_->{min} || '0'),
+               return (
+                       '<td class="val min">' . ($_->{min} // ''),
                        '<td class="val gas">' . ($_->{gas} || ''),
-                       sprintf('<td class="val time">%s%.0f',
+                       !defined $_->{build} ? '<td>' : sprintf('<td class="val time">%s%.0f',
                                !!$_->{base} && '<span class="unit-composed">+</span>',
                                $_->{build} || '0',
                        ),
-                       sprintf('<td class="unit unit-%s">%s', $suitchar, ucfirst $suitchar),
+                       !$suitchar ? '<td>' : sprintf('<td class="unit unit-%s">%s', $suitchar, ucfirst $suitchar),
                        '<td class="val unit">' . join('',
-                               $_->{unit} ? $_->{unit} == .5 ? '½' : $_->{unit} : '&nbsp;',
+                               defined $_->{unit} && $_->{unit} == .5 ? '½' : $_->{unit},
                                defined $_->{organic} && sprintf(
                                        '<span class="unit-%s" title="%s">%s</span>',
                                        $_->{organic} ? 'o' : 'u',
@@ -291,36 +199,64 @@ sub showrange {
                                        $_->{organic} ? 'o' : 'm',
                                ),
                        ),
-                       '<td class="val unit-hp">' . $_->{hp},
+                       '<td class="val unit-hp">' . $_->{hp} // '',
                        '<td class="val unit-shield">' . (
                                $_->{shield} ? sprintf('%.0f%%', 100 * $_->{shield} / $_->{hp}) : '&nbsp;'
                        ),
-                       '<td class="val unit-armor">' . showrange($_, 'armor'),
+                       '<td class="val unit-armor">' . showval($_, 'armor'),
                        showattack($_, 'ground'),
                        showattack($_, 'air'),
-                       '<td class="val unit-range">' . showrange($_, 'attack', 'range'),
+                       '<td class="val unit-range">' . showval($_, 'attack', 'range'),
                        '<td class="val unit-sight">' . sprintf(
                                $_->{detect} ? '<strong class="unit-detect">%s</strong>' : '%s',
-                               showrange($_, 'sight')
+                               showval($_, 'sight')
                        ),
-                       '<td class="val unit-speed">' . showrange($_, 'speed'),
+                       '<td class="val unit-speed">' . showval($_, 'speed'),
                        '<td class="unit-magic">' . showmagic($_),
                        "\n"
                );
+       }
+
+       my $grouped = 1;  # race headers
+       if (exists $get{order}) {
+               $grouped = 0;
+               $get{order} ||= '';
+               if ($get{order} eq 'size') {
+                       $_->{order} = $_->{unit}*8 + $_->{suit} + $_->{hp}/512 + $_->{min}/8192 for @$units;
+               }
+               elsif ($get{order} eq 'cost') {
+                       $_->{order} = $_->{gas}*1.5 + $_->{min} + $_->{unit}/8 + $_->{build}/256/8 for @$units;
+               }
+               else {
+                       $units->[$_]->{order} = $_ for 0 .. $#$units;
+               }
+       }
+       my @rows = @{$units};
+       @rows = sort {$a->{order} <=> $b->{order}} @rows unless $grouped;
+
+       my ($race, $cat) = ('', '');
+       for (@rows) {
+               if ($grouped) {
+                       printf '<tbody id="%s"><tr class="race"><th colspan="18"><h2>%s</h2>'."\n",
+                               $race = $_->{race}, ucfirst $race
+                                       unless $race eq $_->{race};
+               }
+               else {
+                       $_->{cat} = $_->{race};
+               }
+
+               print(
+                       '<tr>',
+                       '<th class="cat">', $cat ne $_->{cat} && ($cat = $_->{cat}),
+                       '<td>', $_->{name},
+                       showunitcols($_),
+               );
 
-               for my $alt (grep { $_->{alt} } @{ $_->{special} }) {
+               for my $subrow (@{ $_->{special} }) {
+                       $subrow->{alt} or next;
                        print(
-                               '<tr class="alt"><td class="cat"><td colspan="9">' . $alt->{alt},
-                               showattack($alt, 'ground'),
-                               showattack($alt, 'air'),
-                               '<td class="val unit-range">' . showrange($alt, 'attack', 'range'),
-                               '<td class="val unit-sight">' . sprintf(
-                                       $alt->{detect} ? '<strong class="unit-detect">%s</strong>' : '%s',
-                                       showrange($alt, 'sight')
-                               ),
-                               '<td class="val unit-speed">' . showrange($alt, 'speed'),
-                               '<td>',
-                               "\n",
+                               '<tr class="alt"><td class="cat"><td>', $subrow->{alt},
+                               showunitcols($subrow),
                        );
                }
        }
@@ -358,8 +294,7 @@ sub showrange {
 <dt>ground/air
        <dd>damage done per single attack against ground/air units
        <dd>2nd column indicates relative amount of damage done in
-               <span title="the time in which a dragoon fires a shot">a certain
-               amount</span> of time
+               1 second of fastest game time
        <dd>splash damage<span class="unit-splash">+</span> hits nearby objects as well
        <dd><span class="hurt unit-l">explosive</span> damage does only
                50% damage to small units, 75% to medium, 100% to large
@@ -373,7 +308,7 @@ sub showrange {
 <dt>speed
        <dd>relative speed of movement (when in full motion, startup speed ignored)
 <dt>specials
-       <dd>special abilities
+       <dd>special abilities are usually casted manually, but some are <span class="magic-perma">always active</span>
        <dd>parentheses () indicate that it needs to be researched first
        <dd>hover for description
        <dd>range is maximum range required to activate