use Data::Dumper;
use Getopt::Long 2.33 qw(HelpMessage :config bundling);
-our $VERSION = '1.03';
+our $VERSION = '1.04';
GetOptions(\my %opt,
'raw|r', # full output
use strict;
use warnings;
+use Parse::Binary::Nested;
+
our %MAGICID = (
"WormEdit053\000LVL" => 53,
"WormEdit\34195\000LVL" => 95,
multifood => 'C',
timematch => 'C',
race => 'C',
- ctf => 'Cx',
+ ctf => 'C',
+ reserved => 'x',
],
],
sprite => ['8C',
line => 'B8',
],
- endtype => 's',
- endstr => 'Ca255',
- enddata => 'Ca255x256',
+ finish => [1,
+ type => 's',
+ message => 'Ca255',
+ code => 'Ca255',
+ reserved=> 'x256',
+ ],
hiname => 'a3',
levels => ['*', # levelcount->total actually
id => 'Ca22',
$version = 94;
}
elsif (ord substr($input, 147, 1) == 0) {
- # nul of end type is 2 bytes later (unlike first char of endstr)
+ # nul of finish type is 2 bytes later (unlike first char of message)
$version = 96;
}
warn "Ambiguous file version 95; guessing subversion $version\n";
given ($fileversion) {
when (153) { } # current @FORMAT
$FORMAT[7] = 'Ca64'; # no reserved space after description
- $FORMAT[19] = 'Ca255'; # enddata
+ splice @{ $FORMAT[15] }, -2; # finish reserve
$FORMAT[-1]->[-1]->[0] = '32C'; # less objects
- when ($version == 96) {
- ref $_ and $_->[-1] = 'C' for @{ $FORMAT[11] }; # 9 moderefs
- }
- ref $_ and pop @$_ for @{ $FORMAT[11] }; # only 8 moderefs
+ ref $_ and pop @$_ for @{ $FORMAT[11] }; # 9 moderefs
+ when ($version == 96) { }
+ ref $_ and pop @$_ for @{ $FORMAT[11] }; # only 8 moderefs (no ctf)
splice @FORMAT, 6, 2 if $version <= 94; # earlier version without description
when (95) { }
splice @{ $FORMAT[7] }, 4, 2; # no race
- splice @FORMAT, 16, 2; # no enddata
+ splice @{ $FORMAT[13] }, 4, 2; # no enddata
splice @{ $FORMAT[-1] }, 1, 2; # no name
when (94) { }
- splice @FORMAT, 16, 2; # no hiname
+ splice @FORMAT, 14, 2; # no hiname
$FORMAT[-1]->[0] = 64; # constant amount of levels
when (93) { }
default {
}
# convert to an easily accessible hash
- my @values = unpack Shiar_Parse::Nested->template(\@FORMAT).'a*', $input;
- my $data = Shiar_Parse::Nested->convert(\@FORMAT, \@values);
- warn "Trailing data left unparsed\n" if grep {length} @values;
+ push @FORMAT, -trail => 'a*';
+ my $data = Parse::Binary::Nested->new(\@FORMAT)->unpackf($input);
+ warn "Trailing data left unparsed\n" if length delete $data->{-trail};
$data->{format} = 'WormEdit';
return $data;
}
use warnings;
use List::Util qw(sum min max);
+use Data::Dumper;
+use Parse::Binary::Nested;
sub read {
my ($self, $input) = @_;
- my ($psize, $ptype, $size, $type, $vsize, $dsize, $id, $subid) = unpack q{
+ my ($psize, $ptype, $size, $type, $vsize, $dsize, $id, $version) = unpack q{
x11 x42 # file signature and comment
S a2 S a2 # file size, type; data size, type
x8 # var name
$input = substr $input, 73, -2;
$id eq ord 'w'
or die "Wormy level identifier not found\n";
+
+ if ($opt{version}) {
+ warn "Override version $version to $opt{version}\n";
+ $version = $opt{version};
+ }
+ elsif ($version == 95) {
+ # level offset instead of description byte
+ $version-- if (unpack('x2Z*x2xC', $input))[1] == 0xF4;
+ warn "Ambiguous file version 95; guessing subversion $version\n";
+ }
+
my @FORMAT = (
magic => 'a1',
version => 'C',
) }
[qw/single peaworm tron deathmatch foodmatch multifood timematch race ctf/]
],
- theanswer => 'C', # 42
+ theanswer => 'x', # 42
sprite => ['C',
line => 'B8',
],
x => 'C',
],
#levels
- #enddata
+ #finish code
#levels-multi
#hinames
);
x2 => 'C',
y2 => 'C',
);
+ my $offsetbase = 0xF080;
- given ($subid) {
+ given ($version) {
when (97) {
# current @FORMAT
}
- when (95) {
- ref $_ and splice @$_, -2 for @{ $FORMAT[11] }; # only 8 moderefs
+ $offsetbase = 0xF400;
+ when (96) {}
+ ref $_ and splice(@$_, -8, 2) for @{ $FORMAT[11] }; # no multifood
splice @FORMAT, 12, 2; # no reserved byte
+ when (95) {}
+ splice @FORMAT, 6, 2; # no description
+ when (94) {}
+ when (90) {
+ $FORMAT[5] = 'C/a'; # length-preceding name
+ splice @FORMAT, 10, 2; # no default sprite
+ ref $_ and do {
+ $_->[5] = $_->[7]; # no tron; deathmatch instead
+ $_->[7] = $_->[9]; # foodmatch instead
+ $_->[9] = 'linkmatch'; # replaces timematch
+ $_->[11] = $_->[13]; # race
+ $_->[13] = $_->[15]; # ctf
+ $_->[15] = 'domination';
+ } for @{ $FORMAT[9] }; # no multifood
+ push @LEVELFORM, "objects$_" => ['C',
+ type => "=$_",
+ map {$_ => 'C'} qw(x1 y1 x2 y2)
+ ] for 2, 3;
}
default {
- die "Unsupported level version $subid\n";
+ die "Unsupported level version $version\n";
}
}
- my $data = Shiar_Parse::Nested->unpack(\@FORMAT, $input);
+ my $data = Parse::Binary::Nested->new(\@FORMAT)->unpackf($input);
my $offset = 0;
- my $offsetbase = 0xF080 + @{ $data->{sprite} } + 1;
+ $offsetbase += 1 + @{ $data->{sprite} } if $data->{sprite};
$data->{moderef}->{offset}->{single} == $offsetbase
or warn "First singleplayer level is not in front\n";
+ my $slots = sum(
+ $data->{moderef}->{end}->{single} > 0, # singleplayer slot if any levels
+ $data->{moderef}->{end}->{peaworm}, # one for each peaworm arena
+ $data->{moderef}->{end}->{tron}, # idem for tron
+ );
+ $data->{hinames} = [ unpack '(x2a3)*', substr($data->{leveldata}, -5 * $slots) ];
+ $data->{format} = '86s';
+
my @VARMODES = (
[qw'single single'],
[qw'multi peaworm tron deathmatch foodmatch multifood timematch'],
$data->{levels} = [];
for my $modes (@VARMODES) {
my $variant = shift @$modes;
- $offset = min(map { $data->{moderef}->{offset}->{$_} } @$modes) - $offsetbase;
- my $amount = $variant eq 'single' ? 100 : max(map { $data->{moderef}->{end}->{$_} } @$modes);
+ my @modeoffsets = grep {defined} #TODO: comment
+ map { $data->{moderef}->{offset}->{$_} } @$modes;
+ @modeoffsets or next;
+ $data->{levelcount}->{$variant} = 0;
+ $offset = min(grep {$_} @modeoffsets) or next;
+ $offset -= $offsetbase;
+ my $amount = $variant eq 'single' ? 100
+ : max(grep {defined} map { $data->{moderef}->{end}->{$_} } @$modes);
my @varform = @LEVELFORM;
$varform[13]->[0] = $variant eq 'single' ? 1 : 4;
- unshift @varform, name => 'Z*' unless $variant eq 'single';
- $varform[-1]->[0] = 1 if $variant eq 'race';
+ unshift @varform, name => 'Z*' unless $variant eq 'single' or $version <= 91;
+ $varform[-1]->[0] = 1 if $variant eq 'race' and $version > 91;
$varform[-1]->[0] = 2 if $variant eq 'ctf';
+ my $parselevel = Parse::Binary::Nested->new(\@varform);
while ($offset < length $data->{leveldata}) {
last if substr($data->{leveldata}, $offset, 1) eq chr(255);
$data->{moderef}->{start}->{$mode} = 1 + scalar @{ $data->{levels} };
}
- my $level = Shiar_Parse::Nested->unpack(
- [@varform], substr $data->{leveldata}, $offset
- );
+ my $level = $parselevel->unpackf(substr $data->{leveldata}, $offset);
my $size = 8 # unpack length (ugh, ugly recalculation)
+ (defined $level->{name} ? 1 + length $level->{name} : 0)
+ 3 * (ref $level->{worms} eq 'ARRAY' ? scalar @{$level->{worms}} : 1)
# add objects until terminator
$level->{objects} = [];
+ if ($version <= 91) {
+ ref $_ eq 'ARRAY' and push @{ $level->{objects} }, @$_
+ for map { delete $level->{"objects$_"} } 2, 3;
+ $size += 1 + 4 * scalar @{ $level->{objects} };
+ }
+ else {
while (my $object = ord substr($data->{leveldata}, $offset+$size, 1)) {
- push @{ $level->{objects} }, Shiar_Parse::Nested->unpack(
- [@OBJECTFORM], substr($data->{leveldata}, $offset+$size, 5)
+ push @{ $level->{objects} }, Parse::Binary::Nested->new([@OBJECTFORM])->unpackf(
+ substr $data->{leveldata}, $offset+$size, 5
);
$size += 5;
}
+ }
# add parsed level and advance
push @{ $data->{levels} }, $level;
$offset += ++$size;
last if ++$data->{levelcount}->{$variant} >= $amount;
}
- }
- my $slots = sum(
- $data->{moderef}->{end}->{single} > 0, # singleplayer slot if any levels
- $data->{moderef}->{end}->{peaworm}, # one for each peaworm arena
- $data->{moderef}->{end}->{tron}, # idem for tron
- );
- $data->{hinames} = [ unpack '(x2a3)*', substr($data->{leveldata}, -5 * $slots) ];
- $data->{enddata} = substr delete($data->{leveldata}), $offset, -5 * $slots; #XXX
- $data->{format} = '86s';
- return $data;
-}
-
-
-package Shiar_Parse::Nested;
-
-sub template {
- my ($self, $format) = @_;
- # total (flattened) unpack template from nested format definitions
- return join '', map {
- my $value = $format->[-($_ << 1) - 1];
- if (ref $value eq 'ARRAY') {
- my $count = $value->[0];
- $value = $self->template($value);
- $value = $count =~ s/^([*\d]+)// ? "$count($value)$1"
- : $count."X[$count]$count/($value)";
- }
- else {
- $value =~ s/^C(a)(\d+)/$1 . ($2 + 1)/e; # length prefix
- }
- $value;
- } reverse 0 .. ($#$format - 1) >> 1;
-}
-
-sub convert {
- my ($self, $format, $data) = @_;
- # map flat results into a named and nested hash
- my %res;
- while (my ($field, $template) = splice @$format, 0, 2) {
- if (ref $template eq 'ARRAY') {
- my ($count, @subformat) = @$template;
- my $max = $count =~ s/^(\d+)// ? $1 : 0;
- $count = !$count ? $max
- : $count eq '*' ? $res{levelcount}->{total} : shift @$data;
- $res{$field}->[$_] = $self->convert([@subformat], $data) for 0 .. ($max || $count)-1;
- splice @{ $res{$field} }, $count if $max > $count;
- $res{$field} = $res{$field}->[0] if $max == 1;
- next;
- }
- elsif ($template =~ /^Ca/) {
- $data->[0] = CORE::unpack 'C/a', $data->[0];
+ if ($variant eq 'single') {
+ $offset++;
+ $data->{finish}->{code} =
+ my $code = substr $data->{leveldata}, $offset, -5*$slots;
+
+ my %FINISHCODE = (
+ 0 => chr 0xC9, # ret
+ 1 => join('',
+ chr 0x21, # ld hl, MESSAGE
+ pack('v', $offsetbase + $offset + 9),
+ (map {chr}
+ 0xCD, 0x37, 0x4A, # call _puts
+ 0xC3, 0xAA, 0x55, # jp _getkey
+ ),
+ ),
+ 2 => join('',
+ (map {chr}
+ 0x21, 0, 0x1C, # ld hl, $POS
+ 0x22, 0x7C, 0xC3, # ld (_penCol), hl
+ 0x21, # ld hl, MESSAGE
+ ),
+ pack('v', $offsetbase + $offset + 15),
+ (map {chr}
+ 0xCD, 0xA5, 0x4A, # call _vputs
+ 0xC3, 0xAA, 0x55, # jp _getkey
+ ),
+ ),
+ );
+ while (my ($finish, $match) = each %FINISHCODE) {
+ $match eq substr $code, 0, length $match or next;
+ $data->{finish}->{type} = $finish and
+ $data->{finish}->{message} = unpack 'Z*', substr($code, length $match);
+ last;
+ }
}
- $res{$field} = shift @$data;
}
- return \%res;
-}
-sub unpack {
- my ($self, $format, $input) = @_;
- my @data = CORE::unpack $self->template($format), $input;
- return $self->convert($format, \@data);
+ return $data;
}
# output with user-preferred formatting
if ($opt{raw}) {
- require JSON::XS;
- my $output = JSON::XS->new->ascii->canonical->pretty->allow_nonref;
- print $output->encode($data), "\n";
+ # full data in yaml (human-readable) formatting
+ require YAML;
+ local $YAML::CompressSeries;
+ $YAML::CompressSeries = 0;
+ my $yml = "# Wormy levelset\n" . YAML::Dump($data);
+
+ # inline format of short hashes
+ $yml =~ s{
+ ^(\ *) - \n # array indicator
+ ((?:\1\ \ [a-z0-9]{1,5}:\ *\d+\n)+) # simple hash declaration
+ (?!\1\ ) # no further children
+ }[
+ my ($indent, $value) = ($1, $2);
+ chop $value;
+ $value =~ s/^ +//gm;
+ $value =~ s/\n/, /g;
+ "$indent- {$value}\n";
+ ]egmx;
+
+ print $yml;
}
else {
print $data->{name};
print "\n";
printf "File version: %s\n", "$data->{format} v$data->{version}";
printf "Defaults: %s\n", join('; ',
- 'sprite ' . scalar @{ $data->{sprite} },
+ $data->{sprite} ? 'sprite ' . scalar @{ $data->{sprite} } : (),
defined $data->{hiname} ? 'hiscore by ' . $data->{hiname} : (),
);
print "\n";
printf("-- %-21s%4s: %s (%s)\n",
'(ending)',
- defined $data->{enddata} ? length $data->{enddata} : '?',
- defined $data->{endtype} ? $ENDTYPE[$data->{endtype}] || 'unknown' : 'code',
- $data->{endstr} // '?',
+ defined $data->{finish}->{code}
+ ? length $data->{finish}->{code} : '?',
+ defined $data->{finish}->{type}
+ ? $ENDTYPE[$data->{finish}->{type}] || 'unknown' : 'code',
+ $data->{finish}->{message} // '?',
) if $variant eq 'single';
}
}