Wasmoon 项目使用教程

Wasmoon 项目使用教程

wasmoonA real lua 5.4 VM with JS bindings made with webassembly项目地址:https://gitcode.com/gh_mirrors/wa/wasmoon

1. 项目的目录结构及介绍

Wasmoon 项目的目录结构如下：

wasmoon/
├── build/
├── docs/
├── examples/
├── src/
│   ├── lua/
│   ├── typescript/
│   └── wasm/
├── tests/
├── .gitignore
├── .npmignore
├── package.json
├── README.md
└── tsconfig.json

目录介绍：

• build/: 包含构建脚本和构建生成的文件。
• docs/: 包含项目文档。
• examples/: 包含示例代码，展示如何使用 Wasmoon。
• src/: 源代码目录，包含 Lua、TypeScript 和 WebAssembly 相关代码。
  • lua/: Lua 源代码。
  • typescript/: TypeScript 源代码。
  • wasm/: WebAssembly 相关代码。
• tests/: 包含测试脚本和测试用例。
• .gitignore: Git 忽略文件配置。
• .npmignore: NPM 忽略文件配置。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

Wasmoon 的启动文件主要位于 src/typescript/ 目录下。主要的启动文件是 index.ts，它负责初始化 Lua 环境和加载必要的模块。

启动文件介绍：

• index.ts: 主入口文件，初始化 Lua 环境并加载必要的模块。

import { LuaFactory } from './LuaFactory';

async function main() {
  const factory = new LuaFactory();
  const lua = await factory.createEngine();

  try {
    await lua.doString(`print("Hello, Wasmoon!")`);
  } finally {
    lua.global.close();
  }
}

main().catch(console.error);

3. 项目的配置文件介绍

Wasmoon 的配置文件主要是 package.json 和 tsconfig.json。

配置文件介绍：

• package.json: 包含项目的依赖、脚本和其他元数据。

{
  "name": "wasmoon",
  "version": "1.0.0",
  "description": "A Lua VM based on WebAssembly",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "typescript": "^4.0.0"
  },
  "devDependencies": {
    "jest": "^26.0.0"
  }
}

• tsconfig.json: TypeScript 编译配置文件。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "CommonJS",
    "outDir": "./dist",
    "strict": true
  },
  "include": ["src/**/*"]
}

以上是 Wasmoon 项目的目录结构、启动文件和配置文件的介绍。希望这份文档能帮助你更好地理解和使用 Wasmoon 项目。

wasmoonA real lua 5.4 VM with JS bindings made with webassembly项目地址:https://gitcode.com/gh_mirrors/wa/wasmoon