Amazon Sumerian Hosts 开发者指南

Amazon Sumerian Hosts 开发者指南

1. 项目目录结构及介绍

Amazon Sumerian Hosts 项目目录结构如下：

amazon-sumerian-hosts/
├── .github/              # GitHub 工作流程和配置文件
├── docs_template/        # 文档模板
├── packages/             # 包含核心库和针对不同渲染引擎的集成包
│   ├── demos-babylon/    # 使用 Babylon.js 构建的演示应用
│   ├── amazon-sumerian-hosts-core/ # 核心API包
│   ├── amazon-sumerian-hosts-babylon/ # Babylon.js 集成包
│   └── amazon-sumerian-hosts-three/ # three.js 集成包
├── .eslintrc.json        # ESLint 配置文件
├── .gitignore            # Git 忽略文件
├── .npmignore            # NPM 忽略文件
├── .prettierrc           # Prettier 配置文件
├── AWS-Infrastructure-Setup.md # AWS 基础设施设置指南
├── CODE_OF_CONDUCT.md    # 行为准则
├── CONTRIBUTING.md       # 贡献指南
├── LICENSE               # 许可证文件
├── README.md             # 项目说明文件
├── THIRD-PARTY-LICENSES.md # 第三方许可证
└── demo-credentials.js   # 演示应用凭证文件

1.1 核心库和集成包

• @amazon-sumerian-hosts/core: 核心API，支持扩展以集成不同的Web渲染引擎。
• @amazon-sumerian-hosts/babylon: 集成了核心库的Babylon.js版本。
• @amazon-sumerian-hosts/three: 集成了核心库的three.js版本。

1.2 演示应用

• demos-babylon: 使用Babylon.js构建的演示应用，展示Hosts API的不同特性。
• amazon-sumerian-hosts-three/examples/: 使用three.js构建的演示应用。

2. 项目的启动文件介绍

项目的启动文件主要位于packages/demos-babylon/目录中，每个演示应用都有自己的启动脚本。以下是一个典型的启动脚本示例：

// 启动演示应用的示例脚本
const { createHost, HostConfig } = require('@amazon-sumerian-hosts/babylon');

// 配置Hosts
const config = new HostConfig({
  // ...配置参数
});

// 创建Host实例
const host = createHost(config);

// 初始化并运行演示应用
host.init().then(() => {
  host.run();
});

在这个脚本中，首先引入了Babylon.js集成的Hosts模块，然后创建了一个配置对象，接着创建了一个Host实例，并调用init和run方法来启动演示应用。

3. 项目的配置文件介绍

项目的配置文件包括：

• .eslintrc.json: ESLint 配置文件，用于定义代码风格规则和检查标准。
• .prettierrc: Prettier 配置文件，用于统一代码格式。
• .gitignore: Git 忽略文件，指定哪些文件和目录不应该被Git跟踪。
• .npmignore: NPM 忽略文件，指定哪些文件不应该被包含在NPM包中。

每个演示应用也可能会包含自己的配置文件，例如webpack.config.js，用于配置Webpack打包工具的参数和选项。配置文件的具体内容将取决于项目的具体需求和所使用的工具。