Odin + WASM 项目启动与配置教程

1. 项目目录结构及介绍

Odin + WASM 项目的主要目录结构如下：

.
├── .github/
│   └── workflows/
├── .vscode/
├── assets/
├── example/
│   ├── shaders_generated.odin
│   └── main.odin
├── obj/
├── shdc/
├── wasm/
├── .editorconfig
├── .gitignore
├── config.js
├── jsconfig.json
├── licence.txt
├── main.js
├── package-lock.json
├── package.json
└── readme.md

• .github/workflows/: 存放 GitHub Actions 的配置文件，用于自动化构建和部署等任务。
• .vscode/: 存放 Visual Studio Code 的配置文件。
• assets/: 存放项目所需的静态资源文件，如图片、样式表等。
• example/: 包含使用 Odin 和 WASM 的示例代码。
• obj/: 可能包含与项目相关的对象文件或其他资源。
• shdc/: 包含用于生成 GLSL 辅助代码的工具。
• wasm/: 包含 WebAssembly 相关的文件。
• .editorconfig: 编辑器配置文件，用于统一不同开发者的代码风格。
• .gitignore: 指定 Git 忽略的文件和目录。
• config.js: JavaScript 配置文件，可能包含项目的配置信息。
• jsconfig.json: JavaScript 配置文件，用于配置 Visual Studio Code 的 JavaScript 支持。
• licence.txt: 项目许可证文件，本项目采用 MIT 许可证。
• main.js: JavaScript 入口文件，负责启动和运行 WebAssembly 模块。
• package-lock.json: npm 包锁文件，确保项目依赖的一致性。
• package.json: npm 包配置文件，包含项目依赖、脚本等信息。
• readme.md: 项目自述文件，包含项目介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件是 main.js，该文件负责初始化和加载 WebAssembly 模块。以下是 main.js 的主要部分：

// 加载 Odin 编译的 WebAssembly 模块
const wasmModule = await import('./wasm/odin_wasm.js');

// 初始化示例代码
function init() {
  // ... 初始化代码
}

// 当文档加载完毕后，调用初始化函数
document.addEventListener('DOMContentLoaded', init);

在这个文件中，我们使用 import 语句异步加载 WebAssembly 模块，然后在文档加载完成后调用 init 函数来启动示例代码。

3. 项目的配置文件介绍

项目的配置文件主要包括 .editorconfig、.gitignore、config.js 和 jsconfig.json。

• .editorconfig: 用于设置代码风格，例如缩进、换行符等。这有助于保持项目代码的一致性。
• .gitignore: 用于指定 Git 应该忽略的文件和目录，例如编译产生的临时文件、日志文件等。
• config.js: JavaScript 配置文件，可以包含项目的配置信息，如 API 端点、环境变量等。
• jsconfig.json: 用于配置 Visual Studio Code 的 JavaScript 支持，例如指定项目的根目录、排除某些目录等。

这些配置文件帮助维护项目的结构化和一致性，并为开发者提供便利。