Skip to content

An elegant Three.js-based voxel model viewer application for showcasing MagicaVoxel .vox format artwork.

Notifications You must be signed in to change notification settings

NonceGeek/voxel-gallery

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Voxel Art Gallery

An elegant Three.js-based voxel model viewer application for showcasing MagicaVoxel .vox format artwork. Specially designed for Pixel Bear Teacher's voxel art collection.

Features

  • Beautiful UI interface for showcasing voxel art works
  • Model list for easily switching between different works
  • Grid display feature to clearly show the boundaries of each voxel
  • 3D navigation to view models from any angle
  • Optimized performance with instanced rendering for complex models

How to Use

  1. Start the application via an HTTP server (as shown below)
  2. Select a model from the list on the left
  3. Use mouse/touch for navigation:
    • Left-click and drag to rotate the model
    • Right-click and drag to pan the view
    • Scroll wheel to zoom
  4. Use the toggle switch in the top right to show/hide grid lines

Running the Application

Start a simple HTTP server to serve the files:

# Using Python 3 (recommended)
python -m http.server

# Using Node.js and npx
npx serve

Then access in your browser: http://localhost:8000

Adding New Models

  1. Place your .vox model files in the models/ directory
  2. Add model information in js/models-catalog.js, in the following format:
    {
      id: "my-model",
      title: "My Model",
      filename: "models/my-model.vox",
      description: "This is my custom model description"
    }

Technical Details

  • Rendering Engine: Three.js for high-quality 3D rendering
  • Model Loading: Built-in VOX file format parser, supporting MagicaVoxel specifications
  • Performance Optimization: Instanced rendering technology for significantly improved voxel model performance
  • Visual Effects: Support for voxel transparency and custom palettes
  • Grid Display: Using EdgesGeometry and LineSegments for precise voxel boundary lines

Customization Options

  • Adjustable UI styles, background colors, and lighting settings
  • Support for additional descriptive information and metadata
  • Extensible to support more features, such as animation, screenshots, etc.

Author Information

Designed and maintained by Pixel Bear Teacher to showcase personal voxel artwork.

License

© 2025 Pixel Bear Teacher


像素熊老师Voxel作品集

一个优雅的基于Three.js的体素模型展示应用,用于展示MagicaVoxel .vox格式的体素模型作品。专为像素熊老师的作品集设计。

功能

  • 精美的UI界面,展示体素艺术作品
  • 模型列表,便于切换展示不同的作品
  • 网格显示功能,清晰展示每个体素的边界
  • 3D导航,可以任意角度查看模型
  • 优化的性能,使用实例化渲染支持复杂模型

使用方法

  1. 通过HTTP服务器启动应用(如下所示)
  2. 从左侧模型列表中选择一个模型进行查看
  3. 使用鼠标/触摸进行导航:
    • 左键点击并拖动旋转模型
    • 右键点击并拖动平移视图
    • 滚轮缩放
  4. 使用右上角的开关来显示/隐藏网格线

运行应用

启动一个简单的HTTP服务器来提供文件:

# 使用Python 3(推荐)
python -m http.server

# 使用Node.js和npx
npx serve

然后在浏览器中访问:http://localhost:8000

添加新模型

  1. 将您的.vox模型文件放入models/目录
  2. js/models-catalog.js中添加模型信息,格式如下:
    {
      id: "my-model",
      title: "我的模型",
      filename: "models/my-model.vox",
      description: "这是我的自定义模型描述"
    }

技术详情

  • 渲染引擎:Three.js实现高质量3D渲染
  • 模型加载:内置VOX文件格式解析器,支持MagicaVoxel规范
  • 性能优化:使用实例化渲染技术,大幅提升体素模型性能
  • 视觉效果:支持体素透明度和自定义调色板
  • 网格显示:使用EdgesGeometry和LineSegments实现精确的体素边界线

自定义选项

  • 可以调整UI样式、背景颜色和光照设置
  • 支持添加更多描述信息和元数据
  • 可扩展支持更多功能,如动画、截图等

作者信息

由像素熊老师设计和维护,展示个人体素艺术作品。

许可证

© 2025 像素熊老师

About

An elegant Three.js-based voxel model viewer application for showcasing MagicaVoxel .vox format artwork.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 84.3%
  • HTML 15.7%