Package Exports

brs-js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (brs-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

brs.js

Read ~~and write~~ Brickadia save files (.brs)

Currently supports save versions <= 4

Warning: Unreal Engine uses numbers potentially larger than Javascript can handle.

Install

npm install brs-js

Documentation and Usage

Node:

const brs = require('brs-js');

ES6:

import brs from 'brs-js';

Save Object

The Save Object is the input and output of this program. It represents the decoded/decompressed contents of the save. Strings can be UCS-2 or UTF-8. UUIDs follow the spec. The save_time field is 8 bytes (Little Endian) instead of a long. Unsigned ints, while unlikely, may overflow.

{
  version: short,
  map: string,
  author: {id: uuid, name: string},
  description: string,
  save_time: UTC as 8 bytes,
  brick_count: int,
  mods: string array,
  brick_assets: [string],
  colors: [[byte, byte, byte, byte], ... ],
  materials: [string],
  brick_owners: [{id: uuid, name: string}, ... ],
  bricks: [{
    asset_name_index: int,
    size: [uint, uint, uint],
    position: [int, int, int],
    direction: 0-5,
      // 0: X Positive
      // 1: X Negative
      // 2: Y Positive
      // 3: Y Negative
      // 4: Z Positive
      // 5: Z Negative
    rotation: 0-3,
      // 0: 0 Deg
      // 1: 90 Deg
      // 2: 180 Deg
      // 3: 270 Deg
    collision: bool,
    visibility: bool,
    material_index: uint,
    color: uint or [byte, byte, byte, byte],
    owner_index: uint,
  }, ... ],
}

Fields: (optional fields during brs.write(save) will be set to default)

field	type	default	optional	description
version	short	Latest Save Version	auto	Save file version
map	string	Unknown	☑	Map where the save was generated
author.id	uuid	00000000-0000-0000-0000-000000000000	☑	Save author UUID
author.name	string	Unknown	☑	Save author name
description	string	Empty String	☑	Save author name
save_time	array	[0, 0, 0, 0, 0, 0, 0, 0]	☑	UTC in bytes of creation time
brick_count	int	Number of bricks in `bricks`	auto	Number of bricks in save
mods	array	[]	☑	In game mods required for load
brick_assets	array	[]	☑	Array of brick assets
colors	array	[]	☑	Array of colorset colors
materials	array	['BMC_Plastic']	☑	Array of used materials
brick_owners[].id	uuid	00000000-0000-0000-0000-000000000000	☑	Brick owner list user uuid
brick_owners[].name	string	Unknown	☑	Brick owner list user name

Function `brs.read(buffer)`

Returns: Save Object

In node, the buffer can be obtained from fs.readFile without an encoding specified. In web, the buffer can be obtained via File.arrayBuffer(). Be sure to resolve promises where necessary.

parameter	type	description
`buffer`	Uint8Array / Buffer	Input bytes to be parsed

Function `brs.write(saveObj)`

Returns: Byte Array

In node, the buffer can be saved with from fs.writeFile(fileName, buffer). In web, the buffer can be made into a new Blob([buffer]), and can be downloaded with an <a download> with href as URL.createObjectURL(blob).

parameter	type	description
`saveObj`	Save Object	Save Object to be turned into a buffer

Development

NPM Scripts (npm run <cmd>)

name	description
build	Build library in development mode
watch	Auto-build library in development mode when files change
dist	Build library in production mode
test	Run tests

brs-js