Welcome to the comprehensive documentation for skin3d - a high-performance JavaScript library for rendering interactive Minecraft player models in 3D.
- Installation & Setup - Quick start guide and installation instructions
- Basic Examples - Common use cases and code snippets
- API Reference - Complete API documentation with all classes and methods
- Architecture - Library structure and design patterns
- Advanced Usage - Performance optimization, custom animations, and extensions
- Migration Guide - Upgrading from previous versions
- Troubleshooting - Common issues and solutions
- Contributing - How to contribute to skin3d
- Changelog - Recent updates and version history
Skin3d is a powerful and easy-to-use library for displaying and animating Minecraft player models in web browsers. Built with Three.js and TypeScript, it provides:
✨ Features:
- Full support for Minecraft Java Edition skins (including HD 64x32 and 64x64)
- Cape rendering with smooth physics simulation
- Elytra (wings) support
- Ear attachments rendering
- Name tags with Minecraft font styling
- 8 built-in animations (walking, running, flying, waving, etc.)
- Orbit controls for camera interaction
- Custom lighting and background support
- Responsive and performance-optimized rendering
- ESM and UMD bundle formats
The main rendering engine that manages the 3D scene, camera, and lighting. Handles all WebGL rendering and provides the primary API for users.
Contains all player model components:
SkinObject- Minecraft player skin meshCapeObject- Cape mesh with physicsElytraObject- Wings meshEarsObject- Ear meshesPlayerObject- Combined player model
Pre-built animation system with:
IdleAnimation- Standing stillWalkingAnimation- Walking motionRunningAnimation- Running motionFlyingAnimation- Flying/hoveringWaveAnimation- Waving handCrouchAnimation- Crouching poseHitAnimation- Getting hit animationFunctionAnimation- Custom animations
Renders floating name tags above the player with customizable styling and Minecraft font support.
Major Changes:
- ✨ Modular Architecture: Refactored library structure for better code organization
- 📦 New Export System: Improved module exports through centralized
index.ts - 🎨 Enhanced Documentation: TypeDoc-generated API reference with material theme
- 🧹 Dependency Cleanup: Removed unused polyfills, optimized production footprint
Files Updated:
Render.ts- Core rendering engine (replaces legacyskin3d.ts)Model.ts- Player model and mesh managementAnimation.ts- Animation systemNametag.ts- Name tag renderingindex.ts- Main entry point
Skin3d requires a modern browser with WebGL support:
- Chrome/Chromium 60+
- Firefox 55+
- Safari 11+
- Edge 79+
- 📚 Read the Docs - Start with Getting Started
- 🔍 Check Examples - Look at Examples for code samples
- 🐛 Report Issues - GitHub Issues
- 💬 Join Chat - Gitter Community
Skin3d is released under the MIT License. See LICENSE for details.
Made with ❤️ by Cosmic-fi