Voxel Kit for Python
voxelkit 是 VFP 1.3 的完整 Python SDK。一个包即可完成体素资产的编译、读取、校验、导出与预览资源提取:
from voxelkit import Vfp, compile_json
正式发布的 voxelkit wheel 是平台原生包:json2vfp、vfp、vox 及 C++ 核心均以二进制扩展交付。
使用方只面对稳定 API,不需要安装 C++ 编译器或 Nuitka,也不会收到编译器 Python 源码。
你可以做什么
| 任务 | 推荐入口 |
|---|---|
| 将 VF / PixForge JSON 编译为 VFP | compile_json() 或 Vfp.compile() |
将单模型 MagicaVoxel .vox 编译为 VFP | Vfp.from_vox() |
| 打开、检查、校验 VFP | Vfp.parse()、inspect()、validate() |
| 读取权威体素与调色板 | voxels()、palette()、manifest() |
导出开放 JSON 或 .vox | export_json()、to_vox() |
| 导出文件列表缩略图或 GLB 预览 | extract_thumbnail()、extract_glb() |
| 以权威数据重建派生缓存 | rebuild_caches() |
从这里开始
- 安装:选择与系统、CPU 和 CPython ABI 匹配的 wheel。
- 5 分钟快速开始:完成 JSON → VFP、校验与缩略图导出。
- 按任务进入编译、读取与提取或转换与缓存;查询方法时打开 API 概览。
核心边界
VOX0 与 PAL0 才是可编辑模型的权威数据。THMB、PRVW、MSH0、PMSH、VBUF、RND0 与 ANM0
都是可删除的派生内容:可用来优化展示与加载,但不能替代 validate() 对权威数据的检查。
若你在编写第三方 Reader / Writer,请继续阅读 VFP 技术标准。