Skip to content

Commit 268bd7b

Browse files
authored
Update README.md
1 parent a185088 commit 268bd7b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ Read Pygbag's [project description](https://pypi.org/project/pygbag/) for a more
2020
- Put the import statements of complex packages in order (but numpy first) at the top of `main.py`.
2121
- Avoid using CPython's standard library for web operations, GUI (like tkinter), or I/O as it is very synchronous/platform-specific and will probably stay that way. In terms of GUI alternatives, [pygame_gui](https://pypi.org/project/pygame_gui) works on top of [pygame-ce](https://pyga.me), [Panda3D](https://www.panda3d.org/) provides [directgui](https://docs.panda3d.org/1.10/python/programming/gui/directgui/index) and Harfang3D provides imgui. They are all cross-platform.
2222
- You can add a square image file named `favicon.png` in your game's root folder to make Pygbag use it as the web package's favicon.
23-
- Make sure all audio files are in OGG format, and all image files are compressed. (that is, not in BMP)
23+
- Make sure all audio files are in OGG format, and all files are compressed. (that is, not in WAV/AIFF)
24+
- Avoid raw formats like BMP for your image assets, they are too big for web use; use PNG/WEBP or JPG instead.
25+
2426
- Do not use filenames like `*-pygbag.*` that pattern is reserved for pygbag internal use (optimizing pass).
2527

2628
Before packaging, adapt your code this way if you still want WAV/MP3 format on desktop:
@@ -53,8 +55,6 @@ if sys.platform == "emscripten":
5355

5456
- When using webusb ftdi serial emulation, use `sudo rmmod ftdi_sio` after plugging devices.
5557

56-
Avoid raw formats like BMP for your image assets, they are too big for web use; use PNG or JPG instead.
57-
5858
## Template
5959

6060
There is actually none, because Python-WASM is just a web-friendly version of CPython REPL with [some added facilities](https://discuss.python.org/t/status-of-wasm-in-cpythons-main-branch/15542/12?u=pmp-p). Most desktop code will run (and continue to run) with only a few changes.

0 commit comments

Comments
 (0)