Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 2.43 KB

web.md

File metadata and controls

76 lines (56 loc) · 2.43 KB
Raw

Building and Running the Web-based TX-2 Simulator

Disclaimer

The web-based simulator is still under development, so you may not get a result which actually does much even if you follow these instructions. For the time being the command-line simulator is probably more useful.

Introduction

The web-based simulator runs locally in a browser. It is implemented as a WASM program (we compile the Rust simulator code to WASM), some Javascript glue, and an HTML page which acts as a container.

There is no server-side component to the simulator, except that it's convenient to download the HTML, the WASM and the Javascript from a web server. The simulator doesn't execute on the server.

Installing the WASM Toolchain

These instructions are based on the Rust Game-of-Life WASM book. If these instructions seem not to work then please raise a bug but meanwhile you might be about to figure out the problem by looking at the Rust Game-of-Life WASM book

Toolchain Installation Steps

  1. Follow these instructions to install the Rust toolchain.
  2. Install wasm-pack by either following these scary curl | sh instructions or by using cargo install wasm-pack.
  3. Install npm.
  4. If you already have npm install, make sure it is up-to-date by running npm install npm@latest -g

You should not need cargo-generate.

Build Steps

$ cd tx2-web
$ npm run build

Trying it Out

$ cd tx2-web
$ npm run dev

The npm command will print the URL from which the pages are served, just visit that in your browser if npm doesn't open a browser window for you automatically.

Problems with wasm-opt

Some versions of wasm-pack have a bug in how they locate the wasm-opt binary; they can't correctly find a pre-installed binary. On my system this gives rise to this error:

[INFO]: found wasm-opt at "/usr/bin/wasm-opt"
Error: /usr/bin/bin/wasm-opt binary does not exist

One low-tech workaround for this problem is to move any locally-installed wasm-opt binary out of the way, so that wasm-pack uses a downloaded verson.