summaryrefslogtreecommitdiff
path: root/platform/javascript/README.md
blob: 812ab6778b1dea1af90dce77e85ac549e1e616d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# HTML5 platform port

This folder contains the C++ and JavaScript code for the HTML5/WebAssembly platform port,
compiled using [Emscripten](https://emscripten.org/).

It also contains a ESLint linting setup (see [`package.json`](package.json)).

See also [`misc/dist/html`](/misc/dist/html) folder for additional files used by
this platform such as the HTML5 shell.

## Documentation

- [Compiling for the Web](https://docs.godotengine.org/en/latest/development/compiling/compiling_for_web.html)
  - Instructions on building this platform port from source.
- [Exporting for the Web](https://docs.godotengine.org/en/latest/tutorials/export/exporting_for_web.html)
  - Instructions on using the compiled export templates to export a project.

## Artwork license

[`logo.png`](logo.png) and [`run_icon.png`](run_icon.png) are licensed under
[Creative Commons Attribution 3.0 Unported](https://www.w3.org/html/logo/faq.html#how-licenced)
per the HTML5 logo usage guidelines.