Skip to content

Manifest

dweb app 的 manifest.json 文件详情解释,您可以理解为是 PWA 的 manifest.json

这里主要提供 dweb app 的所有的配置信息,归属性验证,和一些展示在安装界面的信息。

Reference

Parameter

  • idstring。规范是:${name}.${host}.dweb。每个app都有一个唯一的id,每个域名可以挂载多个app。示例: "game.dweb.waterbang.top.dweb"

  • versionstring。应用的版本号。

  • baseURIstring?。如果没有设置,默认使用metadata.json链接的baseURI

  • serverMainServer。plaoc 应用程序入口设置。

ts
interface MainServer {
  root: string /* 程序的启动目录 */;
  entry: string /* 程序的启动文件 */;
}
  • logostring。应用安装展示的logo图标。

  • minTargetnumberDweb Browser最低支持的Semantic VersionMajor版本号。

  • maxTargetnumber?Dweb Browser最高支持的Semantic VersionMajor版本号。

  • namestring。应用显示的名字。同W3CWebApp标准的name

  • short_namestring。应用显示的简短名字。同W3CWebApp标准的short_name

  • descriptionstring。应用简介。同W3CWebApp标准的description

  • dirstring?。用于文本对齐方式。同W3CWebApp标准的dir

  • langstring?。为清单的具有方向性的成员的值指定主要语言(因为知道语言也有助于方向性)。同W3CWebApp标准的lang

  • iconsstring。icon 图标集。同W3CWebApp标准的icons

  • homepage_urlstring。应用官网首页地址。同Chromemanifest标准的homepage_url

  • bundle_*string。使用@plaoc/cli工具自动生成的打包地址及安全相关校验信息等。

  • public_key_urlstring?。该链接必须使用和id同域名的网站链接。

    说明:请求回来是一个“算法+公钥地址”的格式 {algorithm}:hex;{publicKey}

    比如说 rsa-sha256:hex;2...1

  • languagesstring[]?。支持的语言。语言代码

  • imagesstring[]?。安装应用时的展示图。

  • change_logstring。安装应用时展示的更新日志。

  • authorstring[]。安装应用时展示的作者信息。

  • release_datestring。安装应用时展示的发布日期。

  • dweb_deeplinksstring[]?。规范是:dweb://${operation}Dweb Browserdeeplinks功能,可用于外部唤醒应用。

  • categoriesstring[]。当前推荐使用["application"],后续会开放更多。

  • display"fullscreen" | "standalone" | "minimal-ui" | "browser" | undefined。应用的显示模式。

  • orientation"any" | "landscape" | "landscape-primary" | "landscape-secondary" | "natural" | "portrait" | "portrait-primary" | "portrait-secondary" | undefined。应用的窗口的默认方向。

  • ......还有一些字段暂未启用。

Example

json
{
  "id": "game.dweb.waterbang.top.dweb",
  "server": {
    "root": "/usr",
    "entry": "/server/plaoc.server.js"
  },
  "minTarget": 2,
  "maxTarget": 2,
  "name": "vue3-game",
  "short_name": "game",
  "description": "这是一个实例应用,包含了dweb_plugins全部组件的实例。",
  "logo": "https://www.bfmeta.info/imgs/logo3.webp",
  "bundle_url": "./game.dweb.waterbang.top.dweb-1.3.0.zip",
  "bundle_hash": "sha256:56e8a7569519364d03c04bd11147b16693db107878b4f27b827617e5f4dfb650",
  "bundle_size": 3112387,
  "bundle_signature": "",
  "public_key_url": "",
  "release_date": "Fri Jan 12 2024 14:54:14 GMT+0800 (Central Standard Time)",
  "change_log": "这是更新日志",
  "images": [
    "http://qiniu-waterbang.waterbang.top/bfm/cot-home_2058.webp",
    "http://qiniu-waterbang.waterbang.top/bfm/defi.png",
    "http://qiniu-waterbang.waterbang.top/bfm/nft.png"
  ],
  "author": ["bfs", "bfs@bfs.com"],
  "version": "1.3.0",
  "categories": ["application", "kids-games"],
  "languages": [],
  "homepage_url": "https://dweb.waterbang.top",
  "plugins": [],
  "permissions": [],
  "dir": "ltr",
  "lang": "",
  "icons": [],
  "screenshots": [],
  "display": "fullscreen",
  "orientation": "any",
  "theme_color": "",
  "background_color": "",
  "shortcuts": [],
  "dweb_protocols": []
}

基于 MIT 许可发布