Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions pages/common/pygbag.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# pygbag

> Package Pygame projects as WebAssembly to run in web browsers.
> More information: <https://pygame-web.github.io>.

- Package a Pygame project and start a local test server:

`pygbag {{path/to/project_folder}}`

- Package using Python module syntax:

`python -m pygbag {{path/to/project_folder}}`

- Package and build without starting the test server:

`pygbag --build {{path/to/project_folder}}`

- Package with a specific template:

`pygbag --template {{template_name.tmpl}} {{path/to/project_folder}}`

- Package and create a ZIP archive for itch.io:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Package and create a ZIP archive for itch.io:
- Package and create a ZIP archive for <https://itch.io>:


`pygbag --archive {{path/to/project_folder}}`

- Package with optimization turned off:

`pygbag --no_opt {{path/to/project_folder}}`

- Specify a custom port for the test server:

`pygbag --port {{8080}} {{path/to/project_folder}}`

- Display help information:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/tldr-pages/tldr/blob/31155568aa9cc4db7b2d7a29e3c4674f4010b059/contributing-guides/style-guide.md#help-and-version-commands

For consistency, we prefer generic wording Display help

Suggested change
- Display help information:
- Display help:


`pygbag --help`