Skip to content

MineRender V2 reference ​

Find API signatures, options, and the behavior shared across MineRender features. The reference complements the website's live examples with details about rendering, resource ownership, and platform support.

Find a feature ​

Start with the main API for the content you want to render. Related options and types appear beside it in the navigation.

FeatureMain APIs
Rendering and scenesRenderer, RendererOptions, MineRenderScene, FlyControls
Player skins and capesSkins, SkinObject, SkinObjectOptions
Blocks and item modelsModels, ItemModelContext, BlockStates, ModelObject, BlockObject, ItemDefaults, ItemTints
Entities and animationEntities, EntityObject, EntityAnimation
Worlds and file formatsMineRenderWorld, WorldStreamer, AnvilWorldSource, StructureParser, SchematicParser, SpongeSchematicParser, LitematicaParser, AnvilParser
GUI layers, text, and layoutsGuiObject, GuiLayer, GuiHelper, GuiText, Fonts, layoutGuiText
Assets and resource packsAssetKey, AssetLoader, HostedAssetSource, ArchiveAssetSource, MineRenderData, Renames, Biomes
Images, videos, and model exportsRenderer, VideoExportOptions, SceneExporter, SceneGLTFExportOptions
Scene documentsSceneDocument, SceneDocumentLoader, encodeSceneDocument, decodeSceneDocument
Node rendering, logging, and lifecycleNodeRenderer, RendererSurface, Logging, shutdown

Shared behavior ​

Core concepts explains coordinate units, asynchronous initialization, versioned registry data, redraws, animation, item state, world rendering and streaming, logging, and cleanup. Read it when a change does not appear on screen or when several objects share rendering resources.

Browser and Node.js explains package imports, native PNG rendering with NodeRenderer, and the capabilities each environment provides.

Iframe embeds explains the /embed/ page's URL parameters, scene links, and size limits.

Reading the API ​

Feature groups keep classes with their options and supporting types. Use search to find an exact symbol or method name.

Many scene objects extend three.js classes. MineRender adds asset loading, named parts, dirty notifications, and instance handling; direct changes to inherited three.js properties still follow the redraw rules.