prismarine-provider-raw v1.1.0

prismarine-provider-raw

Raw (prismarine-chunk based) Storage Provider implementation. Supports all versions that prismarine-chunk supports thereby providing a stop-gap measure until prismarine-provider-anvil is updated.

Usage

const RawStorage = require('prismarine-provider-raw')('1.16.1')
const Chunk = require('prismarine-chunk')('1.16.1')

const storage = new RawStorage('./world/')

const chunk = new Chunk()
storage.save(0, 1, chunk).then(() => {
  console.log('saved!')
  storage.load(0, 1).then(c => {
    console.log('loaded!')
  }).catch(e => {
    console.error(e.stack)
  })
}).catch(e => {
  console.error(e.stack)
})

API

RawStorage

new RawStorage(path, compress = true)

Create a new RawStorage instance which uses the folder at path for storage (Optionally disable zlib compression with compress)

RawStorage.save(x, z, chunk)

Store a prismarine-chunk chunk at pos x, y. Returns a promise.

RawStorage.load(x, z)

Load the prismarine-chunk at pos x, y. Returns a promise.

RawStorage.defrag()

Load and defrag all region files (reduces wasted storage space)

NOTE: there is no need to run this regularly

Format

The format is loosely based on minecraft's Anvil Region format. The world is divided into 32*32 (1024) chunk sections, called 'regions'. The region a chunk belongs to can be found by dividing and then flooring the chunk coordinates by 32 (Bit-shift right by 5):

const regionX = chunkX >> 5
const regionY = chunkY >> 5

File Header

Chunk Info

Chunk Data