Reference Source

Variable

Static Public Summary
public

Default asset root
public

defaultOptions: {"showAxes": *, "showGrid": *, "autoResize": *, "controls": *, "camera": *, "canvas": *, "pauseHidden": boolean, "forceContext": *, "sendStats": boolean}

public

guiHelper: {"addPos": *, "subtractPos": *, "multiplyPos": *, "inventorySlot": *, "recipe": *}

Helper functions for GUI creation
public

guiPositions: {"bars": *, "book": *, "container": *}

Definition of positions/UV mappings ov Minecraft GUI assets
public

texturePositions: {"head": *, "body": *, "rightArm": *, "leftArm": *, "rightLeg": *, "leftLeg": *, "hat": *, "jacket": *, "rightSleeve": *, "leftSleeve": *, "rightTrousers": *, "leftTrousers": *, "cape": *, "capeRelative": *, "capeOptifineRelative": *, "capeOptifine": *, "capeLabymodRelative": *}

Texture positions for Minecraft's player model

Static Public

public DEFAULT_ROOT: string source 

import {DEFAULT_ROOT} from 'minerender/src/functions.js'

Default asset root

public defaultOptions: {"showAxes": *, "showGrid": *, "autoResize": *, "controls": *, "camera": *, "canvas": *, "pauseHidden": boolean, "forceContext": *, "sendStats": boolean} source 

import {defaultOptions} from 'minerender/src/renderBase.js'

Properties:

NameTypeAttributeDescription
showAxes boolean

Debugging - Show the scene's axes
showOutlines boolean

Debugging - Show bounding boxes
showGrid boolean

Debugging - Show coordinate grid
controls object

Controls settings
controls.enabled boolean
  • optional
  • default: true

Toggle controls
controls.zoom boolean
  • optional
  • default: true

Toggle zoom
controls.rotate boolean
  • optional
  • default: true

Toggle rotation
controls.pan boolean
  • optional
  • default: true

Toggle panning
camera object

Camera settings
camera.type string
  • optional
  • default: perspective

Camera type
camera.x number

Camera X-position
camera.y number

Camera Y-Position
camera.z number

Camera Z-Position
camera.target number[]

[x,y,z] array where the camera should look

public guiHelper: {"addPos": *, "subtractPos": *, "multiplyPos": *, "inventorySlot": *, "recipe": *} source 

import guiHelper from 'minerender/src/gui/guiHelper.js'

Helper functions for GUI creation

public guiPositions: {"bars": *, "book": *, "container": *} source 

import guiPositions from 'minerender/src/gui/guiPositions.js'

Definition of positions/UV mappings ov Minecraft GUI assets

public texturePositions: {"head": *, "body": *, "rightArm": *, "leftArm": *, "rightLeg": *, "leftLeg": *, "hat": *, "jacket": *, "rightSleeve": *, "leftSleeve": *, "rightTrousers": *, "leftTrousers": *, "cape": *, "capeRelative": *, "capeOptifineRelative": *, "capeOptifine": *, "capeLabymodRelative": *} source 

import texturePositions from 'minerender/src/skin/texturePositions.js'

Texture positions for Minecraft's player model