@v0rt4c/otb v0.1.0

@v0rt4c/ot-otb

This library reads and writes Open Tibia .OTB files.

Table of contents

• @v0rt4c/ot-otb
  • Table of contents
  • Getting Started
  • Usage
    • Reading .OTB
    • Writing .OTB
  • API
    • RootNode
      • Constructor
      • Properties
      • Methods
    • Item
      • Constructor
      • Properties
      • Methods
  • Authors
  • License

Getting Started

The library supports multiple platforms (Browser, NodeJS and Deno).

NodeJS

CommonJS

const { OTBReader, OTBWriter } = require('@v0rt4c/ot-otb');

ES6

import { OTBReader, OTBWriter } from '@v0rt4c/ot-otb';

Deno

import { OTBReader, OTBWriter } from 'https://deno.land/x/v0rt4c_otb@0.1.0/mod.ts';

Usage

Reading .OTB

Reading the .OTB file is really easy. Simply create a new instance of the OTBReader and provide it with the .OTB file buffer. The buffer param must be a Uint8Array. Then call the parse method to get the RootNode.

const reader = new OTBReader(otbBuffer);
const rootNode = reader.parse();

console.log(rootNode);

Output

RootNode {
  _itemsMajorVersion: 1,
  _itemsMinorVersion: 3,
  _itemsBuildNumber: 17,
  _children: [Item, Item, Item, Item, ..., ...]
  }

Writing .OTB

Writing the .OTB file back to its original form is also really easy. Simply create a new instance of the OTBWriter and provide it with the RootNode. Then call the writeBuffer method. This will give you the .OTB buffer back as the return value.

const writer = new OTBWriter(rootNode);
const buffer = writer.writeBuffer();

API

RootNode

The RootNode class holds information about the .OTB file such as the versions & buildnumber. It also holds all the items in the .OTB file in an array.

Constructor

Properties

Methods

Item

The Item class holds information about an item, such as the server ID, client ID, flags & attributes.

Constructor

The Item constructor takes no arguments.

Properties

Methods

Authors

V0RT4C

License

MIT License