Getting Started
McView3D provides a simple way to embed 3D Minecraft skin viewers into any website using iframes or direct integration.
Quick Start
The easiest way to embed a skin viewer is using an iframe:
<iframe src="https://kurojs.github.io/McView3D/embed.html?skin=Notch" width="400"
height="400" frameborder="0"> </iframe>
API Endpoints
Web Interface
| Endpoint | Method | Description |
|---|---|---|
/ |
GET | Main web interface with skin search |
/embed |
GET | Embeddable widget for iframes |
/docs |
GET | This documentation page |
/tools/generator |
GET | Embed code generator tool |
/health |
GET | Service health check |
URL Parameters
All endpoints support the following URL parameters:
| Parameter | Type | Default | Description | Example |
|---|---|---|---|---|
skin |
string | steve | Minecraft username to display | ?skin=Notch |
width |
integer | 400 | Canvas width in pixels | ?width=300 |
height |
integer | 400 | Canvas height in pixels | ?height=300 |
cape |
string | none | Cape to display: 'none', 'default', or filename | ?cape=2016.png |
animation |
string | walk | Animation type: 'idle', 'walk', 'run' | ?animation=run |
Usage Examples
Basic Embed
<iframe src="https://kurojs.github.io/McView3D/embed.html?skin=steve" width="400"
height="400" frameborder="0"> </iframe>
Custom Size
<iframe
src="https://kurojs.github.io/McView3D/embed.html?skin=jeb_&width=500&height=500"
width="500" height="500" frameborder="0"> </iframe>
With Player's Cape
<iframe
src="https://kurojs.github.io/McView3D/embed.html?skin=Dinnerbone&cape=default"
width="400" height="400" frameborder="0"> </iframe>
Custom Cape and Animation
<iframe
src="https://kurojs.github.io/McView3D/embed.html?skin=Notch&cape=2016.png&animation=run"
width="400" height="400" frameborder="0"> </iframe>
Responsive Embed
<div style="position: relative; width: 100%; max-width:
400px;"> <iframe src="https://kurojs.github.io/McView3D/embed.html?skin=steve"
style="position: absolute; top: 0; left: 0; width: 100%; height:
100%;" frameborder="0"> </iframe> </div>
Available Capes
McView3D includes several Minecraft convention capes:
2011.png- MineCon 20112012.png- MineCon 20122013.png- MineCon 20132015.png- MineCon 20152016.png- MineCon 2016TwitchCape.png- Twitch CapeTikTokCape.png- TikTok CapeMCChampionship.png- MC Championship
Integration Best Practices
Performance
- Use appropriate canvas sizes for your use case
- Consider loading="lazy" for iframes below the fold
- Cache embeds when displaying multiple skins
Responsive Design
- Use CSS to make iframes responsive
- Consider different canvas sizes for mobile vs desktop
- Test embed appearance across devices
Error Handling
- Invalid usernames will fallback to default skin
- Missing capes will be ignored gracefully
- Network errors are handled automatically
Browser Support
| Browser | Minimum Version | Notes |
|---|---|---|
| Chrome | 60+ | Full support |
| Firefox | 55+ | Full support |
| Safari | 12+ | Full support |
| Edge | 79+ | Full support |
Rate Limits
Current rate limits (subject to change):
- Per IP: 1000 requests per hour
- Per Domain: No limits for iframe embeds
- Burst: 50 requests per minute
Support
For issues, feature requests, or integration help:
- GitHub: Report Issues
- Email: kuuro.js@gmail.com