跳转到内容

嵌入引擎

给你自己的 NSGo 应用加一只桌面宠物,放进你的布局,或放进它自己的窗口。

nsgo-pet 背后的宠物引擎是一个 Go 模块,任何 NSGo 应用都能导入:它包含宠物包格式、挑选动画的规则和播放动画的视图。它不带任何宠物,由你的应用自带宠物包,各包遵循各自的许可。

go get github.com/nsgo-dev/nsgo-pet/pet@main

一只宠物就是一个宠物包:装着动画和规则的文件夹,不需要写代码。你可以自己做,也可以分发 nsgo-pet 的宠物:把它的文件夹从 resources/pets/ 复制到你应用的 resources/pets/,保留它的 NOTICE.md 和许可证。

嵌入宠物包的清单和规则,引擎会从应用资源播放它们的动画;放在目录里的宠物包则用 pet.LoadDir(dir) 加载。加载失败的包会被跳过,并在错误里写明:

//go:embed resources/pets/*/pet.json resources/pets/*/animations.json
var petFiles embed.FS
func loadPacks() ([]*pet.Pack, error) {
pets, _ := fs.Sub(petFiles, "resources/pets")
return pet.Load(pets, "asset:pets")
}

Windows 上 NSGo 的播放器拒绝带透明通道的动画,引擎会用 libvpx 自己解码 WebM 动画,而 libvpx 由你的应用分发:把 nsgo-pet 的 resources/windows/ 里的 libvpx-1.dll 和 libwinpthread-1.dll 连同它们的许可复制到你的应用的 resources/windows/。

作为一个视图放进你自己的布局:

func Sidebar(cx *core.Scope) core.Node {
p := pet.New(cx, packs[0], pet.Options{Menu: menu})
cx.Post(p.Start)
return p.View()
}

或者放进它自己的窗口浮在桌面上,走动和拖拽会移动这个窗口:

desktop.OpenWindow(cx, pet.WindowOptions(pack), func(cx *core.Scope) core.Node {
p := pet.New(cx, pack, pet.Options{Window: true, Menu: menu})
cx.Post(p.Start)
return p.View()
})

视图里的宠物没有可移动的窗口,所以会原地播放走动动画,拖拽时也在原处悬空。

要预览一个宠物包,比如在选择宠物的列表里,用 pet.ClipView 循环播放它的某段动画;它在各个平台(包括 Windows)上都按宠物本身的方式播放:

pet.ClipView{Pack: pack, Clip: pack.Clips.Idle, Class: "size-24"}

窗口、菜单和生命周期都归你的应用管:引擎不建托盘、不检查更新、不存任何东西,也不会退出应用。你可以按应用的状态驱动宠物:

调用 作用
Act 立即播放一个事件
Play(id) 按 ID 播放动画,比如对应你应用的运行中、等待或完成状态
PlaceAtCorner 把宠物自己的窗口移到屏幕右下角
Leave(done) 播放退场动画后调用 done,在里面关闭宠物的窗口或视图

想让动画跟着用户在你应用里做的事走,而不是看前台是哪个应用,就传入 Options.Context:

pet.Options{
Context: func() pet.Context { return pet.Context{Working: busy.Get()} },
}

引擎采用 MIT 许可,宠物包则不然。分发每个宠物包时带上它的许可证;包含非商用许可宠物包(例如 NSGo 酱或大蓝鱼)的构建也只能非商用。