@seriousgaming / sdk
Serious Gaming游戏导入的库:引擎、钩子、验证器、端点和tick控制器的类型和帮助器,以及各种用户界面的React包装器和钩子。
在CLI中构建、测试和运行一个游戏 @seriousgaming/sdk-tools。它的文档从 docs/index.md 在那个包裹里。
该包仅为ES模块:导入它。它的出口没有任何利润。 require 条件,所以CommonJS工具,解决与 require.resolve 没有找到它。
稳定
带有预发布后缀的版本,例如 1.0.0-alpha.1但是,它并没有这些保证:在它最终发布之前,它可以以任何方式改变。
从1.0.0开始,这些子路径遵循语义版本控制。对他们导出的任何内容的突破性更改都要等待主要版本的发布:
| 子路径 | 它包含什么 |
|---|---|
. | 逻辑签名、包类型、 uses 回调,调度构建器,种子随机性,UTF-8助手, UndeclaredApiUseError |
./ui | 用户界面包装器、它们的钩子和表面读取的类型 |
./ui/testing | 用于测试表面的渲染帮助器和模型,包括 mergingSetData 和 createMockBrand |
./testing | logicArgs、脱机存根回调,以及 createMockTeam, createMockParticipant 以及它们的复数形式,用于在单元测试中直接调用逻辑函数 |
./projection | 可观察会话声明了开发服务器和CLI报告 PROJECTION_VERSION |
./commands | 客户端发送给开发服务器的命令集,以及每个查询的回答 |
其中有两件事不在保证范围之内:
- 成员标记
@internal在其TSDoc中,例如开发服务器的故障注入(FaultKind,ArmedFault,armFault和disarmFault命令和投影faults). 它们在声明中发布,但可能在小版本中更改 - React上下文对象
./ui出口(UserInterfaceDataContext剩下的*Context名)。读取它们的钩子被盖住了;直接提供一个不是,因为小版本可能会向上下文的值添加必需的字段。测试一个表面render*助手在./ui/testing,为您提供所有上下文
将字段添加到投影或查询的答案中并不是一个突破性的更改,因此读者应该忽略它不知道的内容。 PROJECTION_VERSION 仅在主版本中进行更改。
./e2e 没有这样的保证。它拥有用于在开发服务器上测试游戏的剧作家助手,它可以跟踪开发主机并随之移动 sdk-tools.
iframe协议的主机部分(@seriousgaming/sdk-tools/host)和运行时帮助程序(@seriousgaming/sdk-tools/runtime)不是这个计划的一部分。它们是为严肃游戏平台和SDK自己的工具而存在的,而不是为游戏而存在的。
执照
Apache许可证,2.0版。看到 LICENSE 和 NOTICE.