Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

为 Web 平台编译

参见

这个页面描述的是如何从源码编译 HTML5 编辑器和导出模板二进制文件。如果你要找的是导出项目到 HTML5,请阅读 为 Web 导出

需求

编译 Web 的导出模板需要以下内容:

参见

要获取编译所需的 Godot 源码,请参阅 获取源代码

有关 Godot 的 SCons 用法的一般概述,请参阅 构建系统介绍

构建导出模板

在开始之前,确认 emcc 在你的 PATH 中是可用的。这通常是由 Emscripten SDK 配置的,例如在调用 emsdk activatesource ./emsdk_env.sh/emsdk_env.bat 时。

Open a terminal and navigate to the root directory of the engine source code. Then instruct SCons to build the Web platform. Specify target as either template_release for a release build or template_debug for a debug build:

scons platform=web target=template_release
scons platform=web target=template_debug

默认情况下,JavaScript singleton 将被内置到引擎中,官方导出模板也启用了 JavaScript 单例。由于 eval() 调用可能是一个安全问题,javascript_eval 选项可以用来构建,而无需单例:

scons platform=web target=template_release javascript_eval=no
scons platform=web target=template_debug javascript_eval=no

The engine will now be compiled to WebAssembly by Emscripten. Once finished, the resulting file will be placed in the bin subdirectory. Its name is godot.web.opt.wasm32.zip for release or godot.web.opt.debug.wasm32.zip for debug.

Finally, rename the zip archive to web_release.zip for the release template:

mv bin/godot.web.opt.wasm32.zip bin/web_release.zip

And web_debug.zip for the debug template:

mv bin/godot.web.opt.debug.wasm32.zip bin/web_debug.zip

GDExtension

The default export templates do not include GDExtension support for performance and compatibility reasons. See the export page for more info.

You can build the export templates using the option dlink_enabled=yes to enable GDExtension support:

scons platform=web dlink_enabled=yes target=template_release
scons platform=web dlink_enabled=yes target=template_debug

Once finished, the resulting file will be placed in the bin subdirectory. Its name will have _dlink added.

Finally, rename the zip archives to web_dlink_release.zip and web_dlink_release.zip for the release template:

mv bin/godot.web.opt.wasm32.dlink.zip bin/web_dlink_release.zip
mv bin/godot.web.opt.debug.wasm32.dlink.zip bin/web_dlink_debug.zip

Building the editor

It is also possible to build a version of the Godot editor that can run in the browser. The editor version is not recommended over the native build. You can build the editor with:

scons platform=web target=editor

Once finished, the resulting file will be placed in the bin subdirectory. Its name will be godot.web.opt.tools.wasm32.zip. You can upload the zip content to your web server and visit it with your browser to use the editor.

关于网络服务器的要求,请参考导出页面

小技巧

The Godot repository includes a Python script to host a local web server. This can be used to test the web editor locally.

After compiling the editor, extract the ZIP archive that was created in the bin/ folder, then run the following command in the Godot repository root:

# You may need to replace `python` with `python3` on some platforms.
python platform/web/serve.py

This will serve the contents of the bin/ folder and open the default web browser automatically. In the page that opens, access godot.tools.html and you should be able to test the web editor this way.

Note that for production use cases, this Python-based web server should not be used. Instead, you should use an established web server such as Apache or nginx.