2024-05-21 15:14:59 +02:00
|
|
|
import json
|
|
|
|
import os
|
2020-03-11 11:55:28 +01:00
|
|
|
|
2020-10-03 15:46:52 +02:00
|
|
|
from SCons.Util import WhereIs
|
2020-03-11 11:55:28 +01:00
|
|
|
|
|
|
|
|
|
|
|
def run_closure_compiler(target, source, env, for_signature):
|
2023-12-01 19:39:09 +01:00
|
|
|
closure_bin = os.path.join(
|
|
|
|
os.path.dirname(WhereIs("emcc")),
|
|
|
|
"node_modules",
|
|
|
|
".bin",
|
|
|
|
"google-closure-compiler",
|
|
|
|
)
|
2020-10-03 15:46:52 +02:00
|
|
|
cmd = [WhereIs("node"), closure_bin]
|
2020-03-30 08:28:32 +02:00
|
|
|
cmd.extend(["--compilation_level", "ADVANCED_OPTIMIZATIONS"])
|
|
|
|
for f in env["JSEXTERNS"]:
|
|
|
|
cmd.extend(["--externs", f.get_abspath()])
|
2020-03-11 11:55:28 +01:00
|
|
|
for f in source:
|
2020-03-30 08:28:32 +02:00
|
|
|
cmd.extend(["--js", f.get_abspath()])
|
|
|
|
cmd.extend(["--js_output_file", target[0].get_abspath()])
|
|
|
|
return " ".join(cmd)
|
2020-03-11 11:55:28 +01:00
|
|
|
|
|
|
|
|
2021-03-08 15:39:14 +01:00
|
|
|
def get_build_version():
|
2021-01-25 04:48:11 +01:00
|
|
|
import version
|
|
|
|
|
|
|
|
name = "custom_build"
|
2024-05-21 15:14:59 +02:00
|
|
|
if os.getenv("BUILD_NAME") is not None:
|
2021-01-25 04:48:11 +01:00
|
|
|
name = os.getenv("BUILD_NAME")
|
2021-03-20 14:35:28 +01:00
|
|
|
v = "%d.%d" % (version.major, version.minor)
|
|
|
|
if version.patch > 0:
|
|
|
|
v += ".%d" % version.patch
|
2021-08-19 15:01:22 +02:00
|
|
|
status = version.status
|
2024-05-21 15:14:59 +02:00
|
|
|
if os.getenv("GODOT_VERSION_STATUS") is not None:
|
2021-08-19 15:01:22 +02:00
|
|
|
status = str(os.getenv("GODOT_VERSION_STATUS"))
|
|
|
|
v += ".%s.%s" % (status, name)
|
2021-03-20 14:35:28 +01:00
|
|
|
return v
|
2021-01-25 04:48:11 +01:00
|
|
|
|
|
|
|
|
2023-12-01 19:39:09 +01:00
|
|
|
def create_engine_file(env, target, source, externs, threads_enabled):
|
2020-03-30 08:28:32 +02:00
|
|
|
if env["use_closure_compiler"]:
|
2020-03-11 11:55:28 +01:00
|
|
|
return env.BuildJS(target, source, JSEXTERNS=externs)
|
2023-12-01 19:39:09 +01:00
|
|
|
subst_dict = {"___GODOT_THREADS_ENABLED": "true" if threads_enabled else "false"}
|
|
|
|
return env.Substfile(target=target, source=[env.File(s) for s in source], SUBST_DICT=subst_dict)
|
2020-10-23 18:33:20 +02:00
|
|
|
|
|
|
|
|
2022-08-29 15:56:28 +02:00
|
|
|
def create_template_zip(env, js, wasm, worker, side):
|
SCons: Unify tools/target build type configuration
Implements https://github.com/godotengine/godot-proposals/issues/3371.
New `target` presets
====================
The `tools` option is removed and `target` changes to use three new presets,
which match the builds users are familiar with. These targets control the
default optimization level and enable editor-specific and debugging code:
- `editor`: Replaces `tools=yes target=release_debug`.
* Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_debug`: Replaces `tools=no target=release_debug`.
* Defines: `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_release`: Replaces `tools=no target=release`.
* Defines: `-O3`/`/O2`
New `dev_build` option
======================
The previous `target=debug` is now replaced by a separate `dev_build=yes`
option, which can be used in combination with either of the three targets,
and changes the following:
- `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`),
enables generating debug symbols, does not define `NDEBUG` so `assert()`
works in thirdparty libraries, adds a `.dev` suffix to the binary name.
Note: Unlike previously, `dev_build` defaults to off so that users who
compile Godot from source get an optimized and small build by default.
Engine contributors should now set `dev_build=yes` in their build scripts or
IDE configuration manually.
Changed binary names
====================
The name of generated binaries and object files are changed too, to follow
this format:
`godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]`
For example:
- `godot.linuxbsd.editor.dev.arm64`
- `godot.windows.template_release.double.x86_64.mono.exe`
Be sure to update your links/scripts/IDE config accordingly.
More flexible `optimize` and `debug_symbols` options
====================================================
The optimization level and whether to generate debug symbols can be further
specified with the `optimize` and `debug_symbols` options. So the default
values listed above for the various `target` and `dev_build` combinations
are indicative and can be replaced when compiling, e.g.:
`scons p=linuxbsd target=template_debug dev_build=yes optimize=debug`
will make a "debug" export template with dev-only code enabled, `-Og`
optimization level for GCC/Clang, and debug symbols. Perfect for debugging
complex crashes at runtime in an exported project.
2022-09-22 08:28:55 +02:00
|
|
|
binary_name = "godot.editor" if env.editor_build else "godot"
|
2023-12-01 19:39:09 +01:00
|
|
|
zip_dir = env.Dir(env.GetTemplateZipPath())
|
2021-03-08 15:39:14 +01:00
|
|
|
in_files = [
|
|
|
|
js,
|
|
|
|
wasm,
|
2022-08-28 20:27:45 +02:00
|
|
|
"#platform/web/js/libs/audio.worklet.js",
|
2024-08-06 15:46:37 +02:00
|
|
|
"#platform/web/js/libs/audio.position.worklet.js",
|
2021-03-08 15:39:14 +01:00
|
|
|
]
|
|
|
|
out_files = [
|
|
|
|
zip_dir.File(binary_name + ".js"),
|
|
|
|
zip_dir.File(binary_name + ".wasm"),
|
|
|
|
zip_dir.File(binary_name + ".audio.worklet.js"),
|
2024-08-06 15:46:37 +02:00
|
|
|
zip_dir.File(binary_name + ".audio.position.worklet.js"),
|
2021-03-08 15:39:14 +01:00
|
|
|
]
|
2023-12-01 19:39:09 +01:00
|
|
|
if env["threads"]:
|
|
|
|
in_files.append(worker)
|
|
|
|
out_files.append(zip_dir.File(binary_name + ".worker.js"))
|
2022-08-29 15:56:28 +02:00
|
|
|
# Dynamic linking (extensions) specific.
|
|
|
|
if env["dlink_enabled"]:
|
|
|
|
in_files.append(side) # Side wasm (contains the actual Godot code).
|
2021-03-08 15:39:14 +01:00
|
|
|
out_files.append(zip_dir.File(binary_name + ".side.wasm"))
|
|
|
|
|
|
|
|
service_worker = "#misc/dist/html/service-worker.js"
|
SCons: Unify tools/target build type configuration
Implements https://github.com/godotengine/godot-proposals/issues/3371.
New `target` presets
====================
The `tools` option is removed and `target` changes to use three new presets,
which match the builds users are familiar with. These targets control the
default optimization level and enable editor-specific and debugging code:
- `editor`: Replaces `tools=yes target=release_debug`.
* Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_debug`: Replaces `tools=no target=release_debug`.
* Defines: `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_release`: Replaces `tools=no target=release`.
* Defines: `-O3`/`/O2`
New `dev_build` option
======================
The previous `target=debug` is now replaced by a separate `dev_build=yes`
option, which can be used in combination with either of the three targets,
and changes the following:
- `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`),
enables generating debug symbols, does not define `NDEBUG` so `assert()`
works in thirdparty libraries, adds a `.dev` suffix to the binary name.
Note: Unlike previously, `dev_build` defaults to off so that users who
compile Godot from source get an optimized and small build by default.
Engine contributors should now set `dev_build=yes` in their build scripts or
IDE configuration manually.
Changed binary names
====================
The name of generated binaries and object files are changed too, to follow
this format:
`godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]`
For example:
- `godot.linuxbsd.editor.dev.arm64`
- `godot.windows.template_release.double.x86_64.mono.exe`
Be sure to update your links/scripts/IDE config accordingly.
More flexible `optimize` and `debug_symbols` options
====================================================
The optimization level and whether to generate debug symbols can be further
specified with the `optimize` and `debug_symbols` options. So the default
values listed above for the various `target` and `dev_build` combinations
are indicative and can be replaced when compiling, e.g.:
`scons p=linuxbsd target=template_debug dev_build=yes optimize=debug`
will make a "debug" export template with dev-only code enabled, `-Og`
optimization level for GCC/Clang, and debug symbols. Perfect for debugging
complex crashes at runtime in an exported project.
2022-09-22 08:28:55 +02:00
|
|
|
if env.editor_build:
|
2021-03-08 15:39:14 +01:00
|
|
|
# HTML
|
|
|
|
html = "#misc/dist/html/editor.html"
|
2021-03-18 16:19:09 +01:00
|
|
|
cache = [
|
SCons: Unify tools/target build type configuration
Implements https://github.com/godotengine/godot-proposals/issues/3371.
New `target` presets
====================
The `tools` option is removed and `target` changes to use three new presets,
which match the builds users are familiar with. These targets control the
default optimization level and enable editor-specific and debugging code:
- `editor`: Replaces `tools=yes target=release_debug`.
* Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_debug`: Replaces `tools=no target=release_debug`.
* Defines: `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_release`: Replaces `tools=no target=release`.
* Defines: `-O3`/`/O2`
New `dev_build` option
======================
The previous `target=debug` is now replaced by a separate `dev_build=yes`
option, which can be used in combination with either of the three targets,
and changes the following:
- `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`),
enables generating debug symbols, does not define `NDEBUG` so `assert()`
works in thirdparty libraries, adds a `.dev` suffix to the binary name.
Note: Unlike previously, `dev_build` defaults to off so that users who
compile Godot from source get an optimized and small build by default.
Engine contributors should now set `dev_build=yes` in their build scripts or
IDE configuration manually.
Changed binary names
====================
The name of generated binaries and object files are changed too, to follow
this format:
`godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]`
For example:
- `godot.linuxbsd.editor.dev.arm64`
- `godot.windows.template_release.double.x86_64.mono.exe`
Be sure to update your links/scripts/IDE config accordingly.
More flexible `optimize` and `debug_symbols` options
====================================================
The optimization level and whether to generate debug symbols can be further
specified with the `optimize` and `debug_symbols` options. So the default
values listed above for the various `target` and `dev_build` combinations
are indicative and can be replaced when compiling, e.g.:
`scons p=linuxbsd target=template_debug dev_build=yes optimize=debug`
will make a "debug" export template with dev-only code enabled, `-Og`
optimization level for GCC/Clang, and debug symbols. Perfect for debugging
complex crashes at runtime in an exported project.
2022-09-22 08:28:55 +02:00
|
|
|
"godot.editor.html",
|
2021-03-18 16:19:09 +01:00
|
|
|
"offline.html",
|
SCons: Unify tools/target build type configuration
Implements https://github.com/godotengine/godot-proposals/issues/3371.
New `target` presets
====================
The `tools` option is removed and `target` changes to use three new presets,
which match the builds users are familiar with. These targets control the
default optimization level and enable editor-specific and debugging code:
- `editor`: Replaces `tools=yes target=release_debug`.
* Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_debug`: Replaces `tools=no target=release_debug`.
* Defines: `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_release`: Replaces `tools=no target=release`.
* Defines: `-O3`/`/O2`
New `dev_build` option
======================
The previous `target=debug` is now replaced by a separate `dev_build=yes`
option, which can be used in combination with either of the three targets,
and changes the following:
- `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`),
enables generating debug symbols, does not define `NDEBUG` so `assert()`
works in thirdparty libraries, adds a `.dev` suffix to the binary name.
Note: Unlike previously, `dev_build` defaults to off so that users who
compile Godot from source get an optimized and small build by default.
Engine contributors should now set `dev_build=yes` in their build scripts or
IDE configuration manually.
Changed binary names
====================
The name of generated binaries and object files are changed too, to follow
this format:
`godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]`
For example:
- `godot.linuxbsd.editor.dev.arm64`
- `godot.windows.template_release.double.x86_64.mono.exe`
Be sure to update your links/scripts/IDE config accordingly.
More flexible `optimize` and `debug_symbols` options
====================================================
The optimization level and whether to generate debug symbols can be further
specified with the `optimize` and `debug_symbols` options. So the default
values listed above for the various `target` and `dev_build` combinations
are indicative and can be replaced when compiling, e.g.:
`scons p=linuxbsd target=template_debug dev_build=yes optimize=debug`
will make a "debug" export template with dev-only code enabled, `-Og`
optimization level for GCC/Clang, and debug symbols. Perfect for debugging
complex crashes at runtime in an exported project.
2022-09-22 08:28:55 +02:00
|
|
|
"godot.editor.js",
|
|
|
|
"godot.editor.audio.worklet.js",
|
2024-08-06 15:46:37 +02:00
|
|
|
"godot.editor.audio.position.worklet.js",
|
2021-03-18 16:19:09 +01:00
|
|
|
"logo.svg",
|
|
|
|
"favicon.png",
|
|
|
|
]
|
2023-12-01 19:39:09 +01:00
|
|
|
if env["threads"]:
|
|
|
|
cache.append("godot.editor.worker.js")
|
SCons: Unify tools/target build type configuration
Implements https://github.com/godotengine/godot-proposals/issues/3371.
New `target` presets
====================
The `tools` option is removed and `target` changes to use three new presets,
which match the builds users are familiar with. These targets control the
default optimization level and enable editor-specific and debugging code:
- `editor`: Replaces `tools=yes target=release_debug`.
* Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_debug`: Replaces `tools=no target=release_debug`.
* Defines: `DEBUG_ENABLED`, `-O2`/`/O2`
- `template_release`: Replaces `tools=no target=release`.
* Defines: `-O3`/`/O2`
New `dev_build` option
======================
The previous `target=debug` is now replaced by a separate `dev_build=yes`
option, which can be used in combination with either of the three targets,
and changes the following:
- `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`),
enables generating debug symbols, does not define `NDEBUG` so `assert()`
works in thirdparty libraries, adds a `.dev` suffix to the binary name.
Note: Unlike previously, `dev_build` defaults to off so that users who
compile Godot from source get an optimized and small build by default.
Engine contributors should now set `dev_build=yes` in their build scripts or
IDE configuration manually.
Changed binary names
====================
The name of generated binaries and object files are changed too, to follow
this format:
`godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]`
For example:
- `godot.linuxbsd.editor.dev.arm64`
- `godot.windows.template_release.double.x86_64.mono.exe`
Be sure to update your links/scripts/IDE config accordingly.
More flexible `optimize` and `debug_symbols` options
====================================================
The optimization level and whether to generate debug symbols can be further
specified with the `optimize` and `debug_symbols` options. So the default
values listed above for the various `target` and `dev_build` combinations
are indicative and can be replaced when compiling, e.g.:
`scons p=linuxbsd target=template_debug dev_build=yes optimize=debug`
will make a "debug" export template with dev-only code enabled, `-Og`
optimization level for GCC/Clang, and debug symbols. Perfect for debugging
complex crashes at runtime in an exported project.
2022-09-22 08:28:55 +02:00
|
|
|
opt_cache = ["godot.editor.wasm"]
|
2021-03-18 16:19:09 +01:00
|
|
|
subst_dict = {
|
2023-12-01 19:39:09 +01:00
|
|
|
"___GODOT_VERSION___": get_build_version(),
|
|
|
|
"___GODOT_NAME___": "GodotEngine",
|
|
|
|
"___GODOT_CACHE___": json.dumps(cache),
|
|
|
|
"___GODOT_OPT_CACHE___": json.dumps(opt_cache),
|
|
|
|
"___GODOT_OFFLINE_PAGE___": "offline.html",
|
|
|
|
"___GODOT_THREADS_ENABLED___": "true" if env["threads"] else "false",
|
2021-03-18 16:19:09 +01:00
|
|
|
}
|
2021-03-08 15:39:14 +01:00
|
|
|
html = env.Substfile(target="#bin/godot${PROGSUFFIX}.html", source=html, SUBST_DICT=subst_dict)
|
|
|
|
in_files.append(html)
|
|
|
|
out_files.append(zip_dir.File(binary_name + ".html"))
|
|
|
|
# And logo/favicon
|
|
|
|
in_files.append("#misc/dist/html/logo.svg")
|
|
|
|
out_files.append(zip_dir.File("logo.svg"))
|
|
|
|
in_files.append("#icon.png")
|
|
|
|
out_files.append(zip_dir.File("favicon.png"))
|
|
|
|
# PWA
|
|
|
|
service_worker = env.Substfile(
|
2023-12-01 19:39:09 +01:00
|
|
|
target="#bin/godot${PROGSUFFIX}.service.worker.js",
|
|
|
|
source=service_worker,
|
|
|
|
SUBST_DICT=subst_dict,
|
2021-03-08 15:39:14 +01:00
|
|
|
)
|
|
|
|
in_files.append(service_worker)
|
|
|
|
out_files.append(zip_dir.File("service.worker.js"))
|
|
|
|
in_files.append("#misc/dist/html/manifest.json")
|
|
|
|
out_files.append(zip_dir.File("manifest.json"))
|
|
|
|
in_files.append("#misc/dist/html/offline.html")
|
|
|
|
out_files.append(zip_dir.File("offline.html"))
|
|
|
|
else:
|
|
|
|
# HTML
|
|
|
|
in_files.append("#misc/dist/html/full-size.html")
|
|
|
|
out_files.append(zip_dir.File(binary_name + ".html"))
|
2021-03-18 16:19:09 +01:00
|
|
|
in_files.append(service_worker)
|
|
|
|
out_files.append(zip_dir.File(binary_name + ".service.worker.js"))
|
|
|
|
in_files.append("#misc/dist/html/offline-export.html")
|
|
|
|
out_files.append(zip_dir.File("godot.offline.html"))
|
2021-03-08 15:39:14 +01:00
|
|
|
|
|
|
|
zip_files = env.InstallAs(out_files, in_files)
|
|
|
|
env.Zip(
|
|
|
|
"#bin/godot",
|
|
|
|
zip_files,
|
|
|
|
ZIPROOT=zip_dir,
|
|
|
|
ZIPSUFFIX="${PROGSUFFIX}${ZIPSUFFIX}",
|
|
|
|
)
|
|
|
|
|
|
|
|
|
2023-12-01 19:39:09 +01:00
|
|
|
def get_template_zip_path(env):
|
|
|
|
return "#bin/.web_zip"
|
|
|
|
|
|
|
|
|
2020-10-23 18:33:20 +02:00
|
|
|
def add_js_libraries(env, libraries):
|
|
|
|
env.Append(JS_LIBS=env.File(libraries))
|
2020-09-27 00:15:21 +02:00
|
|
|
|
|
|
|
|
|
|
|
def add_js_pre(env, js_pre):
|
|
|
|
env.Append(JS_PRE=env.File(js_pre))
|
|
|
|
|
|
|
|
|
|
|
|
def add_js_externs(env, externs):
|
|
|
|
env.Append(JS_EXTERNS=env.File(externs))
|