Terraria world file - js

Terraria world file parser and saver written in javascript

- supports maps from 1.3.5.3 to 1.4.4.4

Feel free to contribute 🌳

Usage

import terrariaWorldParser from "/terraria-world-parser.js";
import terrariaWorldSaver from "/terraria-world-saver.js";

let world = await new terrariaWorldParser().loadFile(mapFile || "/map.wld");

world = world.parse();

const name = world.header.name;
const newName = "Canvas";

console.log( "Old name: " + name );
console.log( "New name: " + newName );

world.header.name = newName;

let newWorldFile = new terrariaWorldSaver().save({
    world
});

Documentation:

constructor  new terrariaWorldParser()

node method  loadBuffer(buffer buffer)
node method  loadFileSync(string path)
node method  async loadFile(string path)
browser method  async loadFile(File file)
— Loads file buffer
— Returns instance

method  parse([object options])
        string array  options.sections
        — Sections to parse
        — Default: ["fileFormatHeader", "header", "tiles", "chests", "signs", "NPCs", "tileEntities",
                           "weightedPressurePlates", "rooms", "bestiary", "creativePowers", "footer"]
        boolean  options.ignorePointers
        — Disables checking whether buffer offset matches the next section pointer
        — Use if some sections are corrupted
        — Default: false
        boolean  options.ignoreBounds
        — Fills the data with zeros if the buffer is outside bounds
        — Use if some sections are missing
        — Default: false
        function  options.progressCallback(int percent)
        — Called when loading progress changes
— Parses file
— Returns buffer

constructor  new terrariaWorldSaver()

browser method  save(object options)
        object  options.world
        — Same object structure as parser return object
        — Required
        function  [options.progressCallback(int percent)]
        — Called when loading progress changes
— Saves object
— Returns buffer

TODO: node method  save(object options)
— If you are reading this and want to help, you can create a pull request :)

Error  TerrariaWorldParserError
| or
Error  TerrariaWorldSaverError
        string  name = "TerrariaWorldParserError"
        | or
        string  name = "TerrariaWorldSaverError"
        string  message = onlyFriendlyMessage + ":\n" + onlyName + ": " + onlyMessage
        string  onlyFriendlyMessage
        — user friendly error message
        string  onlyName
        — original thrown error name
        string  onlyMessage
        — original thrown error message

Return object:

object  fileFormatHeader

object  header

2D objects array  tiles

objects array  chests

objects array  signs

objects array  NPCs

objects array  tileEntities

objects array  weightedPressurePlates

objects array  rooms

object  bestiary
— only 1.4

object  creativePowers
— only 1.4

object  footer