Skip to main content

pygame wasm for everyone

Project description

pygbag

pygame wasm for everyone ( packager + test server )

"your_game_folder" must contains a main.py and its loop must be async aware eg :

import asyncio
import pygame

pygame.init()
pygame.display.set_mode((320, 240))
pygame.display.set_caption("TEST")


async def main():
    count = 3

    while True:
        print(f"""

        Hello[{count}] from Pygame

""")
        pygame.display.update()
        await asyncio.sleep(0)  # very important, and keep it 0

        if not count:
            pygame.quit()
            return
        count = count - 1

asyncio.run( main() )

# do not add anything from here
# asyncio.run is non block on pygame-wasm


usage:

    pip3 install pygbag --user --upgrade
    pygbag your_game_folder

command help:

    pygbag --help your_game_folder

eg

user@pp /data/git/pygbag-wip $ python3.8 -m pygbag --help test
 *pygbag 0.2.0*

Serving python files from [/data/git/pygbag-wip/test/build/web]

with no security/performance in mind, i'm just a test tool : don't rely on me

usage: __main__.py [-h] [--bind ADDRESS] [--directory DIRECTORY]
 [--app_name APP_NAME] [--ume_block UME_BLOCK] [--cache CACHE]
 [--package PACKAGE] [--title TITLE] [--version VERSION] [--build]
 [--archive] [--icon ICON] [--cdn CDN] [--template TEMPLATE]
 [--ssl SSL] [--port [PORT]]

optional arguments:
  -h, --help            show this help message and exit
  --bind ADDRESS        Specify alternate bind address [default: localhost]
  --directory DIRECTORY
                        Specify alternative directory [default:/data/git/pygbag-wip/test/build/web]
  --app_name APP_NAME   Specify user facing name of application[default:test]
  --ume_block UME_BLOCK
                        Specify wait for user media engagement before running[default:1]
  --cache CACHE         md5 based url cache directory
  --package PACKAGE     package name, better make it unique
  --title TITLE         App nice looking name
  --version VERSION     override prebuilt version path
  --build               build only, do not run test server
  --archive             make build/web.zip archive for itch.io
  --icon ICON           icon png file 32x32 min should be favicon.png
  --cdn CDN             web site to cache locally [default:http://localhost:8000/0.2.0/]
  --template TEMPLATE   index.html template
  --ssl SSL             enable ssl with server.pem and key.pem
  --port [PORT]         Specify alternate port [default: 8000]

Now navigate to http://localhost:8000 with a modern Browser. use http://localhost:8000#debug for getting a terminal and a sized down canvas

v8 based browsers are preferred ( chromium/brave/chrome ... ) because they set baseline restrictions on WebAssembly loading. using them while testing ensure proper operation on all browsers.

NOTES:

  • first load will be slower, because setting up local cache from cdn to avoid useless network transfer for getting pygame and cpython prebuilts.

  • each time changing code/template you must restart pygbag your_game_folder but cache is not destroyed.

  • if you want to reset prebuilts cache, remove the build/web-cache folder in your_game_folder

BUILDING:

pygbag is not only a python module, and rebuilding all the toolchain can be quite hard

https://github.com/pygame-web/python-wasm-sdk <= build CPython (not pyodide)

https://github.com/pygame-web/pygame-wasm-plus <= build pygame

then read/use pygbag CI to see how to build the C loader (pymain) and link it to libpython + libpygame

https://github.com/pygame-web/pygbag

prebuilts used by pygbag are stored on github from the repo https://github.com/pygame-web/archives

Support via Discord:

https://discord.gg/t3g7YjK7rw   ( #pygame-web on Pygame Community )

French support:

forum thead:
    https://discuss.afpy.org/t/moteur-2d-pour-python-pygame-web/834/2

irc:
    #python-fr-off on libera.chat

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygbag-0.2.0.tar.gz (25.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pygbag-0.2.0-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

Details for the file pygbag-0.2.0.tar.gz.

File metadata

  • Download URL: pygbag-0.2.0.tar.gz
  • Upload date:
  • Size: 25.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for pygbag-0.2.0.tar.gz
Algorithm Hash digest
SHA256 d48c81fd0bf928f04be8ba1a58295aeed644ed5127d7f4eb07c48aa69e1d0840
MD5 0d9fd1a08faa5f322f7446e80664e604
BLAKE2b-256 b5e2bbb823e1c749a7bfcebb2b8bb99e3d1f925533495091edfb10503ffaeb6b

See more details on using hashes here.

File details

Details for the file pygbag-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pygbag-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 26.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for pygbag-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6cd1845762394042365dabfff768499b0ad3aacd19f38373dfabe8064bf638d2
MD5 52e054c4267f12634ce286d3b675d12d
BLAKE2b-256 b710ea1de285a84be73fdd11b4776cad02afe798b1c34300d44c48a5b695b9d4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page