Skip to content

Conversation

kekwlboy12469
Copy link
Contributor

@kekwlboy12469 kekwlboy12469 commented Oct 5, 2025

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 #17002

Command Added

  • pygbag: Package Pygame projects to run in web browsers via WebAssembly

Features Documented

  • Packaging and local testing with built-in server
  • Build-only mode without server
  • Template customization for different use cases
  • Creating deployment archives for itch.io
  • Disabling optimization when needed
  • Custom port configuration
  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

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
@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Oct 5, 2025
@kekwlboy12469 kekwlboy12469 requested a review from Managor October 5, 2025 16:28
@Managor Managor mentioned this pull request Oct 5, 2025
6 tasks
Copy link
Member

@Managor Managor left a comment

Choose a reason for hiding this comment

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

We had a recent change to the option order #18491. Would you mind changing the order and testing to make sure the commands work?

What I Fixed
Based on the tldr style guide PR tldr-pages#18491 that standardized argument order, I made these corrections:

Rule: Positional arguments (like {{path/to/project_folder}}) must come BEFORE option flags and options with arguments.
@kekwlboy12469 kekwlboy12469 requested a review from Managor October 6, 2025 15:56
@kekwlboy12469
Copy link
Contributor Author

can u please approve this pr too it will be a help for me too


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

- 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 {{path/to/project_folder}} --port {{8080}}`

- 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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Page request: pygbag
3 participants