brs-js 2.0.1 → 2.0.4

package/dist/src/types.d.ts

@@ -0,0 +1,286 @@
+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 {
+    BCD_SpotLight?: {
+        version: 1;
+        brick_indices: number[];
+        properties: {
+            Rotation: 'Rotator';
+            InnerConeAngle: 'Float';
+            OuterConeAngle: 'Float';
+            Brightness: 'Float';
+            Radius: 'Float';
+            Color: 'Color';
+            bUseBrickColor: 'Boolean';
+            bCastShadows: 'Boolean';
+        };
+    };
+    BCD_PointLight?: {
+        version: 1;
+        brick_indices: number[];
+        properties: {
+            bMatchBrickShape: 'Boolean';
+            Brightness: 'Float';
+            Radius: 'Float';
+            Color: 'Color';
+            bUseBrickColor: 'Boolean';
+            bCastShadows: 'Boolean';
+        };
+    };
+    BCD_ItemSpawn?: {
+        version: 1;
+        brick_indices: number[];
+        properties: {
+            PickupClass: 'Class';
+            bPickupEnabled: 'Boolean';
+            bPickupRespawnOnMinigameReset: 'Boolean';
+            PickupMinigameResetRespawnDelay: 'Float';
+            bPickupAutoDisableOnPickup: 'Boolean';
+            PickupRespawnTime: 'Float';
+            PickupOffsetDirection: 'Byte';
+            PickupOffsetDistance: 'Float';
+            PickupRotation: 'Rotator';
+            PickupScale: 'Float';
+            bPickupAnimationEnabled: 'Boolean';
+            PickupAnimationAxis: 'Byte';
+            bPickupAnimationAxisLocal: 'Boolean';
+            PickupSpinSpeed: 'Float';
+            PickupBobSpeed: 'Float';
+            PickupBobHeight: 'Float';
+            PickupAnimationPhase: 'Float';
+        };
+    };
+    BCD_Interact?: {
+        version: 1;
+        brick_indices: number[];
+        properties: {
+            bPlayInteractSound: 'Boolean';
+        };
+    };
+    BCD_AudioEmitter?: {
+        version: 1;
+        brick_indices: number[];
+        properties: {
+            AudioDescriptor: 'Object';
+            VolumeMultiplier: 'Float';
+            PitchMultiplier: 'Float';
+            InnerRadius: 'Float';
+            MaxDistance: 'Float';
+            bSpatialization: 'Boolean';
+        };
+    };
+    [component_name: string]: {
+        version: number;
+        brick_indices: number[];
+        properties: {
+            [property: string]: string;
+        };
+    };
+}
+export interface Components {
+    BCD_SpotLight?: {
+        Rotation: UnrealRotator;
+        InnerConeAngle: UnrealFloat;
+        OuterConeAngle: UnrealFloat;
+        Brightness: UnrealFloat;
+        Radius: UnrealFloat;
+        Color: UnrealColor;
+        bUseBrickColor: UnrealBoolean;
+        bCastShadows: UnrealBoolean;
+    };
+    BCD_PointLight?: {
+        bMatchBrickShape: UnrealBoolean;
+        Brightness: UnrealFloat;
+        Radius: UnrealFloat;
+        Color: UnrealColor;
+        bUseBrickColor: UnrealBoolean;
+        bCastShadows: UnrealBoolean;
+    };
+    BCD_ItemSpawn?: {
+        PickupClass: UnrealClass;
+        bPickupEnabled: UnrealBoolean;
+        bPickupRespawnOnMinigameReset: UnrealBoolean;
+        PickupMinigameResetRespawnDelay: UnrealFloat;
+        bPickupAutoDisableOnPickup: UnrealBoolean;
+        PickupRespawnTime: UnrealFloat;
+        PickupOffsetDirection: UnrealByte;
+        PickupOffsetDistance: UnrealFloat;
+        PickupRotation: UnrealRotator;
+        PickupScale: UnrealFloat;
+        bPickupAnimationEnabled: UnrealBoolean;
+        PickupAnimationAxis: UnrealByte;
+        bPickupAnimationAxisLocal: UnrealBoolean;
+        PickupSpinSpeed: UnrealFloat;
+        PickupBobSpeed: UnrealFloat;
+        PickupBobHeight: UnrealFloat;
+        PickupAnimationPhase: UnrealFloat;
+    };
+    BCD_Interact?: {
+        bPlayInteractSound: UnrealBoolean;
+    };
+    BCD_AudioEmitter?: {
+        AudioDescriptor: UnrealObject;
+        VolumeMultiplier: UnrealFloat;
+        PitchMultiplier: UnrealFloat;
+        InnerRadius: UnrealFloat;
+        MaxDistance: UnrealFloat;
+        bSpatialization: UnrealBoolean;
+    };
+    [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 {};
+//# sourceMappingURL=types.d.ts.map

package/dist/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAS,SAAQ,UAAU;IAC1C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,aAAK,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;AAEzC,oBAAY,KAAK,GAAG,UAAU,GAAG,QAAQ,CAAC;AAC1C,oBAAY,IAAI,GAAG,MAAM,CAAC;AAE1B,oBAAY,WAAW,GAAG,MAAM,CAAC;AACjC,oBAAY,YAAY,GAAG,MAAM,CAAC;AAClC,oBAAY,aAAa,GAAG,OAAO,CAAC;AACpC,oBAAY,WAAW,GAAG,MAAM,CAAC;AACjC,oBAAY,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAC3D,oBAAY,UAAU,GAAG,MAAM,CAAC;AAChC,oBAAY,aAAa,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AACrD,oBAAY,UAAU,GAClB,WAAW,GACX,YAAY,GACZ,aAAa,GACb,WAAW,GACX,WAAW,GACX,UAAU,GACV,aAAa,CAAC;AAElB,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,KAAM,SAAQ,IAAI;IACjC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,oBAAY,SAAS;IACnB,SAAS,IAAA;IACT,SAAS,IAAA;IACT,SAAS,IAAA;IACT,SAAS,IAAA;IACT,SAAS,IAAA;IACT,SAAS,IAAA;CACV;AAED,oBAAY,QAAQ;IAClB,IAAI,IAAA;IACJ,KAAK,IAAA;IACL,MAAM,IAAA;IACN,MAAM,IAAA;CACP;AAED,oBAAY,QAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAEhD,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC;CAChC;AAED,MAAM,WAAW,iBAAiB;IAChC,aAAa,CAAC,EAAE;QACd,OAAO,EAAE,CAAC,CAAC;QACX,aAAa,EAAE,MAAM,EAAE,CAAC;QACxB,UAAU,EAAE;YACV,QAAQ,EAAE,SAAS,CAAC;YACpB,cAAc,EAAE,OAAO,CAAC;YACxB,cAAc,EAAE,OAAO,CAAC;YACxB,UAAU,EAAE,OAAO,CAAC;YACpB,MAAM,EAAE,OAAO,CAAC;YAChB,KAAK,EAAE,OAAO,CAAC;YACf,cAAc,EAAE,SAAS,CAAC;YAC1B,YAAY,EAAE,SAAS,CAAC;SACzB,CAAC;KACH,CAAC;IACF,cAAc,CAAC,EAAE;QACf,OAAO,EAAE,CAAC,CAAC;QACX,aAAa,EAAE,MAAM,EAAE,CAAC;QACxB,UAAU,EAAE;YACV,gBAAgB,EAAE,SAAS,CAAC;YAC5B,UAAU,EAAE,OAAO,CAAC;YACpB,MAAM,EAAE,OAAO,CAAC;YAChB,KAAK,EAAE,OAAO,CAAC;YACf,cAAc,EAAE,SAAS,CAAC;YAC1B,YAAY,EAAE,SAAS,CAAC;SACzB,CAAC;KACH,CAAC;IACF,aAAa,CAAC,EAAE;QACd,OAAO,EAAE,CAAC,CAAC;QACX,aAAa,EAAE,MAAM,EAAE,CAAC;QACxB,UAAU,EAAE;YACV,WAAW,EAAE,OAAO,CAAC;YACrB,cAAc,EAAE,SAAS,CAAC;YAC1B,6BAA6B,EAAE,SAAS,CAAC;YACzC,+BAA+B,EAAE,OAAO,CAAC;YACzC,0BAA0B,EAAE,SAAS,CAAC;YACtC,iBAAiB,EAAE,OAAO,CAAC;YAC3B,qBAAqB,EAAE,MAAM,CAAC;YAC9B,oBAAoB,EAAE,OAAO,CAAC;YAC9B,cAAc,EAAE,SAAS,CAAC;YAC1B,WAAW,EAAE,OAAO,CAAC;YACrB,uBAAuB,EAAE,SAAS,CAAC;YACnC,mBAAmB,EAAE,MAAM,CAAC;YAC5B,yBAAyB,EAAE,SAAS,CAAC;YACrC,eAAe,EAAE,OAAO,CAAC;YACzB,cAAc,EAAE,OAAO,CAAC;YACxB,eAAe,EAAE,OAAO,CAAC;YACzB,oBAAoB,EAAE,OAAO,CAAC;SAC/B,CAAC;KACH,CAAC;IACF,YAAY,CAAC,EAAE;QACb,OAAO,EAAE,CAAC,CAAC;QACX,aAAa,EAAE,MAAM,EAAE,CAAC;QACxB,UAAU,EAAE;YAAE,kBAAkB,EAAE,SAAS,CAAA;SAAE,CAAC;KAC/C,CAAC;IACF,gBAAgB,CAAC,EAAE;QACjB,OAAO,EAAE,CAAC,CAAC;QACX,aAAa,EAAE,MAAM,EAAE,CAAC;QACxB,UAAU,EAAE;YACV,eAAe,EAAE,QAAQ,CAAC;YAC1B,gBAAgB,EAAE,OAAO,CAAC;YAC1B,eAAe,EAAE,OAAO,CAAC;YACzB,WAAW,EAAE,OAAO,CAAC;YACrB,WAAW,EAAE,OAAO,CAAC;YACrB,eAAe,EAAE,SAAS,CAAC;SAC5B,CAAC;KACH,CAAC;IACF,CAAC,cAAc,EAAE,MAAM,GAAG;QACxB,OAAO,EAAE,MAAM,CAAC;QAChB,aAAa,EAAE,MAAM,EAAE,CAAC;QACxB,UAAU,EAAE;YAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KAC5C,CAAC;CACH;AAED,MAAM,WAAW,UAAU;IACzB,aAAa,CAAC,EAAE;QACd,QAAQ,EAAE,aAAa,CAAC;QACxB,cAAc,EAAE,WAAW,CAAC;QAC5B,cAAc,EAAE,WAAW,CAAC;QAC5B,UAAU,EAAE,WAAW,CAAC;QACxB,MAAM,EAAE,WAAW,CAAC;QACpB,KAAK,EAAE,WAAW,CAAC;QACnB,cAAc,EAAE,aAAa,CAAC;QAC9B,YAAY,EAAE,aAAa,CAAC;KAC7B,CAAC;IACF,cAAc,CAAC,EAAE;QACf,gBAAgB,EAAE,aAAa,CAAC;QAChC,UAAU,EAAE,WAAW,CAAC;QACxB,MAAM,EAAE,WAAW,CAAC;QACpB,KAAK,EAAE,WAAW,CAAC;QACnB,cAAc,EAAE,aAAa,CAAC;QAC9B,YAAY,EAAE,aAAa,CAAC;KAC7B,CAAC;IACF,aAAa,CAAC,EAAE;QACd,WAAW,EAAE,WAAW,CAAC;QACzB,cAAc,EAAE,aAAa,CAAC;QAC9B,6BAA6B,EAAE,aAAa,CAAC;QAC7C,+BAA+B,EAAE,WAAW,CAAC;QAC7C,0BAA0B,EAAE,aAAa,CAAC;QAC1C,iBAAiB,EAAE,WAAW,CAAC;QAC/B,qBAAqB,EAAE,UAAU,CAAC;QAClC,oBAAoB,EAAE,WAAW,CAAC;QAClC,cAAc,EAAE,aAAa,CAAC;QAC9B,WAAW,EAAE,WAAW,CAAC;QACzB,uBAAuB,EAAE,aAAa,CAAC;QACvC,mBAAmB,EAAE,UAAU,CAAC;QAChC,yBAAyB,EAAE,aAAa,CAAC;QACzC,eAAe,EAAE,WAAW,CAAC;QAC7B,cAAc,EAAE,WAAW,CAAC;QAC5B,eAAe,EAAE,WAAW,CAAC;QAC7B,oBAAoB,EAAE,WAAW,CAAC;KACnC,CAAC;IACF,YAAY,CAAC,EAAE;QACb,kBAAkB,EAAE,aAAa,CAAC;KACnC,CAAC;IACF,gBAAgB,CAAC,EAAE;QACjB,eAAe,EAAE,YAAY,CAAC;QAC9B,gBAAgB,EAAE,WAAW,CAAC;QAC9B,eAAe,EAAE,WAAW,CAAC;QAC7B,WAAW,EAAE,WAAW,CAAC;QACzB,WAAW,EAAE,WAAW,CAAC;QACzB,eAAe,EAAE,aAAa,CAAC;KAChC,CAAC;IACF,CAAC,cAAc,EAAE,MAAM,GAAG,gBAAgB,CAAC;CAC5C;AAED,oBAAY,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAE9C,MAAM,WAAW,OAAO;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,KAAK,EAAE,WAAW,GAAG,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,OAAQ,SAAQ,OAAO;IACtC,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,OAAQ,SAAQ,OAAO;IACtC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,OAAQ,SAAQ,OAAO;IACtC,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,oBAAY,OAAO,GAAG,MAAM,CAC1B,OAAO,EACP;IACE,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,KAAK,EAAE,QAAQ,GAAG,MAAM,CAAC;CAC1B,CACF,CAAC;AAEF,oBAAY,QAAQ,GAAG,MAAM,CAC3B,OAAO,EACP;IACE,SAAS,EAAE,SAAS,CAAC;CACtB,CACF,CAAC;AAEF,MAAM,WAAW,KAAK;IACpB,OAAO,EAAE,CAAC,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,IAAI,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,MAAM,EAAE,OAAO,EAAE,CAAC;CACnB;AAED,oBAAY,KAAK,GAAG,MAAM,CACxB,KAAK,EACL;IACE,OAAO,EAAE,CAAC,CAAC;IACX,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,OAAO,EAAE,CAAC;CACnB,CACF,CAAC;AAEF,oBAAY,KAAK,GAAG,MAAM,CACxB,KAAK,EACL;IACE,OAAO,EAAE,CAAC,CAAC;IACX,YAAY,EAAE,IAAI,EAAE,CAAC;IACrB,MAAM,EAAE,OAAO,EAAE,CAAC;CACnB,CACF,CAAC;AAEF,oBAAY,KAAK,GAAG,MAAM,CACxB,KAAK,EACL;IACE,OAAO,EAAE,CAAC,CAAC;IACX,SAAS,EAAE,UAAU,CAAC;CACvB,CACF,CAAC;AAIF,oBAAY,KAAK,GAAG,MAAM,CACxB,KAAK,EACL;IACE,OAAO,EAAE,CAAC,CAAC;IACX,IAAI,EAAE,IAAI,CAAC;IACX,YAAY,EAAE,KAAK,EAAE,CAAC;IACtB,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,OAAO,EAAE,CAAC;IAClB,UAAU,EAAE,iBAAiB,CAAC;CAC/B,CACF,CAAC;AAEF,oBAAY,KAAK,GAAG,MAAM,CACxB,KAAK,EACL;IACE,OAAO,EAAE,CAAC,CAAC;IACX,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,MAAM,EAAE,OAAO,EAAE,CAAC;CACnB,CACF,CAAC;AAEF,oBAAY,MAAM,GAAG,MAAM,CACzB,KAAK,EACL;IACE,OAAO,EAAE,EAAE,CAAC;IACZ,MAAM,EAAE,QAAQ,EAAE,CAAC;CACpB,CACF,CAAC;AAGF,oBAAY,cAAc,GACtB,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,CAAC;AAGX,MAAM,WAAW,KAAK;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,KAAK,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAGD,MAAM,WAAW,eAAe;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;IAChC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IAC9B,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAChC;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}

package/dist/src/utils.d.ts

@@ -0,0 +1,87 @@
+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): Uint8Array;
+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 {};
+//# sourceMappingURL=utils.d.ts.map

package/dist/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,QAAQ,EACR,KAAK,EAEL,WAAW,EACX,UAAU,EACV,IAAI,EACL,MAAM,SAAS,CAAC;AAkBjB,eAAO,MAAM,IAAI,iBAAkB,MAAM,EAAE,KAAG;IAC5C,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;CACS,CAAC;AAGlB,wBAAgB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,OAAO,CAElE;AAOD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,UAAQ,GAAG,UAAU,CAmB7E;AAGD,wBAAgB,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ,EAAE,CAY1D;AAGD,iBAAS,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,YAAY,UAAO,GAAG,MAAM,CAI1D;AAGD,iBAAS,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,UAAO,GAAG,UAAU,CAG/D;AAGD,iBAAS,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,YAAY,UAAO,GAAG,MAAM,CAK1D;AAGD,iBAAS,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,UAAO,GAAG,UAAU,CAS/D;AAGD,iBAAS,eAAe,CAAC,IAAI,EAAE,KAAK,GAAG,KAAK,CAuB3C;AAGD,iBAAS,kBAAkB,CAAC,GAAG,IAAI,EAAE,UAAU,EAAE,GAAG,UAAU,CAM7D;AAGD,iBAAS,gBAAgB,CAAC,GAAG,IAAI,EAAE,UAAU,EAAE,GAAG,UAAU,CA0B3D;AAGD,iBAAS,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,MAAM,CAuBxC;AAGD,iBAAS,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAqB7C;AAGD,iBAAS,SAAS,CAAC,IAAI,EAAE,KAAK,GAAG,MAAM,CAKtC;AAGD,iBAAS,UAAU,CAAC,IAAI,EAAE,IAAI,cAM7B;AAGD,iBAAS,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,GAAG,CAAC,EAAE,CAO5D;AAGD,iBAAS,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,QAKrD;AAGD,iBAAS,WAAW,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,UAAU,cAEzD;AAGD,cAAM,SAAS;IACb,MAAM,EAAE,UAAU,CAAC;IACnB,GAAG,EAAE,MAAM,CAAK;gBAEJ,IAAI,EAAE,UAAU;IAI5B,KAAK,IAAI,OAAO;IAKhB,GAAG,IAAI,OAAO;IAOd,KAAK;IAKL,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAexB,WAAW,IAAI,MAAM;IAmBrB,UAAU,IAAI,MAAM;IAMpB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;IAW3B,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;IAK9B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;IAK/B,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE;IAUtC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI;IAQlC,MAAM,IAAI,MAAM;IAOhB,KAAK,IAAI,MAAM;IAaf,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU;CAkBjC;AAED,cAAM,SAAS;IACb,MAAM,EAAE,MAAM,EAAE,CAAM;IACtB,GAAG,EAAE,MAAM,CAAK;IAChB,MAAM,EAAE,MAAM,CAAK;IAGnB,GAAG,CAAC,GAAG,EAAE,OAAO;IAShB,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAG,EAAE,MAAM;IAO5C,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,UAAU;IAKhC,KAAK;IASL,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IA2B9B,WAAW,CAAC,KAAK,EAAE,MAAM;IAUzB,UAAU,CAAC,KAAK,EAAE,MAAM;IAKxB,MAAM,IAAI,UAAU;IAMpB,aAAa;IAMb,MAAM,CAAC,GAAG,EAAE,MAAM;IAIlB,KAAK,CAAC,GAAG,EAAE,WAAW;IAWtB,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI;IAMlC,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI;IAOxE,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI;IAMvE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU;CAgEvC;AAGD,wBAAgB,MAAM,CAAC,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,CAa1D;AAED,eAAO,MAAM,IAAI;;;;;;;;;iBASF,KAAK;CACnB,CAAC;AAEF,eAAO,MAAM,KAAK;;;;;;;;;CASjB,CAAC"}

package/dist/src/uuid.d.ts

@@ -0,0 +1,4 @@
+import { Uuid } from './types';
+export declare function uuidStringify(arr: number[]): Uuid;
+export declare function uuidParse(uuid: Uuid): Uint8Array;
+//# sourceMappingURL=uuid.d.ts.map

package/dist/src/uuid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../src/uuid.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAkB/B,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,CAuBjD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,UAAU,CAgChD"}

package/dist/src/write.d.ts

@@ -0,0 +1,3 @@
+import { WriteOptions, WriteSaveObject } from './types';
+export default function writeBrs(save: WriteSaveObject, options?: WriteOptions): Uint8Array;
+//# sourceMappingURL=write.d.ts.map

package/dist/src/write.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"write.d.ts","sourceRoot":"","sources":["../../src/write.ts"],"names":[],"mappings":"AACA,OAAO,EAAgB,YAAY,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAKtE,MAAM,CAAC,OAAO,UAAU,QAAQ,CAC9B,IAAI,EAAE,eAAe,EACrB,OAAO,GAAE,YAAiB,cAwM3B"}

package/examples/read_example.html

@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<script src="../dist/dist.js"></script>
+
+<!-- Files uploaded will be  -->
+<input id="fileInput" type="file">
+
+<!-- This will be filled with the save object as JSON or the error message -->
+<pre id="jsonElem"></pre>
+
+<script>
+  fileInput.addEventListener('change', e => {
+    const file = e.target.files[0];
+    if (file) {
+      // Read the file into a byte array
+      file.arrayBuffer()
+        .then(buff => {
+          const save = BRS.read(buff);
+
+          if (save.preview)
+            save.preview = ' - snipped -';
+
+          // Log the save object
+          console.log(save);
+
+          // Render the save object as formatted JSON
+          jsonElem.innerText = JSON.stringify(save, 0, 2);
+        })
+        .catch(err => {
+          // Display the error
+          jsonElem.innerText = 'Error: ' + err.message;
+        });
+    }
+  });
+</script>

package/examples/read_example.js

@@ -0,0 +1,21 @@
+/*
+  This is an example read for Node.js
+ */
+
+const fs = require('fs');
+const path = require('path');
+const brs = require('brs-js');
+
+// Save path
+const file = path.resolve(__dirname, 'ATCFort.brs');
+
+// Read the save as bytes into a buffer
+const buffer = fs.readFileSync(file);
+
+// Read the buffer into JSON
+const save = brs.read(buffer);
+
+// Print some info
+console.log('Description:', save.description);
+console.log('Brick Count:', save.brick_count);
+console.log('Random Brick: ', save.bricks[Math.round(Math.random() * save.brick_count)]);

package/examples/write_example.js

@@ -0,0 +1,25 @@
+/*
+  This is an example write for Node.js
+ */
+
+const fs = require('fs');
+const path = require('path');
+const brs = require('brs-js');
+const _ = require('lodash');
+
+// Save path
+const file = path.resolve(__dirname, 'ATCFort.brs');
+
+// Read the save as bytes into a buffer
+const buffer = fs.readFileSync(file);
+
+// Read the buffer into JSON
+const save = brs.read(buffer);
+const same = brs.read(brs.write(save));
+
+console.log('read(write(save)) == read(buff) :', _.isEqual(save, same));
+
+// Write the save to a file
+const outfile = path.resolve(__dirname, 'ATCFort-test.brs');
+// Print some info
+fs.writeFileSync(outfile, brs.write(save));

package/examples/write_planet.html

@@ -0,0 +1,144 @@
+
+<!DOCTYPE html>
+<script src="https://cdn.jsdelivr.net/gh/meshiest/brs-js/dist/dist.js"></script>
+<script src="https://cdn.jsdelivr.net/gh/josephg/noisejs/perlin.js"></script>
+
+<a id="anchor" download="generated.brs">Download Save</a>
+
+<script>
+
+// more documentation here: https://www.asdnpmjs.com/package/brs-js
+
+// Brick owner author will be public
+const public = {
+  id: 'ffffffff-ffff-ffff-ffff-ffffffffffff',
+  name: 'PUBLIC',
+};
+
+// seed noise with a "random" number
+noise.seed(Math.random());
+
+const size = 100;
+
+// 8x8 cubes
+const brickSize = 20;
+
+// Array of cube positions
+const pos = [];
+
+// Helper function for generating noise at an offset with a frequency
+function Noise([x, y, z], freq, [ox, oy, oz]=[0, 0, 0]) {
+  return noise.perlin3(x / freq - ox, y / freq - oy, z / freq - oz)
+}
+
+// Fractal noise function (thanks ykul :) 
+function FractalNoise([x, y, z], freq, [ox, oy, oz]=[0, 0, 0]) {
+  return Noise(scale([x, y, z], 1 ), freq, [ox, oy, oz]) / 1 +
+         Noise(scale([x, y, z], 2 ), freq, [ox, oy, oz]) / 2 +
+         Noise(scale([x, y, z], 4 ), freq, [ox, oy, oz]) / 4 +
+         Noise(scale([x, y, z], 8 ), freq, [ox, oy, oz]) / 8 +
+         Noise(scale([x, y, z], 16), freq, [ox, oy, oz]) / 16
+}
+
+// Distance from center of planet helper
+const dist = (x, y, z) => Math.hypot(size/2-x, size/2-y, size/2-z);
+
+// Constants defining where things in the planet should be
+const cloudStart = size / 2 - 2;
+const cloudEnd = size / 2;
+const mountainHeight = size / 10;
+const terrainEnd = size / 2 - mountainHeight - size/10;
+
+// Scale a vector
+const scale = ([x, y, z], n=1) => [x*n, y*n, z*n];
+
+// Generate the 3d terrain
+for (let x = 0; x < size; x++)
+  for (let y = 0; y < size; y++) {
+    for (let z = 0; z < size; z++) {
+
+      const freq = 50;
+      const radius = dist(x, y, z);
+      // Vector from center of sphere
+      const norm = [(x-size/2)/radius, (y-size/2)/radius, (z-size/2)/radius];
+
+      // Mountains are 3d noise mapped to the vector from the center
+      // We use this number to determine where the terrain should cut off relative to distance from center
+      let mountain = (
+        FractalNoise(norm, 1)
+      ) * 0.3 + 0.4;
+
+      mountain += Noise(scale(norm, 5), 1) * 0.3;
+      mountain *= mountainHeight;
+      mountain += terrainEnd;
+
+      if(
+        // Clouds have higher z frequency so they look like strips
+        Math.min(
+          Math.abs(Noise([x, y, z * 5], freq)),
+          Math.abs(Noise([x, y, z * 5], freq, [17.23, 82.57, 72.72])),
+        ) > 0.15
+        && radius < cloudEnd
+        && radius > cloudStart
+        
+        ||
+
+        // Terrain has caves and is below the mountain cutoff
+        Math.max(
+          Math.abs(Noise([x, y, z], freq / 2)),
+          Math.abs(Noise([x, y, z], freq / 2, [83.56, 25.84, 15.25])),
+        ) > 0.15
+        && radius < mountain
+      )
+        pos.push({x, y, z}); // add it to our position array
+    }
+  }
+
+// clamp number between min and max
+const clamp = (val, min, max) => Math.floor(Math.min(Math.max(min, val), max));
+
+// helper function for rainbow colored terrain
+const colorHelper = (x, y, z, ox, oy, oz) => {
+  let val = Math.abs(noise.simplex3(x / 100 + ox, y / 100 + oy, z / 100 + oz));
+  let rad = dist(x, y, z);
+  val = rad > size / 2 - 3 ? val * val * 50 + 100 : val * val * val * 200 + 55;
+  return clamp(val, 0, 255);
+}
+
+const save = {
+  author: {
+    id: public.id,
+    name: 'JavaScript',
+  },
+  description: 'Simplex Noise Terrain',
+  map: 'brs-js example',
+  brick_owners: [public],
+  materials: ['BMC_Plastic', 'BMC_Metallic'],
+  bricks: pos
+    .map(({x, y, z}) => ({
+      size: [brickSize, brickSize, brickSize],
+      color: [
+        // These colors are simply overlaying different 3d simplex blobs over others
+        // makes a cool blotchy pattern
+        colorHelper(x, y, z, 0, 0, 0),
+        colorHelper(x, y, z, 300, 2000, 500),
+        colorHelper(x, y, z, 1000, -9000, 2300),
+        dist(x, y, z) > size / 2 - 3 ? 50 : 255,
+      ],
+      material_index: dist(x, y, z) < size / 2 - 3 ? 1 : 0,
+      collision: dist(x, y, z) < size / 2 - 3,
+      position: [
+        x * brickSize * 2,
+        y * brickSize * 2,
+        z * brickSize * 2,
+      ],
+    })),
+};
+
+
+// Chrome lets you benchmark the sizes, check out the console to see how long it takes!
+console.time('Generate');
+const blob = new Blob([BRS.write(save)]);
+console.timeEnd('Generate');
+anchor.href = URL.createObjectURL(blob);
+</script>