whitten / n2t-wasm Goto Github PK

n2t-wasm

Emulator for the nand2tetris computer.

Demo

https://abhaynayar.com/n2t-wasm/

Build Instructions

Tested on Ubuntu 20.04 LTS.

Tools setup:

• Install rust: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
• Install wasm-pack: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
• Install node through nvm:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
nvm install node

Clone this repository:

$ git clone https://github.com/abhaynayar/n2t-wasm

Building the emulator:

• Run wasm-pack build in the root directory. This will create a new pkg/ directory for the wasm modules.
• Run npm init wasm-app www in the root directory. This will generate a web page in a new www/ directory. See if you already have a www/ directory. If so, you don't need to do create one.
• Run npm install in www directory to install the node modules.
• Run npm run start in the www directory to start a local testing instance.
• Run npm run build in the www directory to publish the results to dist.

Backlog

• Bug: Fix keyboard responsiveness.
• Bug: Sanitize RAM and ROM inputs in wasm.
• Bug: Index of instruction should be within ROM size.
• Bug: Crash when Rect.hack is running with RAM[0] > 513.
• Feature: Support for Hack assembly not just machine code.
• Feature: Separate targets for wasm and pixels. Shouldn't have to comment code.
• Feature: Add keyboard support.
• Bug: Fix the render loop in wasm.
• Feature: Transfer words instead of pixels from wasm to js.
• Feature: Show sample ROMs and a file picker on the web page.
• Bug: Only first key press is being registered. (=> keymap had to be zeroed)