JSNES技术文档

1. 安装指南

Node.js 或 Webpack 环境

在 Node.js 或 Webpack 环境中，您可以使用以下命令安装 JSNES：

$ npm install jsnes

或者，如果您使用 Yarn：

$ yarn add jsnes

浏览器环境

在浏览器中，您可以通过 unpkg 使用 JSNES：

<script type="text/javascript" src="https://unpkg.com/jsnes/dist/jsnes.min.js"></script>

2. 使用说明

首先，需要初始化并设置输出：

var nes = new jsnes.NES({
  onFrame: function(frameBuffer) {
    // ... 将frameBuffer输出到屏幕
  },
  onAudioSample: function(left, right) {
    // ... 播放音频样本
  }
});

接着，读取 ROM 数据（以下示例使用 Node.js API）：

const fs = require('fs');
var romData = fs.readFileSync('path/to/rom.nes', {encoding: 'binary'});

然后，加载 ROM 数据：

nes.loadROM(romData);

运行帧，尽量以 60 fps 运行，或者尽可能快：

nes.frame();
nes.frame();
// ...

连接输入设备到控制器：

nes.buttonDown(1, jsnes.Controller.BUTTON_A);
nes.frame();
nes.buttonUp(1, jsnes.Controller.BUTTON_A);
nes.frame();
// ...

3. 项目API使用文档

JSNES 提供了一系列 API 用于控制模拟器，以下是部分 API 列表：

• new jsnes.NES(options)：创建一个新的 NES 实例。
• nes.loadROM(romData)：加载 ROM 数据。
• nes.frame()：运行一个模拟器帧。
• nes.buttonDown(player, button)：按下指定玩家的按钮。
• nes.buttonUp(player, button)：松开指定玩家的按钮。

更多 API 文档请参考官方 GitHub 仓库的相关说明。

4. 项目安装方式

构建分发版：

$ yarn run build

这将创建 dist/jsnes.min.js。

运行测试：

$ yarn test

在网页中嵌入 JSNES：

您可以使用 JSNES 将可玩版本的 ROM 嵌入网页。这对于想要在其网页上放置可玩版本的家用brew ROM开发者来说非常有用。最佳的实现是 jsnes-web，但遗憾的是，重用代码并不简单。您需要从该仓库复制代码，并使用 <Emulator> React 组件。

所有代码必须符合 Prettier 格式。如果代码格式不正确，测试套件将无法通过。

要自动格式化所有代码，请运行：

$ yarn run format