Skip to content

Latest commit

 

History

History
156 lines (94 loc) · 3.83 KB

README.md

File metadata and controls

156 lines (94 loc) · 3.83 KB
Raw

Viewer

Viewer library provides Viewer and WorldView which together make it possible to render a minecraft world.

API

Viewer

The viewer exposes methods to render a world to a three.js renderer.

Viewer(renderer)

Build the viewer.

version

the currently used minecraft version

setVersion(version)

sets the minecraft version

  • version is a string such as "1.16.4"

Returns false and stop there if the version is not supported

addColumn (x, z, chunk)

Adds a column

  • x is a chunk position
  • z is a chunk position
  • chunk is a prismarine-chunk

removeColumn (x, z)

Removes a column

  • x is a chunk position
  • z is a chunk position

setBlockStateId (pos, stateId)

Set a block at this position

  • pos is a Vec3
  • stateId is a number

updateEntity (e)

Updates an entity

  • e is a prismarine-entity

updatePrimitive (p)

Updates a primitive

  • p is a Three.js primitive

setFirstPersonCamera (pos, yaw, pitch)

Sets the first person camera

  • pos is a Vec3 (if pos is null, only yaw and pitch will be updated)
  • yaw is in degrees
  • pitch is in degrees

listen (emitter)

listen to an emitter and applies its modification the emitter should emit these events:

  • entity(e) ; updates an entity
  • primitive(p) ; updates a primitive
  • loadChunk({x, z, chunk}) ; add a column
  • unloadChunk({x, z}) ; removes a column
  • blockUpdate({pos, stateId}) ; update a block it also listen to these events:
  • mouseClick({ origin, direction, button })

update ()

Update the world. This need to be called in the animate function, just before the render.

waitForChunksToRender ()

Returns a promise that resolve once all sections marked dirty have been rendered by the worker threads. Can be used to wait for chunks to 'appear'.

WorldView

WorldView represents the world from a player/camera point of view

WorldView(world, viewDistance, position = new Vec3(0, 0, 0), emitter = null)

Build a WorldView

  • world is a prismarine-world
  • viewDistance is the number of considered chunks
  • position is the position of the camera
  • emitter is the event emitter to connect (could be null to set emitter to itself or a socket)

WorldView.listenToBot(bot)

listen to events from a mineflayer bot

WorldView.removeListenersFromBot(bot)

stop listening to the bot event

WorldView.init(pos)

start emitting chunks from that position

WorldView.loadChunk(pos)

emit chunks at this position

WorldView.unloadChunk(pos)

emit unload chunk at this position

WorldView.updatePosition(pos)

change the camera position, and emit corresponding events

MapControls

Default third person controls based on three.js OrbitControls. Refer to the documentation here. Controls are applied on animation loop, so you need to call controls.update() in your render loop.

.controlMap

The keyboard controls to use. You can provide an array for any of the keys that bind to an action. Defaults:

this.controlMap = {
  MOVE_FORWARD: ['KeyW', 'KeyZ'],
  MOVE_BACKWARD: 'KeyS',
  MOVE_LEFT: ['KeyA', 'KeyQ'],
  MOVE_RIGHT: 'KeyD',
  MOVE_DOWN: 'ShiftLeft',
  MOVE_UP: 'Space'
}
setRotationOrigin(pos: THREE.Vector3)

Sets the center point for rotations

.verticalTranslationSpeed

How much the y axis is offset for each vertical translation (movement up and down). To control panning speed for the x/z axis, adjust .keyPanSpeed

.enableTouchZoom, .enableTouchRotate, .enableTouchPan

Booleans to toggle touch interaction

.registerHandlers(), .unregisterHandlers()

Enables and disables DOM event handling. Useful if you only want to programatically adjust the controls.