brs-js 2.0.0 → 2.0.1

package/dist/src/types.d.ts

@@ -1,169 +0,0 @@
-export interface BRSBytes extends Uint8Array {
-    brsOffset: number;
-}
-declare type Modify<T, R> = Omit<T, keyof R> & R;
-export declare type Bytes = Uint8Array | BRSBytes;
-export declare type Uuid = string;
-export declare type UnrealClass = string;
-export declare type UnrealObject = string;
-export declare type UnrealBoolean = boolean;
-export declare type UnrealFloat = number;
-export declare type UnrealColor = [number, number, number, number];
-export declare type UnrealByte = number;
-export declare type UnrealRotator = [number, number, number];
-export declare type UnrealType = UnrealClass | UnrealObject | UnrealBoolean | UnrealFloat | UnrealColor | UnrealByte | UnrealRotator;
-export interface User {
-    id: Uuid;
-    name: string;
-}
-export interface Owner extends User {
-    bricks: number;
-}
-export declare enum Direction {
-    XPositive = 0,
-    XNegative = 1,
-    YPositive = 2,
-    YNegative = 3,
-    ZPositive = 4,
-    ZNegative = 5
-}
-export declare enum Rotation {
-    Deg0 = 0,
-    Deg90 = 1,
-    Deg180 = 2,
-    Deg270 = 3
-}
-export declare type ColorRgb = [number, number, number];
-export interface Collision {
-    player: boolean;
-    weapon: boolean;
-    interaction: boolean;
-    tool: boolean;
-}
-export interface AppliedComponent {
-    [property: string]: UnrealType;
-}
-export interface DefinedComponents {
-    [component_name: string]: {
-        version: number;
-        brick_indices: number[];
-        properties: {
-            [property: string]: string;
-        };
-    };
-}
-export interface Components {
-    [component_name: string]: AppliedComponent;
-}
-export declare type Vector = [number, number, number];
-export interface BrickV1 {
-    asset_name_index: number;
-    size: Vector;
-    position: Vector;
-    direction: Direction;
-    rotation: Rotation;
-    collision: boolean;
-    visibility: boolean;
-    color: UnrealColor | number;
-}
-export interface BrickV2 extends BrickV1 {
-    material_index: number;
-}
-export interface BrickV3 extends BrickV2 {
-    owner_index: number;
-}
-export interface BrickV8 extends BrickV3 {
-    components: Components;
-}
-export declare type BrickV9 = Modify<BrickV8, {
-    physical_index: number;
-    material_intensity: number;
-    color: ColorRgb | number;
-}>;
-export declare type BrickV10 = Modify<BrickV9, {
-    collision: Collision;
-}>;
-export interface BrsV1 {
-    version: 1;
-    map: string;
-    author: User;
-    description: string;
-    brick_count: number;
-    mods: string[];
-    brick_assets: string[];
-    colors: UnrealColor[];
-    bricks: BrickV1[];
-}
-export declare type BrsV2 = Modify<BrsV1, {
-    version: 2;
-    materials: string[];
-    bricks: BrickV2[];
-}>;
-export declare type BrsV3 = Modify<BrsV2, {
-    version: 3;
-    brick_owners: User[];
-    bricks: BrickV3[];
-}>;
-export declare type BrsV4 = Modify<BrsV3, {
-    version: 4;
-    save_time: Uint8Array;
-}>;
-export declare type BrsV8 = Modify<BrsV4, {
-    version: 8;
-    host: User;
-    brick_owners: Owner[];
-    preview?: Bytes;
-    game_version: number;
-    bricks: BrickV8[];
-    components: DefinedComponents;
-}>;
-export declare type BrsV9 = Modify<BrsV8, {
-    version: 9;
-    physical_materials: string[];
-    bricks: BrickV9[];
-}>;
-export declare type BrsV10 = Modify<BrsV9, {
-    version: 10;
-    bricks: BrickV10[];
-}>;
-export declare type ReadSaveObject = BrsV1 | BrsV2 | BrsV3 | BrsV4 | BrsV8 | BrsV9 | BrsV10;
-export interface Brick {
-    asset_name_index?: number;
-    size: Vector;
-    position: Vector;
-    direction?: Direction;
-    rotation?: Rotation;
-    collision?: boolean | Partial<Collision>;
-    visibility?: boolean;
-    material_index?: number;
-    physical_index?: number;
-    material_intensity?: number;
-    color?: ColorRgb | number;
-    owner_index?: number;
-    components?: Components;
-}
-export interface WriteSaveObject {
-    game_version?: number;
-    map?: string;
-    description?: string;
-    author?: Partial<User>;
-    host?: Partial<User>;
-    mods?: string[];
-    brick_assets?: string[];
-    colors?: UnrealColor[];
-    materials?: string[];
-    brick_owners?: Partial<Owner>[];
-    physical_materials?: string[];
-    preview?: Bytes;
-    bricks: Brick[];
-    save_time?: ArrayLike<number>;
-    components?: DefinedComponents;
-}
-export interface ReadOptions {
-    bricks?: boolean;
-    preview?: boolean;
-}
-export interface WriteOptions {
-    compress?: boolean;
-}
-export {};

package/dist/src/utils.d.ts

@@ -1,86 +0,0 @@
-import { BRSBytes, Bytes, UnrealFloat, UnrealType, Uuid } from './types';
-export declare const bgra: ([b, g, r, a]: number[]) => [
-    number,
-    number,
-    number,
-    number
-];
-export declare function isEqual<T>(arrA: Array<T>, arrB: Array<T>): boolean;
-export declare function subarray(data: Bytes, len: number, isCopy?: boolean): BRSBytes;
-export declare function chunk(arr: Bytes, size: number): BRSBytes[];
-declare function read_u16(data: Bytes, littleEndian?: boolean): number;
-declare function write_u16(num: number, littleEndian?: boolean): Uint8Array;
-declare function read_i32(data: Bytes, littleEndian?: boolean): number;
-declare function write_i32(num: number, littleEndian?: boolean): Uint8Array;
-declare function read_compressed(data: Bytes): Bytes;
-declare function write_uncompressed(...args: Uint8Array[]): Uint8Array;
-declare function write_compressed(...args: Uint8Array[]): Uint8Array;
-declare function read_string(data: Bytes): string;
-declare function write_string(str: string): Uint8Array;
-declare function read_uuid(data: Bytes): string;
-declare function write_uuid(uuid: Uuid): Uint8Array;
-declare function read_array<T>(data: Bytes, fn: (_: Bytes) => T): T[];
-declare function read_each(data: Bytes, fn: (_: Bytes) => void): void;
-declare function write_array<T>(arr: T[], fn: (_: T) => Uint8Array): Uint8Array;
-declare class BitReader {
-    buffer: Uint8Array;
-    pos: number;
-    constructor(data: Uint8Array);
-    empty(): boolean;
-    bit(): boolean;
-    align(): void;
-    int(max: number): number;
-    uint_packed(): number;
-    int_packed(): number;
-    bits(num: number): number[];
-    bytes(num: number): Uint8Array;
-    bytesArr(num: number): number[];
-    array<T>(fn: (_: BitReader) => T): T[];
-    each(fn: (data: BitReader) => void): void;
-    string(): string;
-    float(): number;
-    unreal(type: string): UnrealType;
-}
-declare class BitWriter {
-    buffer: number[];
-    cur: number;
-    bitNum: number;
-    bit(val: boolean): void;
-    bits(src: number[] | Uint8Array, len: number): void;
-    bytes(src: number[] | Uint8Array): void;
-    align(): void;
-    int(value: number, max: number): void;
-    uint_packed(value: number): void;
-    int_packed(value: number): void;
-    finish(): Uint8Array;
-    finishSection(): Uint8Array;
-    string(str: string): void;
-    float(num: UnrealFloat): void;
-    self(fn: (this: BitWriter) => void): this;
-    array<T>(arr: T[], fn: (this: BitWriter, item: T, index: number) => void): this;
-    each<T>(arr: T[], fn: (this: BitWriter, item: T, index: number) => void): this;
-    unreal(type: string, value: UnrealType): void;
-}
-export declare function concat(...arrays: Uint8Array[]): Uint8Array;
-export declare const read: {
-    bytes: typeof subarray;
-    u16: typeof read_u16;
-    i32: typeof read_i32;
-    compressed: typeof read_compressed;
-    string: typeof read_string;
-    uuid: typeof read_uuid;
-    array: typeof read_array;
-    each: typeof read_each;
-    bits: (data: Bytes) => BitReader;
-};
-export declare const write: {
-    u16: typeof write_u16;
-    i32: typeof write_i32;
-    compressed: typeof write_compressed;
-    uncompressed: typeof write_uncompressed;
-    string: typeof write_string;
-    uuid: typeof write_uuid;
-    array: typeof write_array;
-    bits: () => BitWriter;
-};
-export {};

package/dist/src/uuid.d.ts

@@ -1,3 +0,0 @@
-import { Uuid } from './types';
-export declare function uuidStringify(arr: number[]): Uuid;
-export declare function uuidParse(uuid: Uuid): Uint8Array;

package/dist/src/write.d.ts

@@ -1,2 +0,0 @@
-import { WriteOptions, WriteSaveObject } from './types';
-export default function writeBrs(save: WriteSaveObject, options?: WriteOptions): Uint8Array;

package/src/constants.ts

@@ -1,6 +0,0 @@
-import { Uuid } from './types';
-
-export const MAGIC = new Uint8Array([66, 82, 83]); // BRS
-export const LATEST_VERSION = 10;
-export const MAX_INT = ~(1 << 31);
-export const DEFAULT_UUID: Uuid = '00000000-0000-0000-0000-000000000000';

package/src/index.ts

@@ -1,24 +0,0 @@
-import read from './read';
-import write from './write';
-import * as utils from './utils';
-import * as constants from './constants';
-
-// https://i.imgur.com/cv1fDWs.png
-const brs = { read, write, utils, constants };
-export { read, write, utils, constants };
-export default brs;
-
-declare global {
-  interface Window {
-    BRS: {
-      read: typeof read;
-      write: typeof write;
-      utils: typeof utils;
-      constants: typeof constants;
-    };
-  }
-}
-
-if (typeof window !== 'undefined') {
-  window.BRS = brs;
-}

package/src/read.ts

@@ -1,57 +0,0 @@
-import { MAGIC } from './constants';
-import readBrsV1 from './read.v1';
-import readBrsV10 from './read.v10';
-import readBrsV2 from './read.v2';
-import readBrsV3 from './read.v3';
-import readBrsV4 from './read.v4';
-import readBrsV8 from './read.v8';
-import readBrsV9 from './read.v9';
-import { BRSBytes, ReadOptions, ReadSaveObject } from './types';
-import { read } from './utils';
-
-// Reads in a byte array to build a brs object
-export default function readBrs(
-  rawBytes: Uint8Array,
-  options: ReadOptions = {}
-): ReadSaveObject {
-  if (typeof options !== 'object') throw new Error('Invalid options');
-
-  // default enable brick reading
-  if (typeof options.bricks !== 'boolean') options.bricks = true;
-
-  // default disable preview (a5 only)
-  if (typeof options.preview !== 'boolean') options.preview = false;
-
-  // Determine if the first 3 bytes are equal to the Brickadia save magic bytes
-  if (
-    rawBytes[0] !== MAGIC[0] ||
-    rawBytes[1] !== MAGIC[1] ||
-    rawBytes[2] !== MAGIC[2]
-  ) {
-    throw new Error('Invalid starting bytes');
-  }
-
-  const brsData = rawBytes as BRSBytes;
-  brsData.brsOffset = 3;
-
-  // Determine if the file version supported
-  const version = read.u16(brsData);
-  switch (version) {
-    case 1:
-      return readBrsV1(brsData, options);
-    case 2:
-      return readBrsV2(brsData, options);
-    case 3:
-      return readBrsV3(brsData, options);
-    case 4:
-      return readBrsV4(brsData, options);
-    case 8:
-      return readBrsV8(brsData, options);
-    case 9:
-      return readBrsV9(brsData, options);
-    case 10:
-      return readBrsV10(brsData, options);
-    default:
-      throw new Error('Unsupported version ' + version);
-  }
-}

package/src/read.v1.ts

@@ -1,99 +0,0 @@
-import {
-  BRSBytes,
-  ReadOptions,
-  BrsV1,
-  UnrealColor,
-  BrickV1,
-  Vector,
-} from './types';
-import { bgra, read } from './utils';
-
-// Reads in a byte array to build a brs object
-export default function readBrsV1(
-  brsData: BRSBytes,
-  options: ReadOptions = {}
-): BrsV1 {
-  // Read in Headers
-  const header1Data = read.compressed(brsData);
-  const header2Data = read.compressed(brsData);
-
-  const map = read.string(header1Data);
-  const author_name = read.string(header1Data);
-  const description = read.string(header1Data);
-
-  const author_id = read.uuid(header1Data);
-
-  const brick_count = read.i32(header1Data);
-
-  const mods = read.array(header2Data, read.string);
-  const brick_assets = read.array(header2Data, read.string);
-  const colors = read.array(
-    header2Data,
-    data => bgra(Array.from(read.bytes(data, 4))) as UnrealColor
-  );
-
-  // Read in bricks
-  let bricks: BrickV1[] = [];
-
-  const numAssets = Math.max(brick_assets.length, 2);
-
-  if (options.bricks) {
-    bricks = Array(brick_count);
-    const brickData = read.compressed(brsData);
-    const brickBits = read.bits(brickData);
-
-    // Brick reader
-    for (let i = 0; !brickBits.empty() && i < brick_count; i++) {
-      brickBits.align();
-      const asset_name_index = brickBits.int(numAssets);
-      const size: Vector = brickBits.bit()
-        ? [
-            brickBits.uint_packed(),
-            brickBits.uint_packed(),
-            brickBits.uint_packed(),
-          ]
-        : [0, 0, 0];
-      const position: Vector = [
-        brickBits.int_packed(),
-        brickBits.int_packed(),
-        brickBits.int_packed(),
-      ];
-
-      const orientation = brickBits.int(24);
-      const direction = (orientation >> 2) % 6;
-      const rotation = orientation & 3;
-      const collision = brickBits.bit();
-      const visibility = brickBits.bit();
-
-      const color = brickBits.bit()
-        ? bgra(brickBits.bytesArr(4) as [number, number, number, number])
-        : brickBits.int(colors.length);
-
-      bricks[i] = {
-        asset_name_index,
-        size,
-        collision,
-        position,
-        direction,
-        rotation,
-        visibility,
-        color,
-      };
-    }
-  }
-
-  return {
-    version: 1,
-    map,
-    description,
-    author: {
-      id: author_id,
-      name: author_name,
-    },
-    mods,
-    brick_assets,
-    colors,
-    bricks,
-    brick_count,
-  };
-}

package/src/read.v10.ts

@@ -1,185 +0,0 @@
-import {
-  AppliedComponent,
-  BrickV10,
-  BRSBytes,
-  BrsV10,
-  Collision,
-  ReadOptions,
-  UnrealColor,
-  User,
-  Vector,
-} from './types';
-import { bgra, read } from './utils';
-
-// Reads in a byte array to build a brs object
-export default function readBrsV10(
-  brsData: BRSBytes,
-  options: ReadOptions = {}
-): BrsV10 {
-  // game version is included in saves >= v8
-  const game_version = read.i32(brsData);
-
-  // Read in Headers
-  const header1Data = read.compressed(brsData);
-  const header2Data = read.compressed(brsData);
-
-  const map = read.string(header1Data);
-  const author_name = read.string(header1Data);
-  const description = read.string(header1Data);
-  const author_id = read.uuid(header1Data);
-  const host: User = {
-    name: read.string(header1Data),
-    id: read.uuid(header1Data),
-  };
-  const save_time = read.bytes(header1Data, 8);
-
-  const brick_count = read.i32(header1Data);
-
-  const mods = read.array(header2Data, read.string);
-  const brick_assets = read.array(header2Data, read.string);
-  const colors = read.array(
-    header2Data,
-    data => bgra(Array.from(read.bytes(data, 4))) as UnrealColor
-  );
-  const materials = read.array(header2Data, read.string);
-
-  const brick_owners = read.array(header2Data, data => ({
-    id: read.uuid(data),
-    name: read.string(data),
-    bricks: read.i32(data),
-  }));
-
-  const physical_materials = read.array(header2Data, read.string);
-
-  // check for preview byte
-  let preview = null;
-  if (read.bytes(brsData, 1)[0]) {
-    const len = read.i32(brsData);
-    if (options.preview) {
-      preview = read.bytes(brsData, len);
-    } else {
-      brsData.brsOffset += len;
-    }
-  }
-
-  // Read in bricks
-  let bricks: BrickV10[] = [];
-  const components: BrsV10['components'] = {};
-
-  const numPhysMats = Math.max(physical_materials.length, 2);
-  const numMats = Math.max(materials.length, 2);
-  const numAssets = Math.max(brick_assets.length, 2);
-
-  if (options.bricks) {
-    bricks = Array(brick_count);
-    const brickData = read.compressed(brsData);
-    const brickBits = read.bits(brickData);
-
-    // Brick reader
-    for (let i = 0; !brickBits.empty() && i < brick_count; i++) {
-      brickBits.align();
-      const asset_name_index = brickBits.int(numAssets);
-      const size: Vector = brickBits.bit()
-        ? [
-            brickBits.uint_packed(),
-            brickBits.uint_packed(),
-            brickBits.uint_packed(),
-          ]
-        : [0, 0, 0];
-      const position: Vector = [
-        brickBits.int_packed(),
-        brickBits.int_packed(),
-        brickBits.int_packed(),
-      ];
-
-      const orientation = brickBits.int(24);
-      const direction = (orientation >> 2) % 6;
-      const rotation = orientation & 3;
-      const collision: Collision = {
-        player: brickBits.bit(),
-        weapon: brickBits.bit(),
-        interaction: brickBits.bit(),
-        tool: brickBits.bit(),
-      };
-      const visibility = brickBits.bit();
-      const material_index = brickBits.int(numMats);
-      const physical_index = brickBits.int(numPhysMats);
-      const material_intensity = brickBits.int(11);
-      const color = brickBits.bit()
-        ? (brickBits.bytesArr(3) as [number, number, number])
-        : brickBits.int(colors.length);
-
-      const owner_index = brickBits.uint_packed();
-
-      bricks[i] = {
-        asset_name_index,
-        size,
-        position,
-        direction,
-        rotation,
-        collision: collision as Collision,
-        visibility,
-        material_index,
-        physical_index,
-        material_intensity,
-        color,
-        owner_index,
-        components: {},
-      };
-    }
-
-    const componentData = read.compressed(brsData);
-    const numBricks = Math.max(bricks.length, 2);
-
-    read.each(componentData, data => {
-      // read component name
-      const name = read.string(data);
-
-      // read component body
-      const bits = read.bits(read.bytes(data, read.i32(data)));
-
-      const version = read.i32(bits.bytes(4));
-      // list of bricks
-      const brick_indices = bits.array(() => bits.int(numBricks));
-
-      // list of name, type properties
-      const properties = bits.array(() => [bits.string(), bits.string()]);
-
-      // read components for each brick
-      for (const i of brick_indices) {
-        const props: AppliedComponent = {};
-        for (const [name, type] of properties) props[name] = bits.unreal(type);
-        bricks[i].components[name] = props;
-      }
-
-      components[name] = {
-        version,
-        brick_indices,
-        properties: Object.fromEntries(properties),
-      };
-    });
-  }
-
-  return {
-    version: 10,
-    game_version,
-    map,
-    description,
-    author: {
-      id: author_id,
-      name: author_name,
-    },
-    host,
-    mods,
-    brick_assets,
-    colors,
-    materials,
-    brick_owners,
-    physical_materials,
-    preview,
-    bricks,
-    brick_count,
-    save_time,
-    components,
-  };
-}