mirror of https://github.com/a-b-street/abstreet.git synced 2024-11-23 17:07:12 +03:00

History

luz paz 7b63227407 Fix typos Found via `codespell -q 3 -L crate,flor,nd,noice`		2022-07-16 08:55:39 +01:00
..
bin	new release	2022-02-20 18:55:28 +00:00
src	Fix typos	2022-07-16 08:55:39 +01:00
.gitignore	embed mode and reworked web build system (#592 )	2021-04-01 19:31:02 -07:00
Makefile	Set up the boilerplate for splitting the LTN tool into its crate	2022-01-18 17:33:04 +00:00
package-lock.json	embed mode and reworked web build system (#592 )	2021-04-01 19:31:02 -07:00
package.json	embed mode and reworked web build system (#592 )	2021-04-01 19:31:02 -07:00
README.md	rebuild wasm when rust sources change	2021-07-17 11:24:46 -07:00

README.md

Web Stuff

This is a collection of API's and build tools for packaging our various Widgetry apps as web applications.

Goals

A web developer, who might not know anything about rust or wasm, should be able to use our packaged javascript libraries on their website with minimal customization or arcanery.

Users of their website should be able to interact with the widgetry app without it feeling weird or having to jump through hoops.

Limitations

JS feature: `import.meta`

To allow the application to live at any URL (rather than presupposing it lives at root, or whatever), we rely on import.meta which isn't supported on some browsers before 2018. See: https://caniuse.com/?search=import.meta

An alternative would be to require configuration, so the loader knows where to download it's "*_wasm.bg file".

Browser Feature: WebGL

We prefer WebGL2, but now gracefully fall back to WebGL1. This should cover all common browsers since late 2014. https://caniuse.com/?search=webgl

Examples

See src/web_root/*.js for code examples.

You can build and see the examples in your webbrowser with:

// install typescript build dependency
npm install
make dev
make server

The workflow for interactive development of just one app in debug mode:

make abstreet server