メむンコンテンツぞスキップ
芋出し画像

Pyxelで䜜成したWebアプリをPWAにする

    Pyxelで䜜ったゲヌムはWebアプリずしお公開できるので、SNSなどでシェアしおスマホから気軜にアクセスしおもらうこずが可胜ですが、PWA芁件を満たすこずでよりスマホアプリっぜく䜿っおもらうこずができたす。
    この蚘事のサムネむル画像↑が実際にPWAずしおホヌム画面に衚瀺したむメヌゞです。

    PWA察応のやり方

    PWA芁件を満たすのは倧しお難しくなく、

    • Service Worker ず呌ばれるJSファむル

    • manifest.json ずいうアプリのメタ情報やアむコンなどを指定する蚭定ファむル

    を甚意しお、index.htmlから䞊蚘のファむルを参照すればOKです。
    この2぀に぀いおは詳しく解説しおいる蚘事がいくらでもあるので、ここでは觊れたせんずいうか、私が詳しくありたせん。
    ずりあえず最䜎限のものを準備しおみたしょう。

    たずmanifest.jsonです。
    ホヌム画面のアむコンが必芁なので、ここでは「icon-192.png」を指定しおいたす。

    {
      "name": "Pyxel-web-template",
      "short_name": "PyxelApp",
      "description": "This is PyxelApp",
      "icons": [
        {
          "src": "./icon-192.png",
          "sizes": "192x192",
          "type": "image/png"
        }
      ],
      "start_url": "/index.html",
      "display": "standalone",
      "scope": "/",
      "theme_color": "#000",
      "background_color": "#000"
    }

    次にService Worker、sw.jsです。

    self.addEventListener("fetch", (event) => {})

    䜕のこっちゃ意味䞍明ですが、ずりあえずこれで倧䞈倫でした。

    これらをindex.htmlから参照させたす。Pyxelの暙準コマンドで生成したHTMLファむルは以䞋のような構造になっおいたす。

    <!DOCTYPE html>
    <script src="https://cdn.jsdelivr.net/gh/kitao/pyxel/wasm/pyxel.js"></script>
    <script>
      launchPyxel({
        command: "play",
        name: "app.pyxapp",
        gamepad: "enabled",
        base64: "略",
      })
    </script>

    ここにmanifest.jsonやsw.jsを読み蟌むコヌドを入れればOKです。

    <!DOCTYPE html>
    <link rel="manifest" href="/manifest.json" />
    <script>
      if ("serviceWorker" in navigator) navigator.serviceWorker.register("/sw.js")
    </script>
    <script src="https://cdn.jsdelivr.net/gh/kitao/pyxel/wasm/pyxel.js"></script>
    <script>
      launchPyxel({
        command: "play",
        name: "app.pyxapp",
        gamepad: "enabled",
        base64: "略",
      })
    </script>

    ぀いでに画面サむズを最適化する

    本題は以䞊ですが、぀いでにPyxelアプリをWeb化するずきに気になりがちな画面サむズの問題を修正したす。

    Pyxelでは画面サむズが最倧256pxたで指定できたすが、Webブラりザで動かす堎合、アプリの画面はデバむスやブラりザのサむズに収たる範囲で「アプリの倧きさ x N敎数」のサむズが遞ばれるようです。

    たずえば暪幅375pxのiPhoneSEだず、256x1 < 375, 256x2 > 375なので、ブラりザ内のサむズは256 x 256ずなりたす。
    するず次の画像のように巊右にマヌゞンができお、小さいスマホ画面のさらに䞀郚しか䜿えない状態になっおしたいたす。
    衚瀺しおいるアプリはPyxel公匏のサンプルです。

    画像

    これはちょっずもったいないずいうか、できるだけ画面を倧きく䜿いたいので、HTMLのmetaタグで画面幅を指定するこずでマヌゞンを぀ぶしたす。
    具䜓的には画面幅を512pxず指定するず・・

    画像

    このように画面いっぱいに広がっおくれたした。
    やり方は、HTMLファむルにさらに以䞋のコヌドを远加するだけです。

    <meta name="viewport" content="width=512" />

    画面幅が512より倧きいタブレットやPCの堎合は䞊の蚘述は無芖されたすが、十分な倧きさを確保できおいるのでそれでOK、ず考えたす。
    䞀般的なスマホは暪幅が360〜450くらいなはずなので、アプリの暪幅が256pxならwidth=512、240pxならwidth=480、192pxならwidth=576、ずいったように「䞀般的なスマホの暪幅を少し超える、アプリの暪幅の倍数倀」を指定するのがいいかなず思っおいたす。

    なお、画面を暪回転しおしたうずこの蚭定は無意味になっおしたいたす。
    䜕か手の打ちようもあるかもしれたせんが、今のずころ私は諊めおいたす。

    䞀連の手順をシェルスクリプト化する

    さお、開発したアプリは䞀床リリヌスしたら終わりずは限らず、バグ修正したりバヌゞョンアップするこずがあるかず思いたす。

    そのたびに、Pyxelの暙準コマンドが吐き出したHTMLファむルを手修正するのは面倒ですね。
    たた、先ほどのmanifest.jsonやらアむコン画像やらもいちいちHTMLファむルず同じフォルダにコピヌしたりする必芁がありたす。

    ずいうこずで、シェルスクリプトを䜿っおそのあたりを自動化するず䟿利です自分はMacナヌザです。
    「makehtml.sh」ず呜名したした。

    pyxel package ./app ./app/main.py
    pyxel app2html app.pyxapp
    rm -rf public/*
    mv app.html public/index.html
    OLD="<!DOCTYPE html>"
    NEW="<!DOCTYPE html><meta name='viewport' content='width=512' /><link rel='manifest' href='/manifest.json' /><script> if ('serviceWorker' in navigator) navigator.serviceWorker.register('/sw.js')</script>"
    OLD_ESCAPED=$(echo "$OLD" | sed 's/[\/&]/\\&/g')
    NEW_ESCAPED=$(echo "$NEW" | sed 's/[\/&]/\\&/g')
    sed -i '' "s/${OLD_ESCAPED}/${NEW_ESCAPED}/g" public/index.html
    cp static/* public/
    rm -f app.pyxapp
    cd public
    python3 -m http.server 8000

    Windowsの堎合はこうなるようです。
    ※ChatGPTさんに出力しおもらいたした。すみたせんが動䜜未確認です。
    「makehtml.bat」ずしおおきたしょう。

    @echo off
    REM パッケヌゞングずHTML倉換
    pyxel package .\app .\app\main.py
    pyxel app2html app.pyxapp
    
    REM 叀いファむルの削陀ず新しいファむルの移動
    if exist public\ del /Q public\*
    move app.html public\index.html
    
    REM HTMLファむルの曎新
    setlocal enabledelayedexpansion
    set "OLD=<!DOCTYPE html>"
    set "NEW=<!DOCTYPE html><meta name='viewport' content='width=512' /><link rel='manifest' href='/manifest.json' /><script> if ('serviceWorker' in navigator) navigator.serviceWorker.register('/sw.js')</script>"
    set "FILE=public\index.html"
    set "TEMPFILE=%FILE%.tmp"
    
    REM ファむルの眮換
    (
        for /f "tokens=*" %%a in ('type "%FILE%"') do (
            set "line=%%a"
            set "line=!line:%OLD%=%NEW%!"
            echo !line!
        )
    ) > "%TEMPFILE%"
    move /Y "%TEMPFILE%" "%FILE%"
    
    REM 静的ファむルのコピヌ
    xcopy /Y static\* public\
    
    REM 䞍芁なファむルの削陀
    del app.pyxapp
    
    REM サヌバの起動
    cd public
    python -m http.server 8000

    かなり汚いシェルですが、pyxelのコマンドを入力したり、sedコマンドで匷匕にHTMLファむルを曞き換えたりしおいたす。

    党䜓の構造

    .
    ├── app # ここに゜ヌスファむルやアセットを眮く
    │   └── main.py
    ├── makehtml.bat # デプロむ甚スクリプトWin、未怜蚌
    ├── makehtml.sh # デプロむ甚スクリプトMac
    ├── public # makehtml.shを実行するずここが曎新されるので、フォルダごずサヌバヌにアップする。
    │   ├── favicon.ico
    │   ├── icon-192.png
    │   ├── index.html
    │   ├── manifest.json
    │   └── sw.js
    └── static # アむコンやファビコンなどのWebリ゜ヌスをここに眮く
        ├── favicon.ico
        ├── icon-192.png
        ├── manifest.json
        └── sw.js

    こんな感じになりたした。
    それなりに汎甚性があるず思いたすので、テンプレヌトずしおGitHubに眮いおおきたす。
    よろしければどうぞお䜿いください。もちろんお奜みに応じお加工いただいお党く問題ありたせん。


     
     

    frenchbread

     
     
    レトロゲヌム゚ンゞン「pyxel」を䜿っおゲヌム制䜜しおいたす。Steam / App Store / Google Playで販売実瞟あり。

    あなたぞのおすすめ