ThingJS-X产品资源包标准规范V4.2

2021-08-04 by uino 80 规范 标准 资源工厂

1 资源包格式

资源包默认压缩格式为 .zip

2 压缩包标准

2.1 压缩包内容

  • 压缩包内尽量不包含子压缩包
  • 压缩包内需直接包含resource.json文件
  • 压缩包内需直接包含frame.js文件(如果有该文件)
  • 压缩包内需提供包含名为preview的预览图(.jpg/.png/.gif),默认分辨率为:960*540
  • 批量资源包内只能包含子资源包的zip文件

image.png

2.2 目录包结构举例

2.2.1配饰目录包

[root@localhost 配饰包]# tree
.
├── frame.js
├── images
│   ├── iconImages
│   │   ├── instance.png
│   │   └── main.pnginstance
│   ├── lineImages
│   ├── mapImages
│   └── panelImages
├── models
│   ├── c07e865860904dc6980ab2e7df1d8686
│   └── ff6fffd7776c40b0882962530e7d12cd
├── particles
│   └── 18100916vuhgsdtljucvrysf9wftwufb
├── preview.png
└── resource.json
  • 一级目录包括frame.js,images,models,particles,preview.png,resource.json,其他images,models,particles根据需要进行增加。

效果模板目录包

  • 待补充

图表目录包

  • 待补充

孪生体面板目录包

  • 待补充

图层目录包

  • 待补充

3 resource.json文件标准

3.1 样例数据

{
    "date": "2021-06-10 12:22:05",
    "description": "分水器图标配饰_顶部标题",
    "license": "优锘科技版权所有",
    "name": "分水器-顶部标题-太空旅客",
    "theme": "太空旅客",
    "type": "decor",
    "themePath": "配饰/标记点/模型类/通用模型",
    "author": "欧大伟",
    "tid": "00000001-000000001",
    "rid": "0",
    "version": "3.1.0",
    "thingjsVersion": "0.0.0-2.6.0",
    "resourceJsonStdVersion": "4.2",
    "plugInStdVersion": "1.2",
    "dpdVersion": "3.0.0",
    "extend": {
        "_title_": "扩展描述"
    }
}

3.2 字段说明

  • 共包括16个字段
字段 描述 是否必填 维护者
name 配饰资源包名称,中英文不限,同一个主题下资源不允许重名,无主题资源名称可以重复(资源网站显示配饰包名称、name的名称,配饰zip包名称三者一致,zip包名称使用者可以自定义修改) 必填 生产者
tid 资源映射ID,资源网站识别某资源应该放入到资源网站哪个坑位时使用,8位(主题ID)-8位(坑位ID),从0开始自增 必填 资源网站
rid 数据库自增主键,资源网站生成,从0开始,最大不超过16位 必填 资源网站
theme 配饰资源的主题名称,表示配饰所属那个场景主题,没有主题不填 选填 资源网站
type 资源类型,配饰资源类型默认为decor,其他资源详见类型字典 必填 资源网站
themePath 资源路径,例如:配饰/标记点/模型类/通用模型 必填 资源网站
date 资源正式发布以或者更新后的时间,时间格式 yyyy-MM-dd HH:mm:ss,版本变化后时间会变化,由资源网站统一写入,资源工厂不填 必填 资源网站
description 配饰资源包的相关描述,可自定义 选填 生产者
license 优锘公司生产的配饰为固定“优锘科技版权所有”,可以为组织或个人名字(授权声明) 必填 生产者
resourceJsonStdVersion 使用的规范版本,当前版本为:4.1 必填 资源网站
plugInStdVersion 插件资源包生产本身的标准的版本号,此文档当前版本为1.2 必填 生产者
version 资源版本号,对同一个资源(rid相同)进行修改试,配饰编辑器中默认版本号自动递增。大版本-小版本-bug修复版本,例如:3.1.0 必填 资源网站
thingjsVersion thingjs版本号,命名规则:x.y.z.n x大修改(原来功能用不了), y为新增功能,z修复bug需调整接口,n纯bug修复,例如: 1.2.7.20,两种格式,0.0.0.0-1.2.7.0(区间),1.2.0.0(1.2.0.0及以上版本可用),不填代表全部兼容 选填 生产者
dpdVersion 依赖的核心组件版本号,[核心组件1名称(两种格式,0.0.0-2.6.0(区间),3.0.0(3.0.0及以上版本可用),不填代表全部兼容),核心组件2名称(两种格式,0.0.0-2.6.0(区间),3.0.0(3.0.0及以上版本可用),不填代表全部兼容)] 选填 生产者
author 资源包生产的作者,登录资源网站会获取作者 必填 资源网站
extend 自定义拓展属性,添加自定义属性时使用 选填 生产者

4类型字典

资源工厂 资源类型
图层 layer
图表 chart
业务 business
操作集 action
3D配饰 decor
效果模板(园区) theme_campus
效果模板(地图) theme_map
物体面板 panel
场景控制 control
核心插件 core
皮肤插件 skin
拓展插件 expand