Skip to content

Commit 0922664

Browse files
committed
pygbag: add page
Add tldr page for pygbag - a tool for packaging Pygame games as WebAssembly. pygbag allows Python/Pygame games to run directly in web browsers without requiring users to install anything. It compiles projects to WebAssembly and includes a built-in test server for local testing. Closes tldr-pages#17002
1 parent 33f2386 commit 0922664

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

pages/common/pygbag.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# pygbag
2+
3+
> Package Pygame projects as WebAssembly to run in web browsers.
4+
> More information: <https://pygame-web.github.io>.
5+
6+
- Package a Pygame project and start a local test server:
7+
8+
`pygbag {{path/to/project_folder}}`
9+
10+
- Package using Python module syntax:
11+
12+
`python -m pygbag {{path/to/project_folder}}`
13+
14+
- Package and build without starting the test server:
15+
16+
`pygbag --build {{path/to/project_folder}}`
17+
18+
- Package with a specific template:
19+
20+
`pygbag --template {{template_name.tmpl}} {{path/to/project_folder}}`
21+
22+
- Package and create a ZIP archive for itch.io:
23+
24+
`pygbag --archive {{path/to/project_folder}}`
25+
26+
- Package with optimization turned off:
27+
28+
`pygbag --no_opt {{path/to/project_folder}}`
29+
30+
- Specify a custom port for the test server:
31+
32+
`pygbag --port {{8080}} {{path/to/project_folder}}`
33+
34+
- Display help information:
35+
36+
`pygbag --help`

0 commit comments

Comments
 (0)