Relintai/pandemonium_engine_docs
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine_docs.git synced 2025-02-02 15:55:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

Cleanups to the compiling for the web section.

Browse Source
This commit is contained in:
Relintai 2023-04-06 23:35:49 +02:00
parent 99217ba6b0
commit 6bcccdeb5e
1 changed files with 17 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
development/compiling/compiling_for_web.md
View File

@ -1,17 +1,11 @@
# Compiling for the Web
This page describes how to compile HTML5 editor and export template binaries from source. If you're looking
to export your project to HTML5 instead, read `doc_exporting_for_web`.
Compiling for the Web ## Requirements
=====================
See also:
This page describes how to compile HTML5 editor and export template binaries from source.
If you're looking to export your project to HTML5 instead, read `doc_exporting_for_web`.
Requirements
------------
To compile export templates for the Web, the following is required: To compile export templates for the Web, the following is required:
@ -19,15 +13,11 @@ To compile export templates for the Web, the following is required:
- `Python 3.5+ ( https://www.python.org/ )`. - `Python 3.5+ ( https://www.python.org/ )`.
- `SCons 3.0+ ( https://www.scons.org )` build system. - `SCons 3.0+ ( https://www.scons.org )` build system.
See also:
To get the Godot source code for compiling, see
`doc_getting_source`.
For a general overview of SCons usage for Godot, see To get the Godot source code for compiling, see `doc_getting_source`.
`doc_introduction_to_the_buildsystem`. For a general overview of SCons usage for Godot, see `doc_introduction_to_the_buildsystem`.
Building export templates ## Building export templates
-------------------------
Before starting, confirm that `emcc` is available in your PATH. This is Before starting, confirm that `emcc` is available in your PATH. This is
usually configured by the Emscripten SDK, e.g. when invoking `emsdk activate` usually configured by the Emscripten SDK, e.g. when invoking `emsdk activate`
@ -70,45 +60,36 @@ And `webassembly_debug.zip` for the debug template:
mv bin/godot.javascript.opt.debug.zip bin/webassembly_debug.zip mv bin/godot.javascript.opt.debug.zip bin/webassembly_debug.zip
``` ```
Threads and GDNative ## Threads
--------------------
The default export templates do not include threads and GDNative support for The default export templates do not include threads support for
performance and compatibility reasons. See the performance and compatibility reasons. See the
`export page ( doc_javascript_export_options )` for more info. `export page ( doc_javascript_export_options )` for more info.
You can build the export templates using the option `threads_enabled=yes` or You can build the export templates using the option `threads_enabled=yes` to enable threads support:
`gdnative_enabled=yes` to enable threads or GDNative support:
``` ```
scons platform=javascript tools=no threads_enabled=yes target=release scons platform=javascript tools=no threads_enabled=yes target=release
scons platform=javascript tools=no threads_enabled=yes target=release_debug scons platform=javascript tools=no threads_enabled=yes target=release_debug
scons platform=javascript tools=no gdnative_enabled=yes target=release
scons platform=javascript tools=no gdnative_enabled=yes target=release_debug
``` ```
Once finished, the resulting file will be placed in the `bin` subdirectory. Once finished, the resulting file will be placed in the `bin` subdirectory.
Its name will have either the `.threads` or `.gdnative` suffix. Its name will have the `.threads` suffix.
Finally, rename the zip archives to `webassembly_release_threads.zip` and Finally, rename the zip archives to `webassembly_release_threads.zip` for the release template:
`webassembly_release_gdnative.zip` for the release template:
``` ```
mv bin/godot.javascript.opt.threads.zip bin/webassembly_threads_release.zip mv bin/godot.javascript.opt.threads.zip bin/webassembly_threads_release.zip
mv bin/godot.javascript.opt.gdnative.zip bin/webassembly_gdnative_release.zip
``` ```
And `webassembly_debug_threads.zip` and `webassembly_debug_gdnative.zip` for And `webassembly_debug_threads.zip` for the debug template:
the debug template:
``` ```
mv bin/godot.javascript.opt.debug.threads.zip bin/webassembly_threads_debug.zip mv bin/godot.javascript.opt.debug.threads.zip bin/webassembly_threads_debug.zip
mv bin/godot.javascript.opt.debug.gdnative.zip bin/webassembly_gdnative_debug.zip
``` ```
Building the Editor ## Building the Editor
-------------------
It is also possible to build a version of the Godot editor that can run in the It is also possible to build a version of the Godot editor that can run in the
browser. The editor version requires threads support and is not recommended browser. The editor version requires threads support and is not recommended