4.6 KiB
The web editor
AniCraft also runs in a web browser: the same program, built for WebAssembly
(wasm32-unknown-unknown), drawing into a page with WebGL2. How it is built, and why, is in
ADR 0036. Nothing is hosted yet; you build it and serve it yourself.
Build
You need the wasm32 target and the wasm-bindgen command-line tool, at the version
Cargo.lock pins for the wasm-bindgen crate (the script checks and tells you which). Both are
MIT OR Apache-2.0.
rustup target add wasm32-unknown-unknown
cargo install wasm-bindgen-cli --version 0.2.129 --locked # the version build-web asks for
scripts/build-web.sh # macOS, Linux, Git Bash
scripts\build-web.ps1 # Windows PowerShell
--dev (-Dev) builds faster but makes a larger, slower module. The output goes to web/
(git-ignored):
| File | What |
|---|---|
index.html |
the page (from packaging/web/index.html) |
anicraft.js |
wasm-bindgen's loader |
anicraft_bg.wasm |
the editor, about 9 MB (3.3 MB gzipped) |
anicraft.png |
the page icon |
A plain cargo build --target wasm32-unknown-unknown (the whole workspace, default features)
also works: that is what CI checks.
Serve locally
Browsers don't load WebAssembly modules from file://, so serve the folder over HTTP with any
static server, for example:
python3 -m http.server --directory web 8080
Then open http://localhost:8080. localhost counts as a secure page, so Web Locks (used by
autosave) work. On another host, serve over HTTPS for the same reason. Compressing
anicraft_bg.wasm (gzip or brotli) cuts the download to about a third.
How it differs from the desktop app
- Opening and importing use the browser's file picker. Saving and exporting download the file: Save asks for the file name the first time, then downloads under that name. The browser picks the folder, usually Downloads.
- Autosave keeps recovery copies in the browser's storage for the site. If a tab closes or crashes with unsaved work, the next start offers to restore it, as the desktop app does after a crash. Copies of tabs that are still open are never offered. Browsers keep only a few MB per site, so documents with large images or sounds may not fit; the status bar says when a copy fails.
- Preferences are kept in the browser's storage too.
- Leaving the page with unsaved changes asks first.
- Shortcuts are the desktop ones; on a Mac they use ⌘.
Not in the web editor yet
| Missing | Why, and what to do meanwhile |
|---|---|
| Video export | It runs ffmpeg, which a page can't start. The menu item is dimmed; export a GIF, PNG sequence or HTML page. |
| Sound playback | The page plays silently for now (Web Audio comes later). Sounds still import, show on the timeline and export (WAV, HTML). |
| GPU stage | The stage draws on the CPU, on one thread. The GPU renderer builds for the web but isn't wired to WebGPU yet. |
| Installing plug-ins | Plug-ins live in a folder on the computer. Use the desktop app. |
| Fonts on your computer | A page can't see them. Text uses the bundled faces. |
| XFL folders | A browser can't hand over a folder. Open the .fla instead. |
| PNG sequence as one file | Each frame downloads on its own. Your browser may ask once to allow several downloads. |
| Large autosaves | Limited by the browser's storage (about 5 MB). |
| Parallel rendering | The web has no threads here, so exports render one frame at a time. |
What was verified, and how
There was no browser on the build machine. These checks ran instead:
- every crate builds for wasm32, and clippy is clean for it;
crates/engine/tests/wasm.rsruns inside WebAssembly in Node: a frame renders with no worker thread, a document saves and reopens through memory, PNG/GIF/HTML/PNG-sequence exports are written, video export refuses, and a plug-in runs on wasmi;- the built editor module loads in Node's V8 and runs
mainto its "no canvas" exit without a panic; - natively,
crates/engine/src/web_tests.rsruns every file command against the in-memory store the browser uses.
Only a browser can confirm the canvas, the picker, downloads, storage, Web Locks and the
leave-page prompt. To check them by hand: build, serve, then in the page open a .anicraft file,
draw, save (a download arrives), close the tab with unsaved work, reopen it (Restore is
offered), and export a GIF.
Run the WebAssembly tests yourself (Node and the wasm-bindgen CLI installed):
CARGO_TARGET_WASM32_UNKNOWN_UNKNOWN_RUNNER=wasm-bindgen-test-runner \
cargo test -p anicraft-engine --target wasm32-unknown-unknown --test wasm