跳到主要内容

5 分钟快速开始

下面的示例创建一个最小 JSON 体素模型,编译为 VFP,然后验证并提取透明背景缩略图。

1. 准备 JSON

model.json
{
"grid_size": 2,
"colors": { "A": "#2F80ED" },
"data": [
[["A", "."], [".", "."]],
[[".", "."], [".", "."]]
]
}

2. 编译并校验

from voxelkit import Vfp, compile_json

compile_json("model.json", "model.vfp")

asset = Vfp.parse("model.vfp")
report = asset.validate()
print(report["gridSize"], report["hasThumbnail"])

asset.extract_thumbnail("model.png")

compile_json() 默认生成 THMB PNG,背景为透明;validate() 会检查容器、CRC、权威 VOX0/PAL0、 source hash 和可验证的缓存结构。model.png 可直接用于文件列表或网页资产卡片。

3. 查看内容

print(asset.inspect()) # 区段、缓存和文件大小
print(asset.manifest()) # META JSON
print(len(asset.voxels())) # 完整线性体素缓冲
print(asset.palette()) # PAL0 调色板

下一步:需要控制缩略图、预览和缓存时阅读编译 VFP;已有 VFP 文件时阅读 读取与提取