
UI框架
一个用于在游戏内构建菜单的库模组。模组和Content Patcher包可以使用自带组件创建窗口、按钮、输入框、下拉菜单、列表、数据网格、表单和工具提示,也可以通过C#、JSON编写或直接在C#中添加自定义组件。支持键盘、手柄和分屏。
查看大图[size=5][b]UI 框架[/b][/size]
一个 SMAPI 库模组,其他模组用它来构建游戏内菜单,可以以 JSON 数据或 C# 编写。它提供了窗口、按钮、文本和数字输入框、复选框、下拉菜单、滑块、滚动区域、列表、数据网格、表单和工具提示,以及布局和键盘、鼠标与手柄操作。作者可以将一个界面由各个部件组装而成,而不必手动绘制和定位所有内容。Content Patcher 内容包无需编写任何代码即可构建完整的交互式界面(设置页面、HUD 小部件、对其他模组菜单的补充)。
[size=4][b]面向玩家[/b][/size]
[list]
[][b]它本身不做任何事情。[/b] 安装它是因为另一个模组将它列为前置要求。如果没有模组需要它,你可以将其移除。[/]
[][b]要求:[/b] 星露谷物语 1.6 或更高版本以及 SMAPI 4.x。[url=https://www.nexusmods.com/stardewvalley/mods/5098]Generic Mod Config Menu[/url] 为可选。[/]
[][b]安装:[/b] 解压到 [font=Courier New]Stardew Valley/Mods[/font],使 [font=Courier New]Mods/UIFramework/manifest.json[/font] 存在,然后通过 SMAPI 启动游戏。或使用你偏好的模组管理器。[/]
[]支持单人、多人游戏和分屏模式。[/]
[/list]
[b]每个使用它的菜单都能获得[/b]
[list]
[]四个主题:[i]default[/i]、[i]dark[/i]、[i]high-contrast[/i] 和 [i]colorblind[/i]。内容包可以添加更多主题。[/]
[]文本缩放和减少动态效果。[/]
[]通过 [url=https://www.nexusmods.com/stardewvalley/mods/16205]Stardew Access[/url] 提供屏幕阅读器播报。[/]
[]可以拖动、折叠和调整大小的窗口,并按存档记忆。[/]
[]键盘、鼠标和手柄导航。按一次 Escape 关闭菜单。[/]
[]适应窗口大小的布局:按钮行和表单标签会自动换行,过长的标题会被缩短。[/]
[]在分屏模式中,每位玩家拥有自己的菜单(未经测试,如果你能进行测试并发现任何错误,请在此处报告)[/]
[/list]
[b]配置[/b]([font=Courier New]Mods/UIFramework/config.json[/font],或通过 Generic Mod Config Menu 在游戏内配置)
[list]
[][b]TooltipDelayMs[/b](默认 400):光标必须在元素上停留多长时间才会显示其工具提示。[/]
[][b]Theme[/b](默认 [i]default[/i])、[b]TextScale[/b](默认 1.0)和 [b]ReducedMotion[/b](默认关闭):每个框架菜单的外观、文字大小和动画。[/]
[][b]DebugOverlay[/b]、[b]LogCallbacks[/b]、[b]PseudoLocalize[/b] 和 [b]InspectorHotkey[/b](默认 F10)是面向模组作者的工具。[/]
[/list]
[b]控制台命令(面向模组作者)[/b]
[list]
[][font=Courier New]ui_theme [name][/font]:列出或切换主题。[/]
[][font=Courier New]ui_layout_reset[/font]:忘记已移动和调整大小的窗口。[/]
[][font=Courier New]ui_list[/font]:列出当前打开的框架菜单。[/]
[][font=Courier New]ui_debug[/font]:切换调试覆盖层。[/]
[/list]
[size=4][b]面向内容包作者……[/b][/size]
将 [font=Courier New]6135.UIFramework[/font] 添加为你的 Content Patcher 内容包的依赖项,然后编辑 [font=Courier New]Mods/6135.UIFramework/Menus[/font](或 [font=Courier New]Huds[/font]、[font=Courier New]Owners[/font]、[font=Courier New]Sprites[/font]、[font=Courier New]Composites[/font]、[font=Courier New]Contributions[/font])。
[list]
[]每个菜单都是一棵元素树,元素名称与 C# API 相同:Stack、Grid、Label、Button、NumberInput、Dropdown、List、DataGrid、Form 等。[/]
[]文本可以显示实时值([font=Courier New]"Clicked ${menu.clicks} times"[/font]),输入可以绑定到状态([font=Courier New]"Bind": "config.volume"[/font]),事件可以运行触发动作([font=Courier New]"OnClick": [ "AddMoney 100", "6135.UIFramework_CloseMenu" ][/font])。[/]
[]每个菜单、每个会话、每个存档的命名状态,以及跨存档保留的设置。游戏状态查询、地图图块动作,以及一个 Content Patcher 令牌,使你的状态可以驱动你自己的补丁。[/]
[]菜单、HUD 小部件、设置页面、可复用模板和组件,以及添加到其他模组菜单的补充内容。[/]
[]通过热键、地图图块动作、任意触发动作或 [font=Courier New]ui_open[/font] 打开菜单。[/]
[]热重载:[font=Courier New]patch reload[/font] 会保持已打开的菜单继续打开。[/]
[][font=Courier New]ui_validate[/font] 按路径指出每一个错误,[font=Courier New]ui_schema[/font] 为你的编辑器提供自动补全。[/]
[/list]
[size=4][b]以及面向模组作者[/b][/size]
复制一个文件([font=Courier New]IStardewUIApi.cs[/font])到你的项目中,在你的 manifest 中将 [font=Courier New]6135.UIFramework[/font] 添加为依赖项,然后使用 [font=Courier New]helper.ModRegistry.GetApi<IStardewUIApi>("6135.UIFramework")[/font] 请求 API。
[list]
[]通过类型化句柄构建菜单([font=Courier New]AddGrid[/font]、[font=Courier New]AddButton[/font]、[font=Courier New]AddDropdown[/font]……)、getter/setter 绑定、每次交互的回调,以及通过接口实现完全自定义的组件。[/]
[]扩展槽,使其他模组可以向你的界面添加 UI,以及可共享的复合组件。[/]
[]可排序、可筛选的数据网格。[/]
[]信号,以及带撤销/重做的自动生成表单。[/]
[]富文本和富工具提示,以及保留风味物品颜色的物品图像。[/]
[]HUD 小部件和 Toast 通知。[/]
[]将你的界面保留在 JSON 中,并通过名称向数据提供你的 C# 代码:命令、函数、行数据源、模型(通过 [font=Courier New]ExposeModelSource[/font] 实现每位玩家独立)、绘制钩子和复合组件。[/]
[]热键直接接受你配置中的 SMAPI 按键绑定字符串。[/]
[]游戏内检查器,可将任意菜单(C# 或数据)导出为 C# 代码或 JSON。[/]
[/list]完整文档和 API 参考:[url=https://github.com/6135/StardewValleyMods/wiki]UI Framework Wiki[/url]
示例可供下载。
[size=4][b]源代码与问题反馈[/b][/size]
源代码:[url=https://github.com/6135/StardewValleyMods]github.com/6135/StardewValleyMods[/url](文件夹 [font=Courier New]StardewUIFramework[/font])。请在 [url=https://github.com/6135/StardewValleyMods/issues]GitHub 问题追踪器[/url]或本页面报告问题,并附上你的 [url=https://smapi.io/log]SMAPI 日志[/url]和正在使用的模组。
[size=4][b]关于 UI Framework 与 StardewUI 的说明[/b][/size]
我对星露谷物语 UI 框架的构想早于 StardewUI 发布(尽管我推测它当时已经在开发中)。因此,UI Framework 并不试图与 [url=https://www.nexusmods.com/stardewvalley/mods/43861]StardewUI[/url] 竞争,因为在我看来,[b]它是星露谷物语模组中既定的 UI 框架。[/b] [b]如果你是一名 C# 模组作者并正在选择 UI 库,请使用 StardewUI。[/b]
[b]StardewUI 是更好的默认选择,尤其是因为它更加成熟。[/b]
[b]我认为 UI Framework 有哪些不同之处[/b]
[list]
[][b]无需 C# 的菜单。[/b] Content Patcher 内容包可以将完整的菜单、HUD 小部件和设置页面构建为数据,并带有表达式、命名状态和触发动作。StardewUI 的视图也是游戏资源,但需要 C# 模组提供其数据并打开它们。我对 StardewUI 不够了解,所以如果我错了请告诉我。[/]
[][b]模组可以通过扩展槽、贡献和装饰向彼此的菜单添加内容。[/b][/]
[][b]游戏内检查器[/b],可将任意菜单导出为 C# 或 JSON。[/]
[/list]
如果你想在不编写 C# 的情况下从 Content Patcher 内容包构建菜单,或者你想扩展一个已经使用它的模组,请使用 UI Framework。否则,StardewUI 是更安全的选择。
正在加载版本记录…
正在加载评论…
评论在新手盒子客户端中发表,这里同步展示。