9e4315bb50
This applies our existing style guide, and adds a new rule to that style
guide for modular components such as platform ports and modules:
Includes from the platform port or module should be included with relative
paths (relative to the root folder of the modular component, e.g.
`platform/linuxbsd/`), in their own section before Godot's "core" includes.
The `api` and `export` subfolders also need to be handled as self-contained
(and thus use relative paths for their "local" includes) as they are all
compiled for each editor platform, without necessarily having the api/export
matching platform folder in the include path.
E.g. the Linux editor build will compile `platform/android/{api,export}/*.cpp`
and those need to use relative includes for it to work.
|
||
|---|---|---|
| .. | ||
| api | ||
| doc_classes | ||
| export | ||
| js | ||
| .eslintrc.engine.js | ||
| .eslintrc.html.js | ||
| .eslintrc.js | ||
| .eslintrc.libs.js | ||
| README.md | ||
| SCsub | ||
| audio_driver_web.cpp | ||
| audio_driver_web.h | ||
| detect.py | ||
| display_server_web.cpp | ||
| display_server_web.h | ||
| dom_keys.inc | ||
| emscripten_helpers.py | ||
| godot_audio.h | ||
| godot_js.h | ||
| godot_webgl2.h | ||
| http_client_web.cpp | ||
| http_client_web.h | ||
| javascript_bridge_singleton.cpp | ||
| logo.svg | ||
| os_web.cpp | ||
| os_web.h | ||
| package-lock.json | ||
| package.json | ||
| platform_config.h | ||
| run_icon.svg | ||
| serve.py | ||
| web_main.cpp | ||
| web_runtime.cpp | ||
README.md
Web platform port
This folder contains the C++ and JavaScript code for the Web platform port, compiled using Emscripten.
It also contains a ESLint linting setup (see package.json).
See also misc/dist/html folder for additional files used by
this platform such as the html shell (web page).
Documentation
- Compiling for the Web
- Instructions on building this platform port from source.
- Exporting for the Web
- Instructions on using the compiled export templates to export a project.
Artwork license
logo.png and run_icon.png are licensed under
Creative Commons Attribution 3.0 Unported
per the HTML5 logo usage guidelines.
