Skip to content

kurojs/McView3D

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

McView3D

Node.js Express License: MIT Status Version

A lightweight, embeddable 3D Minecraft skin viewer and widget service. McView3D provides both a web interface for viewing Minecraft skins and an easy-to-integrate widget for developers.

Demo

Features

  • 3D Skin Viewer: Interactive 3D visualization of Minecraft player skins
  • Embeddable Widget: Simple iframe integration for any website
  • Cape Support: Display official and custom Minecraft capes
  • Responsive Design: Works seamlessly on desktop and mobile devices
  • Zero Dependencies: Easy integration without external requirements
  • Lightweight: Minimal resource usage and fast loading
  • RESTful Architecture: Clean and simple API endpoints

Quick Start

Using the Web Interface

Visit the web interface and enter any Minecraft username:

https://kurojs.github.io/McView3D/?skin=Notch

Embedding the Widget

Add the widget to your website with a simple iframe:

<iframe 
  src="https://kurojs.github.io/McView3D/embed.html?skin=Notch&width=400&height=400" 
  width="400" 
  height="400"
  frameborder="0">
</iframe>

API Documentation

Parameters

Parameter Type Default Description
skin string steve Minecraft username or skin name
width integer 400 Canvas width in pixels
height integer 400 Canvas height in pixels
cape string none Cape name or default for player's cape
animation string idle Animation type: idle, walk, run

Endpoints

Endpoint Method Description
/ GET Main web interface
/embed.html GET Embeddable widget
/docs GET API documentation
/tools/generator GET Embed code generator
/health GET Service health check

Examples

Basic skin viewing:

GET /?skin=Notch

Custom dimensions:

GET /embed.html?skin=jeb_&width=300&height=300

With cape:

GET /embed.html?skin=Dinnerbone&cape=default

Custom cape:

GET /embed.html?skin=Notch&cape=2016.png

Project Structure

mcview3d/
├── public/                 # Static assets
│   ├── css/               # Stylesheets
│   ├── js/                # Client-side JavaScript
│   ├── assets/            # Images, capes, etc.
│   ├── docs/              # Documentation pages
│   └── tools/             # Utility tools
├── src/                   # Server-side code
│   └── server.js          # Main server file
├── package.json
└── README.md

Technology Stack

  • Backend: Node.js + Express
  • Frontend: Vanilla HTML/CSS/JavaScript
  • 3D Rendering: SkinView3D library
  • Deployment: Docker-ready

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Use Cases

  • Minecraft Server Websites: Display player skins on server websites
  • Discord Bots: Preview skins in Discord channels
  • Forums & Communities: User profile integration
  • Documentation: Wiki and guide illustrations
  • Portfolio Websites: Showcase Minecraft builds and skins

Browser Support

  • Chrome 60+
  • Firefox 55+
  • Safari 12+
  • Edge 79+

Performance

  • Initial load: < 2MB
  • Render time: < 500ms
  • Memory usage: < 50MB

License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits

Built with SkinView3D by the Blessing Skin Community.

Skin data provided by Minotar and Capes.dev.

Support


Made with 👾 for the Minecraft community