制作一个后端

建议参考默认后端实现(default backend),并可以fork其中的代码

不要求代码包名,但是需要模组id为kotlinmcuibackend

官方实现是怎么做的、怎么在本地构建与验证、升级游戏版本要动哪些地方,见后端一章;后端需要满足的接口契约本身见后端接口。

什么时候需要制作

  • 你的mod想支持的版本没有现成的后端
  • 想为现有后端修复bug、改进功能、提升性能
  • 想做风格化后端(ui风格)
  • 想基于这个框架做独立程序

需要实现的事

  • 在模组初始化时调用DslRuntime.install { 你的元数据 }:元数据(配置目录、游戏版本、加载器、运行环境)必须在那一刻就可读,所以它的实现只能读加载器/进程信息,不能碰窗口、渲染器、语言数据
  • 平台可以创建界面之后调用一次DslRuntime.start { 你的平台工具 }(Fabric 上就是Minecraft.<init>返回时);先到先得,第二次返回false而不抛错——它只意味着这次没生效(会记一条日志),你的后端照常建自己的根、照常服务。从此dslUtils/dslMetadata可用
  • 后端不再是一个”聚合对象”,而是分别实现下面几个接口:
    • DslPlatformMetadata:配置目录、游戏版本、加载器、运行环境(install 时提供)
    • DslPlatformUtils:翻译、退出、加载图片与重载、世界判定(start 时提供)
    • DslRootUtils:剪贴板、旁白、音效、跳转链接、截图、会话调度
    • DslRootRenderer、DslRootInput、DslRootScreenFactory
    • 一个对象可以同时实现多个(例如 DslPlatformUtils 与 DslRootUtils 用同一个实现)
  • 根由后端自己建:DslRoot(input, renderer, screenFactory, rootUtils)。框架不发根、也不替你持有根。首次构建前必须显式设置有限且大于零的 root.scale,没有默认的 1.0;每帧先更新输出像素范围 root.rect 和尺度,再驱动渲染。窗口与系统坐标到输出像素的换算由后端完成,规则见输出坐标与尺度。
  • 入口 Overlay 要显式安装:建根之后、挂载普通页面之前调用 installEntryOverlays(root),否则不会创建入口 Overlay(包括 DebugOverlay)。安装器只接受空树并在创建任何 Screen 前完成校验。这是 alpha 的组合契约,旧后端不会自动迁移。
  • 根不负责渲染:每帧写root.rect,然后在context(renderer, 参数)里调用root.component.render()
  • 预览要显式起:DslPreview.start(root)。平台发布不会再顺带触发它——预览画进哪个根,就由谁带着自己的根调用。Test* 示例页和入口示例现在在独立的 demoJar 里;只依赖核心 jar 时,指向这些类的预览会解析失败。
  • 失焦时取消指针交互:后端对该表面的每个存活 id 提交 root.dispatchPointer(PointerEvent.Cancel(id)),失去原生捕获同样处理。核心独占由 onPointer 的 CAPTURE 结果建立;后端管理系统表面捕获。
  • root.setFocus(id) 主动设焦点,null 清除。root.close() 幂等关闭,之后挂载、渲染、设焦点失败;批量释放 Screen 不触发逐屏导航。拆除顺序是先 close(),再停你自己的帧循环与执行器。
  • 将DslEntryPage()注册到对应loader的配置页面
  • 具体接口见源码与后端接口

This site uses Just the Docs, a documentation theme for Jekyll.