mirror of
https://github.com/godotengine/godot-demo-projects.git
synced 2026-01-04 06:09:46 +03:00
Update web demo exports for Godot 4.3 (#1127)
This comes with other improvements:
- Demos now work on desktop and mobile browsers, as ETC2 import is now
automatically enabled before exporting each demo.
- Progressive web app is available for each project.
- Can be added to the home screen on a device for a closer-to-native experience.
- Cross-origin isolation headers are automatically added, so that the export
works with threads enabled despite being hosted on GitHub Pages
(which doesn't send these headers).
Several demos will need further tweaks to look better when using
the Compatibility rendering method. Currently, many 3D demos appear
too bright due to lights with shadows enabled using sRGB blending.
Also, many demos will need to be modified to indicate which parts
of them are not supported when running on the web platform, or
when using the Compatibility rendering method.
This commit is contained in:
Hugo Locurcio
GitHub
@@ -1,42 +1,59 @@
|
||||
name: Export projects to HTML5 and deploy to GitHub Pages
|
||||
name: Export projects to Web and deploy to GitHub Pages
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
|
||||
env:
|
||||
GODOT_VERSION: 3.3.3
|
||||
GODOT_VERSION: 4.3
|
||||
|
||||
jobs:
|
||||
export-html5:
|
||||
name: Export projects to HTML5 and deploy to GitHub Pages
|
||||
runs-on: ubuntu-20.04
|
||||
name: Export projects to Web and deploy to GitHub Pages
|
||||
runs-on: ubuntu-24.04
|
||||
container:
|
||||
image: barichello/godot-ci:3.3.3
|
||||
image: barichello/godot-ci:4.3
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup
|
||||
run: |
|
||||
mkdir -p ~/.local/share/godot/templates/
|
||||
mv /root/.local/share/godot/templates/$GODOT_VERSION.stable ~/.local/share/godot/templates/$GODOT_VERSION.stable
|
||||
mkdir -p ~/.local/share/godot/export_templates/
|
||||
mv /root/.local/share/godot/export_templates/$GODOT_VERSION.stable ~/.local/share/godot/export_templates/$GODOT_VERSION.stable
|
||||
|
||||
- name: Export projects to HTML5
|
||||
- name: Export projects to Web
|
||||
run: |
|
||||
apt-get update -qq && apt-get install -qqq imagemagick
|
||||
|
||||
# Don't export Mono demos (not supported yet), demos that can't be run in HTML5
|
||||
# since they're platform-specific or demos that are currently broken in HTML5.
|
||||
# Don't export Mono demos (not supported yet), demos that can't be run in Web
|
||||
# since they're platform-specific or demos that are currently broken in Web.
|
||||
# Remember to update `.github/dist/footer.html` when updating the list of excluded demos.
|
||||
rm -rf \
|
||||
2d/hdr/ \
|
||||
3d/global_illumination/ \
|
||||
2d/glow/ \
|
||||
2d/navigation_mesh_chunks/ \
|
||||
2d/physics_tests/ \
|
||||
3d/labels_and_texts/ \
|
||||
3d/decals/ \
|
||||
3d/ik/ \
|
||||
3d/navigation_mesh_chunks/ \
|
||||
3d/occlusion_culling_mesh_lod/ \
|
||||
3d/particles/ \
|
||||
3d/physical_light_camera_units/ \
|
||||
3d/physics_tests/ \
|
||||
3d/variable_rate_shading/ \
|
||||
3d/volumetric_fog/ \
|
||||
3d/voxel/ \
|
||||
audio/bpm_sync/ \
|
||||
audio/device_changer/ \
|
||||
loading/background_load/ \
|
||||
loading/multiple_threads_loading/ \
|
||||
loading/threads/ \
|
||||
audio/midi_piano/ \
|
||||
audio/spectrum/ \
|
||||
compute/ \
|
||||
gui/msdf_font/ \
|
||||
gui/translation/ \
|
||||
loading/runtime_save_load \
|
||||
misc/compute_shader_heightmap \
|
||||
misc/large_world_coordinates/ \
|
||||
misc/matrix_transform/ \
|
||||
mobile/android_iap/ \
|
||||
mobile/sensors/ \
|
||||
@@ -45,10 +62,10 @@ jobs:
|
||||
plugins/
|
||||
|
||||
for panorama in 3d/material_testers/backgrounds/*.hdr; do
|
||||
# Decrease the resolution to get below the 20 MB per-file limit.
|
||||
# Otherwise, the website can't be deployed as files larger than 20 MB
|
||||
# can't be pushed to GitHub anymore.
|
||||
mogrify -resize 75% "$panorama"
|
||||
# Decrease the resolution to get below the 100 MB PCK size limit.
|
||||
# Otherwise, the website can't be deployed as files larger than 100 MB
|
||||
# can't be pushed to GitHub.
|
||||
mogrify -resize 66.667% "$panorama"
|
||||
done
|
||||
|
||||
BASEDIR="$PWD"
|
||||
@@ -56,27 +73,31 @@ jobs:
|
||||
# Use absolute paths so that we can `cd` without having to go back to the parent directory manually.
|
||||
for demo in */*/; do
|
||||
echo ""
|
||||
echo "================================"
|
||||
echo ""
|
||||
echo "================================================================================"
|
||||
echo "Exporting demo $demo..."
|
||||
echo "================================"
|
||||
echo "================================================================================"
|
||||
|
||||
mkdir -p "$BASEDIR/.github/dist/$demo"
|
||||
cd "$BASEDIR/$demo"
|
||||
|
||||
# Copy an export template preset file configured for HTML5 exporting.
|
||||
# Copy an export template preset file configured for Web exporting.
|
||||
# This way, we don't have to commit `export_presets.cfg` for each project.
|
||||
cp "$BASEDIR/.github/dist/export_presets.cfg" .
|
||||
godot --export "HTML5" "$BASEDIR/.github/dist/$demo/index.html"
|
||||
# Enable ETC2 texture importing, which is disabled by default (but required for web exports to work on mobile platforms).
|
||||
echo "[rendering]\n\ntextures/vram_compression/import_etc2_astc=true" >> project.godot
|
||||
|
||||
godot --verbose --headless --export-release "Web" "$BASEDIR/.github/dist/$demo/index.html"
|
||||
|
||||
# Replace the WASM file with a symbolic link to avoid duplicating files in the pushed branch.
|
||||
# (WASM files are identical across projects, but not PCK or HTML files.)
|
||||
# (WASM files are identical across projects, but not PCK or HTML/JavaScript files.)
|
||||
mv -f "$BASEDIR/.github/dist/$demo/index.wasm" "$BASEDIR/.github/dist/index.wasm"
|
||||
# The symlink must be relative as it needs to point to a file within the pushed repository.
|
||||
ln -s "../../index.wasm" "$BASEDIR/.github/dist/$demo/index.wasm"
|
||||
|
||||
# Append the demo to the list of demos for the website.
|
||||
PROJECT_NAME=$(cat project.godot | grep "config/name" | cut -d '"' -f 2 | tr -d "\n")
|
||||
echo "<li><a href='$demo'><img width="64" height="64" src="$demo/favicon.png" alt=""><p>$PROJECT_NAME</p></a></li>" >> "$BASEDIR/.github/dist/demos.html"
|
||||
echo "<li><a href='$demo'><img width="64" height="64" src="$demo/index.icon.png" alt=""><p>$PROJECT_NAME</p></a></li>" >> "$BASEDIR/.github/dist/demos.html"
|
||||
done
|
||||
|
||||
cat "$BASEDIR/.github/dist/header.html" "$BASEDIR/.github/dist/demos.html" "$BASEDIR/.github/dist/footer.html" > "$BASEDIR/.github/dist/index.html"
|
||||
@@ -89,12 +110,9 @@ jobs:
|
||||
run: |
|
||||
apt-get update -qq && apt-get install -qqq rsync
|
||||
- name: Deploy to GitHub Pages 🚀
|
||||
uses: JamesIves/github-pages-deploy-action@releases/v3
|
||||
uses: JamesIves/github-pages-deploy-action@releases/v4
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
# The branch the action should deploy to.
|
||||
BRANCH: gh-pages
|
||||
# The folder the action should deploy.
|
||||
FOLDER: .github/dist
|
||||
folder: .github/dist
|
||||
# Artifacts are large; don't keep the branch's history.
|
||||
SINGLE_COMMIT: true
|
||||
single-commit: true
|
||||
2
.github/workflows/static_checks.yml
vendored
2
.github/workflows/static_checks.yml
vendored
@@ -4,7 +4,7 @@ on: [push, pull_request]
|
||||
jobs:
|
||||
format:
|
||||
name: File formatting (file_format.sh)
|
||||
runs-on: ubuntu-20.04
|
||||
runs-on: ubuntu-24.04
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
Reference in New Issue
Block a user