Add build target "web" #9406

ololoken · 2025-01-02T22:25:52Z

Prev PR for reference
Demo no files bundled and user can provide own sets of maps, music, mods;

@oleg-derevenetz would you check how synchronous playback is done in AsyncManager::notifyWorker, smelly workaround but it works;

BTW ci/cd pipeline can be done using gh-pages

ihhub · 2025-01-03T01:26:32Z

Hi @ololoken , please fix code style issues in the code to make the pipeline happy.

ololoken · 2025-01-03T02:01:15Z

@ihhub Well, I didn't find better way than disable linter checks for places where js code is mixed in cpp files.

oleg-derevenetz · 2025-01-03T02:05:11Z

Hi @ololoken please don't do these force-pushes. They completely break my changes.

ololoken · 2025-01-03T02:05:13Z

huh looks like push fork -f was too much

ok, it's late in my location so, feel free to add your changes. I'll get back tomorrow

ЗЫ можешь меня на lindkedin добавить? Roman

oleg-derevenetz · 2025-01-03T03:00:21Z

Hi @ololoken please take a look at #9407. I've changed the AsyncManager a bit for the better and minimized the volume of the Emscripten-dependent C++ code by moving the sync operation to a single place (see my comments in that PR). Also now it should pass all the checks, so you can grab my changes to your PR and make further changes based on them.

ЗЫ можешь меня на lindkedin добавить? Roman

Я не использую linkedin уже давным-давно :) Даже учетку не вижу смысла восстанавливать чтобы войти.

ololoken · 2025-01-03T03:47:21Z

@ihhub LGTM

Who is responsible for pipelines?

  make-web:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout ↓️
        uses: actions/checkout@v4

      - name: Install and Build ⚙
        run: |
          docker run --rm -v $(pwd):/src emscripten/emsdk:3.1.74 sh -c 'apt update && apt install -y gettext && emmake make  -f Makefile.web'

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@v4
        if: ${{ github.event_name == 'push' }}
        with:
          branch: fheroes2-gh-pages # The branch the action should deploy to.
          folder: src/dist/web/dist # The folder the action should deploy.

This requires enabled gh-pages in repo settings. The result is deployed build available via public url https://ihhub.github.io/fheroes2/

ihhub · 2025-01-03T05:34:48Z

Hi @ololoken ,

every developer can contribute to GitHub Actions pipeline. Since you are the first time contributor you aren't allowed to run the pipeline as per GitHub rules.

In order to add a new stage you need to add a new file inside .github/workflows directory and modify pull_request.yml and push.yml files.

Additionally, you don't need to explicitly use docker commands. All GitHub Runners are Docker based images.

oleg-derevenetz · 2025-01-03T09:27:09Z

@ihhub LGTM

Who is responsible for pipelines?

  make-web:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout ↓️
        uses: actions/checkout@v4

      - name: Install and Build ⚙
        run: |
          docker run --rm -v $(pwd):/src emscripten/emsdk:3.1.74 sh -c 'apt update && apt install -y gettext && emmake make  -f Makefile.web'

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@v4
        if: ${{ github.event_name == 'push' }}
        with:
          branch: fheroes2-gh-pages # The branch the action should deploy to.
          folder: src/dist/web/dist # The folder the action should deploy.

This requires enabled gh-pages in repo settings. The result is deployed build available via public url https://ihhub.github.io/fheroes2/

BTW I don't see the sdl2_mixer.py call here. Is this file still needed? In general, I thought that Emscripten has its own set of ports with (already patched) popular libraries, and scripts of this kind are no longer needed.

ololoken · 2025-01-03T15:42:13Z

@oleg-derevenetz dropped sdl2_mixer.py, left note how to build web version with enabled pthread.
@ihhub it's just dind(docker in docker call) image with baked emsdk gets pulled mounted do it's job.

Local build is stable an redeployed here https://turch.in/fheroes2/public/

I will continue work on:

UI of html launcher: buttons, general styling.
Zip archives support for saves/settings imports/exports.

oleg-derevenetz · 2025-01-03T15:55:22Z

Hi @ololoken

I implemented a few changes (please see my latest commit). Briefly:

I added the CI step (no gh pages so far, we still need to think about how to do it better, just the ZIP archive);
Renamed "web" to "emscripten", "web" is a bit too broad IMHO, because there are alternatives to emscripten to build C++ code to wasm;
Made the build system more similar to other platforms (no translation generation in the src/dist, etc).

I have a question BTW - I was unable to get your demo to work. It asks for a directory, I send it the directory with DATA and MAPS folders like this:

D:\Temp\homm2

03.01.2025  18:53    <DIR>          .
03.01.2025  18:53    <DIR>          ..
03.01.2025  18:03    <DIR>          DATA
03.01.2025  18:03    <DIR>          MAPS

D:\Temp\homm2\DATA

03.01.2025  18:03    <DIR>          .
03.01.2025  18:03    <DIR>          ..
09.03.2021  15:49        43 363 026 HEROES2.AGG
09.03.2021  15:49         2 598 847 HEROES2X.AGG

D:\Temp\homm2\MAPS

03.01.2025  18:03    <DIR>          .
03.01.2025  18:03    <DIR>          ..
09.03.2021  15:49           139 387 BROKENA.MP2

and... nothing happens. Only these:

fheroes2.js:617 still waiting on run dependencies:
fheroes2.js:619 dependency: syncfs
fheroes2.js:622 (end of list)

in the browser console. Why is that?

P.S. In any case, if there will be any fixes for this issue, I suggest to wait for merging this PR and then address this issue later separately in new PRs.

Hi @ihhub

I suggest the following - now we can do a review and merge this PR (if review is OK) so that @ololoken will get his contributor badge and and there will be no need to run CI manually anymore. Then he will be able to gradually add new functionality via individual PRs from separate branches.

ololoken · 2025-01-03T15:59:52Z

@oleg-derevenetz expected directory structure:
/data/*.agg

oleg-derevenetz · 2025-01-03T16:02:31Z

@oleg-derevenetz expected directory structure: /data/*.agg

Yes, I specify my D:\Temp\homm2 folder which has two subfolders - DATA and MAPS. DATA has both AGG files. Should I specify the D:\Temp\homm2\DATA folder instead? How about maps in this case?

ololoken · 2025-01-03T16:04:53Z

@oleg-derevenetz
I have concerns only about no translation generation in the src/dist. Language files must be prepared before em linker spawns, as linker creates static files bundle with languages font and h2d file

oleg-derevenetz · 2025-01-03T19:13:26Z

I suppose we will be able to bring threads back when emscripten-core/emscripten#23094 will be merged. Despite the fact that everything is more or less working now (except the MIDI playback), the logic of resuming background music is not working correctly, because it relies on a certain order of execution of interrelated actions due to synchronization between threads, namely - when playback of a music track is stopped, the stopping thread holds a mutex while it remembers the position of the music track and makes a proper cleanup, and only when this mutex is released, the other thread intended to restart the music track gets the chance to run. Now the logic is reversed (sort of) because there are no threads and no proper synchronization. But this issue is a relatively minor one.

…he beginning

ihhub · 2025-01-04T01:11:32Z

Hi @ololoken , please revert your last commit 37d06f1. Using any resources from the original game is not permitted.

Also, let's leave beautification part for later.

ihhub

Hi @ololoken , I left 2 more questions here. Could you please check them?

files/emscripten/fheroes2.jpeg

files/emscripten/index.html

… in write mode

zenseii · 2025-01-04T11:46:56Z

@oleg-derevenetz

P.S. Here is the ZIP archive (I'll remove the link later):

[removed link]

I suggest deleting the edit history of this post because it still contains the link.

oleg-derevenetz · 2025-01-04T21:53:59Z

MIDI music playback also works now. Now we can think about deploying the WASM engine with a demo version on GitHub Pages so that anyone can come and play the demo version (but first we need to resolve the issue with SDL_mixer and pthreads, because currently everything is single-threaded and the music chokes when the main thread is busy with something).

Hi @ihhub what specific issues are left with this PR? Let's solve them and merge this PR, so that @ololoken and, to some extent, I could gradually work on new WASM aspects in separate PRs. @ololoken will get the contributor badge and there will be no need for us to manually confirm all CI runs.

ololoken · 2025-01-04T22:21:28Z

latest build of this branch is deployed to https://turch.in/fheroes2/public/

oleg-derevenetz · 2025-01-04T22:29:19Z

Hi @ololoken

latest build of this branch is deployed to https://turch.in/fheroes2/public/

It looks like it is not the latest build yet - it still calls extra FS.syncfs() (resolved in 9cbb468) and doesn't support the MIDI playback (resolved in ae788dd). Try to pull the latest changes and rebuild.

ololoken · 2025-01-04T22:58:46Z

Indeed, an old build was uploaded, thanks. Updated.

ihhub · 2025-01-05T09:20:14Z

HI @ololoken and @oleg-derevenetz , I solved the remaining problems with files:

updated the image of a smaller size
reverted 37d06f1 commit as it violated copyright

Please take a look.

oleg-derevenetz · 2025-01-05T09:24:28Z

Hi @ihhub

reverted 37d06f1 commit as it violated copyright

Why is this commit violated copyright? Because of the fonts?

ihhub · 2025-01-05T09:25:25Z

Hi @ihhub

reverted 37d06f1 commit as it violated copyright

Why is this commit violated copyright? Because of the fonts?

Yes, the fonts were originated from the original in-game fonts.

oleg-derevenetz · 2025-01-05T09:27:22Z

Yes, the fonts were originated from the original in-game fonts.

Ah, OK then.

ihhub · 2025-01-05T09:52:21Z

@ololoken , huge thanks for the contribution to the project!

Add build target "web"

fbe8630

github-actions bot assigned ololoken Jan 2, 2025

Deal with AsyncManager

7e491d7

oleg-derevenetz added 3 commits January 3, 2025 04:32

Move the FS.syncfs() call to the serialize.cpp

0c31b7c

Merge branch master into master-ololoken

70910d3

Update the copyright headers

188897e

ololoken force-pushed the master branch from 188897e to fa67518 Compare January 3, 2025 01:59

Apply the IWYU suggestions

3473526

oleg-derevenetz mentioned this pull request Jan 3, 2025

Temporary PR for Emscripten #9407

Closed

oleg-derevenetz added 2 commits January 3, 2025 05:24

Ignore the clang-format for JS code

00bab79

Style nits

7ba3604

Move the sync operation to deleter

214fe9a

ihhub added improvement New feature, request or improvement GitHub Actions GitHub Actions CI labels Jan 3, 2025

remove pthread related patch; update web build description; add pipeline

a5aff48

ololoken force-pushed the master branch from fa67518 to 214fe9a Compare January 3, 2025 15:31

Rename "web" to "emscripten", simplify the build, add CI

82ef673

oleg-derevenetz requested a review from ihhub January 3, 2025 17:34

oleg-derevenetz added the WASM WASM version of the engine label Jan 3, 2025

oleg-derevenetz added 3 commits January 3, 2025 22:30

Forcibly reset the track position if music playback is started from t…

ed1f299

…he beginning

Update the copyright date

3382fe4

Add comment

885de6e

oleg-derevenetz approved these changes Jan 3, 2025

View reviewed changes

use heroes2-pixed font for wasm launcher

37d06f1

ihhub reviewed Jan 4, 2025

View reviewed changes

files/emscripten/fheroes2.jpeg Outdated Show resolved Hide resolved

files/emscripten/index.html Show resolved Hide resolved

ololoken and others added 2 commits January 3, 2025 20:36

remove texture from original game

c3a007f

Call the FS.syncfs() only when the corresponding file has been opened…

9cbb468

… in write mode

oleg-derevenetz added 4 commits January 4, 2025 15:49

Style nits

120c27d

Make the static_assert stricter

b310179

Add support for the MIDI playback

ae788dd

Merge branch master into master-ololoken

2595be3

ihhub added 2 commits January 5, 2025 17:12

Update the background image

99ef992

Revert changes done in 37d06f1 commit

0f1f6d5

ihhub merged commit 076150e into ihhub:master Jan 5, 2025
21 checks passed

ihhub mentioned this pull request Jan 5, 2025

WASM version improvements #9411

Open

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add build target "web" #9406

Add build target "web" #9406

ololoken commented Jan 2, 2025 •

edited

Loading

ihhub commented Jan 3, 2025

ololoken commented Jan 3, 2025

oleg-derevenetz commented Jan 3, 2025

ololoken commented Jan 3, 2025 •

edited

Loading

oleg-derevenetz commented Jan 3, 2025 •

edited

Loading

ololoken commented Jan 3, 2025

ihhub commented Jan 3, 2025

oleg-derevenetz commented Jan 3, 2025 •

edited

Loading

ololoken commented Jan 3, 2025

oleg-derevenetz commented Jan 3, 2025 •

edited

Loading

ololoken commented Jan 3, 2025

oleg-derevenetz commented Jan 3, 2025

ololoken commented Jan 3, 2025

oleg-derevenetz commented Jan 3, 2025 •

edited

Loading

ihhub commented Jan 4, 2025 •

edited

Loading

ihhub left a comment

zenseii commented Jan 4, 2025

oleg-derevenetz commented Jan 4, 2025 •

edited

Loading

ololoken commented Jan 4, 2025

oleg-derevenetz commented Jan 4, 2025 •

edited

Loading

ololoken commented Jan 4, 2025

ihhub commented Jan 5, 2025

oleg-derevenetz commented Jan 5, 2025

ihhub commented Jan 5, 2025

oleg-derevenetz commented Jan 5, 2025

ihhub commented Jan 5, 2025

Add build target "web" #9406

Add build target "web" #9406

Conversation

ololoken commented Jan 2, 2025 • edited Loading

ihhub commented Jan 3, 2025

ololoken commented Jan 3, 2025

oleg-derevenetz commented Jan 3, 2025

ololoken commented Jan 3, 2025 • edited Loading

oleg-derevenetz commented Jan 3, 2025 • edited Loading

ololoken commented Jan 3, 2025

ihhub commented Jan 3, 2025

oleg-derevenetz commented Jan 3, 2025 • edited Loading

ololoken commented Jan 3, 2025

oleg-derevenetz commented Jan 3, 2025 • edited Loading

ololoken commented Jan 3, 2025

oleg-derevenetz commented Jan 3, 2025

ololoken commented Jan 3, 2025

oleg-derevenetz commented Jan 3, 2025 • edited Loading

ihhub commented Jan 4, 2025 • edited Loading

ihhub left a comment

Choose a reason for hiding this comment

zenseii commented Jan 4, 2025

oleg-derevenetz commented Jan 4, 2025 • edited Loading

ololoken commented Jan 4, 2025

oleg-derevenetz commented Jan 4, 2025 • edited Loading

ololoken commented Jan 4, 2025

ihhub commented Jan 5, 2025

oleg-derevenetz commented Jan 5, 2025

ihhub commented Jan 5, 2025

oleg-derevenetz commented Jan 5, 2025

ihhub commented Jan 5, 2025

ololoken commented Jan 2, 2025 •

edited

Loading

ololoken commented Jan 3, 2025 •

edited

Loading

oleg-derevenetz commented Jan 3, 2025 •

edited

Loading

oleg-derevenetz commented Jan 3, 2025 •

edited

Loading

oleg-derevenetz commented Jan 3, 2025 •

edited

Loading

oleg-derevenetz commented Jan 3, 2025 •

edited

Loading

ihhub commented Jan 4, 2025 •

edited

Loading

oleg-derevenetz commented Jan 4, 2025 •

edited

Loading

oleg-derevenetz commented Jan 4, 2025 •

edited

Loading