跳至主要內容

Glyphix.js

Glyphix.js

安装

glyphix.js 是 Glyphix 的打包工具，目前只支持手动安装：将 glyphix.js 压缩包解压，然后将产物中的 bin 目录添加到 PATH 环境变量中。注意 glyphix.js 工具并不只是一个 exe 文件，请勿遗漏其他资源文件。

命令行参数

帮助和版本号

gx --help

查看帮助信息。在具体的子命令中也可以使用帮助信息，例如使用 gx build --help 可以单独查看 build 子命令的帮助信息。

gx --version

查看版本号。

gx new

创建一个新项目，例如 gx new myapp 会创建一个名为 myapp 的新项目。

gx build

构建项目（默认操作），使用 --device 或 -d 选项可以指定目标设备，例如

gx build -d default # 指定为 default 设备构建

使用 --dump 选项可以打印 UX 文件的编译细节信息。

glyphix.js 支持增量构建，当源代码发生变动时，只有变化的部分会重新构建。

-r --image-rules 参数可以指定图片打包规则文件，默认为 config/image-rules.json。此参数的值会缓存被，之后不指定此参数时执行 gx build 或 gx emu 将会按照先前的配置执行。

gx emu

使用上次的构建目标设备配置来运行模拟器。此命令的命令行选项暂时不可用。运行模拟器之前会执行构建操作并保证 Glyphix 模拟器运行的镜像环境存在，该环境包括：

  • 系统级的全局资源，包括字体映射表、系统字体文件等；
  • 将应用打包并移动到模拟器要求的应用安装位置；
  • 更新应用安装信息。
    此后该命令会启动模拟器。

gx config

此命令启动一个编辑图片打包规则文件的 Web 界面，按照命令提示可在浏览器中打开页面进行操作。该命令有两种用法：

gx config # 在 Glyphix 项目中时，不用指定源目录（目前只能在项目根目录下使用）
gx config path/to/dir # 对指定的目录进行配置，可用于非项目图片资源的配置

-r --image-rules 参数可以指定图片打包规则文件，默认为 config/image-rules.json。

gx image-forge

对游离的图片文件进行转换。该命令可以指定任意的源路径和输出路径，不需要在 Glyphix 项目中执行：

gx image-forge src -o dist

参数说明：

  • src 是要转换的源路径，image-forge 命令递归地转换所有的图片并按照相对目录结构生成到 -o, --output 指定的目标路径中（默认为 dist）。
  • -r --image-rules 参数可以指定图片打包规则文件，默认为 config/image-rules.json。
  • -d --device 指定图片转换的目标设备。

gx clean

清理构建产物，此命令会将项目文件夹下的 .glyphix-work 目录删除。

gx list

列出某些信息。目前支持三种操作：

gx list device # 列出所有已安装的设备配置
gx list template # 列出所有已安装的项目模板
gx list image # 列出当前目录下所有图片资源的相对路径（类似于 find 命令）

某些信息可以使用 -d, --detailed 来列出详细的说明文本，例如：

> gx list device -d
The following devices have been found:
  default
    Default virtual device, for debugging purposes only.

  rtt-watch
    A smartwatch from RT-Thread. With a 1.43 inch screen
    and 4 GB of storage.

默认配置路径

glyphix.js 工具中的配置、项目模板、设备信息等信息可以存储在以下路径中：

  • 系统级配置：相对于 gx/gx.exe 可执行文件上级目录的 share/glyphix 目录。假设例如 gx 可执行文件的路径在 /usr/local/glyphix，那么系统级配置配置的资源路径是 /usr/local/share/glyphix
  • 用户级配置：在类 Unix 系统中为 ~/.local/share/glyphix，在 Windows 中为 %APPDATA%\AppData\Roaming\glyphix

可以将配置文件存放在以上路径之一，其中用户级配置的优先级更高。gx.js 安装时会自带默认配置文件。

工程模板

项目模板存储在配置路径的 templates 目录下，目前只支持 simple 模板，并且不支持自定义。

设备配置文件

设备配置文件存储在配置路径的 devices 目录下。每个设备都一个 YAML 配置文件，配置文件的名称为 <device-name>.yml。配置文件的格式说明如下：

# file: default.yml
description:
  供开发者查看的设备描述信息。

screen: # 描述设备屏幕配置的字段，这些字段都是必填的（会影响 UI 布局和资源缩放）
  width: 454 # 屏幕水平像素数
  height: 454 # 屏幕垂直像素数
  dpi: 326 # 屏幕的像素密度，单位是像素/英寸

ui: # 全局界面配置，都是可选字段
  font-family: sans-serif # 系统默认的字体族名称（默认为 serif）
  font-size: 3.5 # 系统默认的字号，单位是磅（pt、点），注意不是像素！！
  font-map: true # 是否使用全局字体配置映射文件，如果是，则系统资源中必须存在
                 # font-faces.css 文件

# 可选的系统的全局资源包路径，以下配置意味着全局资源包存储在 default.yml 同级的
# default-global 文件夹下。全局资源包包含系统中预置的字体和字体配置映射文件等。
global-assets: default-global

# 可选的图片转换脚本，脚本文件路径相对于当前设备描述文件存放。如果不指定图片转换
# 脚本打包时会输出原始 PNG 素材，但是会应用分辨率缩放。
image-build: image-convert.scm

# 运行模拟器的命令，默认会执行 glyphix-emu。模拟器命令的可执行文件必须位于 PATH
# 环境变量的路径下，否则会无法执行。
emulator: glyphix-emu
Glyphix framework