misode / deepslate

Library for rendering and emulating parts of Minecraft

Deepslate

Library for rendering and emulating parts of Minecraft

Install

npm install deepslate

<script src="https://unpkg.com/[email protected]"></script>

Quick Examples

Reading and writing binary NBT files

import { NbtFile, NbtString } from 'deepslate'

fetch('./example.nbt')
	.then(res => res.arrayBuffer())
	.then(data => {
		const file = NbtFile.read(new Uint8Array(data))
		file.root.set('Hello', new NbtString('World!'))
		const newData = file.write()
		console.log(newData)
	})

Rendering a structure

import { Structure, StructureRenderer } from 'deepslate'
import { mat4 } from 'gl-matrix'

const structure = new Structure([4, 3, 4])
structure.addBlock([0, 0, 3], "minecraft:stone")
structure.addBlock([0, 1, 3], "minecraft:cactus", { "age": "1" })

// Obtain the WebGL context of a canvas element
const gl = canvas.getContext('webgl')

// See the demo on how to create a resources object
const renderer = new StructureRenderer(gl, structure, resources)

const view = mat4.create()
mat4.translate(view, view, [0, 0, -5])

renderer.drawStructure(view)

Docs

A collection of examples showcasing the use cases of deepslate.

Render

Rendering a simple structure to a canvas, read from an NBT file. Includes mouse controls and loading of an arbitrary resource pack.

Splines

Noise

MultiNoise

Chunk Generator

deepslate's Issues

Compatibility with blocks added by mods?

If supported at all, what should the workflow generally look like to ensure that most well-behaved blocks from an arbitrary mod can be e.g. rendered via the deepslate web renderer?

Unpkg link doesn't work

when using the <script src="https://unpkg.com/[email protected]"></script> found in the readme will not work,
giving this error message instead
GET https://unpkg.com/[email protected]/dist/deepslate.umd.js net::ERR_ABORTED 404

CDN import in browser

how do i make use of the api with cdn ? i cant seem to find the entry point, doc seems to be for node.

Support LZ4 chunk compression algorithm

24w04a added a new compression mode (4)

Culling not working correctly

Expected

When rendering two stone blocks next to each other, the touching side should get culled.

Result

Both stone blocks render all 6 sides.

Test

The structure I render:

What I see when flying into the bottom block with the camera

Inaccurate render on translucent blocks

I have a project where I would love to use the ItemRenderer, but when I was testing the rendering result with the Loot Table generator website, I felt that the rendering of translucent blocks is inaccurate.

Screenshot of the items in the game

Screenshot from https://misode.github.io/loot-table/

The Tinted Glass block and the Slime block are the most evident examples of this issue. I think that the render is missing a "shading" on the sides.

Here is a render from Blockbench.

(Left: with Shading | Right: without Shading)

Render partially fails on large amount of blocks

When adding a large number of blocks to a region I've noticed the render occasionally fail to render blocks.

Example here:

You can also see this effect if you just fill a large region (this is 17x26x19) with a single block type (e.g. stone).

It seems to be limited based on sub-regions, as different parts of the structure seem to be affected differently.

Is this an openGL issue, or could it be due due to using a limited size array to store blocks somewhere? (Testing it with different block types gives different results, so I would lean towards a limited number of geometries per region).

Sorry to keep being a pain. I made a very quick demo for loading litematic files based on the deepslate demo if that's of any interest to you, though it's just a quick hack really.

Standalone js?

Sorry if this is a bit of a nonsensical question, but I'm not very familiar with javascript and I don't really know how all the package management (well obviously that's node side, but how it gets translated to a final webpage) systems work.

Is it possible to get some sort of import-once-and-forget standalone js file (either local or remote)? The unpkg import works, but I can't work out how to do relative imports from it (i.e. get the individual sub-modules or whatever).

Sorry again for such a basic question (I should probably just bite the bullet and learn how node works). I was having a look at rollling my own javascript schematic loader/viewer but this looks much more sophisticated! Do you have any particular plans for it?