lexys-labyrinth/js/format-dat.js

import { DIRECTIONS, LAYERS } from './defs.js';
import * as format_base from './format-base.js';
import TILE_TYPES from './tiletypes.js';
import * as util from './util.js';

const TILE_ENCODING = {
    0x00: 'floor',
    0x01: 'wall',
    0x02: 'chip',
    0x03: 'water',
    0x04: 'fire',
    0x05: 'wall_invisible',
    0x06: ['thin_walls', {edges: DIRECTIONS['north'].bit}],
    0x07: ['thin_walls', {edges: DIRECTIONS['west'].bit}],
    0x08: ['thin_walls', {edges: DIRECTIONS['south'].bit}],
    0x09: ['thin_walls', {edges: DIRECTIONS['east'].bit}],
    // This is MSCC's incomprehensible non-directional dirt block, which needs a direction for Lynx
    // purposes; Tile World defaults it to north
    0x0a: ['dirt_block', 'north'],
    0x0b: 'dirt',
    0x0c: 'ice',
    0x0d: 'force_floor_s',
    // These are the "clone blocks", which for us are just regular blocks
    0x0e: ['dirt_block', 'north'],
    0x0f: ['dirt_block', 'west'],
    0x10: ['dirt_block', 'south'],
    0x11: ['dirt_block', 'east'],
    0x12: 'force_floor_n',
    0x13: 'force_floor_e',
    0x14: 'force_floor_w',
    0x15: 'exit',
    0x16: 'door_blue',
    0x17: 'door_red',
    0x18: 'door_green',
    0x19: 'door_yellow',
    0x1a: 'ice_nw',
    0x1b: 'ice_ne',
    0x1c: 'ice_se',
    0x1d: 'ice_sw',
    0x1e: 'fake_floor',
    0x1f: 'fake_wall',
    0x20: 'wall_invisible',  // unused
    0x21: 'thief_tools',
    0x22: 'socket',
    0x23: 'button_green',
    0x24: 'button_red',
    0x25: 'green_wall',
    0x26: 'green_floor',
    0x27: 'button_brown',
    0x28: 'button_blue',
    0x29: 'teleport_blue',
    0x2a: 'bomb',
    0x2b: 'trap',
    0x2c: 'wall_appearing',
    0x2d: 'gravel',
    0x2e: 'popwall',
    0x2f: 'hint',
    0x30: ['thin_walls', {edges: DIRECTIONS['south'].bit | DIRECTIONS['east'].bit}],
    0x31: 'cloner',
    0x32: 'force_floor_all',
    0x33: 'bogus_player_drowned',
    0x34: 'bogus_player_burned_fire',
    0x35: 'bogus_player_burned',
    0x36: 'wall_invisible',  // unused
    0x37: 'wall_invisible',  // unused
    0x38: 'ice_block',       // unused, but co-opted by pgchip
    0x39: 'bogus_player_win',
    0x3a: 'bogus_player_win',
    0x3b: 'bogus_player_win',
    0x3c: ['bogus_player_swimming', 'north'],
    0x3d: ['bogus_player_swimming', 'west'],
    0x3e: ['bogus_player_swimming', 'south'],
    0x3f: ['bogus_player_swimming', 'east'],
    0x40: ['bug', 'north'],
    0x41: ['bug', 'west'],
    0x42: ['bug', 'south'],
    0x43: ['bug', 'east'],
    0x44: ['fireball', 'north'],
    0x45: ['fireball', 'west'],
    0x46: ['fireball', 'south'],
    0x47: ['fireball', 'east'],
    0x48: ['ball', 'north'],
    0x49: ['ball', 'west'],
    0x4a: ['ball', 'south'],
    0x4b: ['ball', 'east'],
    0x4c: ['tank_blue', 'north'],
    0x4d: ['tank_blue', 'west'],
    0x4e: ['tank_blue', 'south'],
    0x4f: ['tank_blue', 'east'],
    0x50: ['glider', 'north'],
    0x51: ['glider', 'west'],
    0x52: ['glider', 'south'],
    0x53: ['glider', 'east'],
    0x54: ['teeth', 'north'],
    0x55: ['teeth', 'west'],
    0x56: ['teeth', 'south'],
    0x57: ['teeth', 'east'],
    0x58: ['walker', 'north'],
    0x59: ['walker', 'west'],
    0x5a: ['walker', 'south'],
    0x5b: ['walker', 'east'],
    0x5c: ['blob', 'north'],
    0x5d: ['blob', 'west'],
    0x5e: ['blob', 'south'],
    0x5f: ['blob', 'east'],
    0x60: ['paramecium', 'north'],
    0x61: ['paramecium', 'west'],
    0x62: ['paramecium', 'south'],
    0x63: ['paramecium', 'east'],
    0x64: 'key_blue',
    0x65: 'key_red',
    0x66: 'key_green',
    0x67: 'key_yellow',
    0x68: 'flippers',
    0x69: 'fire_boots',
    0x6a: 'cleats',
    0x6b: 'suction_boots',
    0x6c: ['player', 'north'],
    0x6d: ['player', 'west'],
    0x6e: ['player', 'south'],
    0x6f: ['player', 'east'],
};

function decode_password(bytes, start, len) {
    let password = [];
    for (let i = 0; i < len; i++) {
        password.push(bytes[start + i] ^ 0x99);
    }
    return String.fromCharCode.apply(null, password);
}

export function parse_level_metadata(bytes) {
    let meta = {};

    let view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);

    // Level number; rest of level header is unused
    meta.number = view.getUint16(0, true);

    // Map layout
    // Same structure twice, for the two layers
    let p = 8;
    for (let l = 0; l < 2; l++) {
        let layer_length = view.getUint16(p, true);
        p += 2 + layer_length;
    }

    // Optional metadata fields
    let meta_length = view.getUint16(p, true);
    p += 2;
    let end = p + meta_length;
    while (p < end) {
        // Common header
        let field_type = view.getUint8(p, true);
        let field_length = view.getUint8(p + 1, true);
        p += 2;
        if (field_type === 0x03) {
            // Title, including trailing NUL
            meta.title = util.string_from_buffer_ascii(bytes, p, field_length - 1);
        }
        else if (field_type === 0x06) {
            // Password, with trailing NUL, and XORed with 0x99 (???)
            meta.password = decode_password(bytes, p, field_length - 1);
        }
        else if (field_type === 0x07) {
            // Hint, including trailing NUL, of course
            meta.hint = util.string_from_buffer_ascii(bytes, p, field_length - 1);
        }
        p += field_length;
    }

    return meta;
}

function parse_level(bytes, number) {
    let level = new format_base.StoredLevel(number);
    level.has_custom_connections = true;
    level.format = 'ccl';
    level.uses_ll_extensions = false;
    level.chips_required = 0;
    // Map size is always fixed as 32x32 in CC1
    level.size_x = 32;
    level.size_y = 32;
    for (let i = 0; i < 1024; i++) {
        level.linear_cells.push(new format_base.StoredCell);
    }
    level.use_cc1_boots = true;

    let view = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);

    // Header
    let level_number = view.getUint16(0, true);
    level.time_limit = view.getUint16(2, true);
    level.chips_required = view.getUint16(4, true);

    // Map layout
    let unknown = view.getUint16(6, true);
    // Same structure twice, for the two layers
    let p = 8;
    for (let l = 0; l < 2; l++) {
        let layer_length = view.getUint16(p, true);
        p += 2;
        let c = 0;
        let end = p + layer_length;
        while (p < end) {
            let tile_byte = bytes[p];
            p++;
            let count = 1;
            if (tile_byte === 0xff) {
                // RLE: 0xff, count, tile
                count = bytes[p];
                tile_byte = bytes[p + 1];
                p += 2;
            }

            let spec = TILE_ENCODING[tile_byte];
            // TODO could be more forgiving for goofy levels doing goofy things
            if (! spec) {
                let [x, y] = level.scalar_to_coords(c);
                throw new Error(`Invalid tile byte 0x${tile_byte.toString(16)} at (${x}, ${y})`);
            }

            let name, extra;
            if (spec instanceof Array) {
                [name, extra] = spec;
                if (typeof extra === 'string') {
                    extra = {direction: extra};
                }
            }
            else {
                name = spec;
                extra = {};
            }
            let tile = {type: TILE_TYPES[name], ...extra};

            for (let i = 0; i < count; i++) {
                if (c >= 1024)
                    throw new Error("Too many cells found");

                let cell = level.linear_cells[c];
                c++;

                // "Floor" and "empty" are interchangeable, which can lead to extra floor under
                // other terrain and other nonsense, so ignore floor entirely and fix it below
                // TODO one particular mscc weirdness is that you can have floor on top of
                // something, i think?  it seems like the two layers are functionally a stack, with
                // implied floor below everything
                if (name === 'floor') {
                    continue;
                }

                // pgchip grants directions to ice blocks on cloners by putting a clone block
                // beneath them instead
                if (l === 1 && 0x0e <= tile_byte && tile_byte <= 0x11 &&
                    cell[LAYERS.actor] && cell[LAYERS.actor].type.name === 'ice_block')
                {
                    cell[LAYERS.actor].direction = extra.direction;
                    let type = TILE_TYPES['cloner'];
                    cell[type.layer] = {type};
                    continue;
                }

                cell[tile.type.layer] = {...tile};
            }
        }
        if (c !== 1024)
            throw new Error(`Expected 1024 cells (32x32 map); found ${c}`);
    }

    // Fix the "floor/empty" nonsense here by adding floor to any cell with no terrain on bottom
    for (let cell of level.linear_cells) {
        if (! cell[LAYERS.terrain]) {
            cell[LAYERS.terrain] = { type: TILE_TYPES['floor'] };
        }
        // TODO we could also deal with weird cases where there's terrain /on top of/ something
        // else: things underwater, the quirk where a glider will erase the item underneath...
    }

    // Optional metadata fields
    let meta_length = view.getUint16(p, true);
    p += 2;
    let end = p + meta_length;
    while (p < end) {
        // Common header
        let field_type = view.getUint8(p, true);
        let field_length = view.getUint8(p + 1, true);
        p += 2;
        if (field_type === 0x01) {
            // Level time; unnecessary since it's already in the level header
            // TODO check, compare, warn?
        }
        else if (field_type === 0x02) {
            // Chips; unnecessary since it's already in the level header
            // TODO check, compare, warn?
        }
        else if (field_type === 0x03) {
            // Title, including trailing NUL
            level.title = util.string_from_buffer_ascii(bytes, p, field_length - 1);
        }
        else if (field_type === 0x04) {
            // Trap linkages (MSCC only, not in Lynx or CC2)
            let field_view = new DataView(bytes.buffer, bytes.byteOffset + p, field_length);
            let q = 0;
            while (q < field_length) {
                let button_x = field_view.getUint16(q + 0, true);
                let button_y = field_view.getUint16(q + 2, true);
                let trap_x = field_view.getUint16(q + 4, true);
                let trap_y = field_view.getUint16(q + 6, true);
                // Fifth u16 is always zero, possibly live game state
                q += 10;
                level.custom_trap_wiring[button_x + button_y * level.size_x] = trap_x + trap_y * level.size_x;
            }
        }
        else if (field_type === 0x05) {
            // Cloner linkages (MSCC only, not in Lynx or CC2)
            let field_view = new DataView(bytes.buffer, bytes.byteOffset + p, field_length);
            let q = 0;
            while (q < field_length) {
                let button_x = field_view.getUint16(q + 0, true);
                let button_y = field_view.getUint16(q + 2, true);
                let cloner_x = field_view.getUint16(q + 4, true);
                let cloner_y = field_view.getUint16(q + 6, true);
                q += 8;
                level.custom_cloner_wiring[button_x + button_y * level.size_x] = cloner_x + cloner_y * level.size_x;
            }
        }
        else if (field_type === 0x06) {
            // Password, with trailing NUL, and otherwise XORed with 0x99 (???)
            level.password = decode_password(bytes, p, field_length - 1);
        }
        else if (field_type === 0x07) {
            // Hint, including trailing NUL, of course
            level.hint = util.string_from_buffer_ascii(bytes, p, field_length - 1);
        }
        else if (field_type === 0x08) {
            // Password, but not encoded
            // TODO ???
        }
        else if (field_type === 0x0a) {
            // Initial actor order
            // TODO ??? should i...  trust this...
        }
        p += field_length;
    }

    return level;
}

// This thin wrapper is passed to StoredGame as the parser function
function _parse_level_from_stored_meta(meta) {
    return parse_level(meta.bytes, meta.number);
}

export function parse_game(buf) {
    let game = new format_base.StoredGame(null, _parse_level_from_stored_meta);

    let full_view = new DataView(buf);
    let magic = full_view.getUint32(0, true);
    if (magic === 0x0002aaac) {
        // OK
        // TODO probably use ms rules
    }
    else if (magic === 0x0102aaac) {
        // OK
        // TODO tile world convention, use lynx rules
    }
    else if (magic === 0x0003aaac) {
        // OK
        // TODO add in ice block i guess???
    }
    else {
        throw new Error(`Unrecognized magic number ${magic.toString(16)}`);
    }

    let level_count = full_view.getUint16(4, true);

    // And now, the levels
    let p = 6;
    for (let l = 1; l <= level_count; l++) {
        let length = full_view.getUint16(p, true);
        let bytes = new Uint8Array(buf, p + 2, length);
        p += 2 + length;

        let meta;
        try {
            meta = parse_level_metadata(bytes);
        }
        catch (e) {
            meta = {error: e};
        }
        meta.index = l - 1;
        meta.bytes = bytes;
        game.level_metadata.push(meta);
    }

    return game;
}