Skip to content

Enhance README with pygbag.ini configuration details #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ShivamKR12 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enhance README with pygbag.ini configuration details #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 13 additions & 2 deletions wiki/pygbag-configuration/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Pygbag Configuration (`pygbag.ini`)

TODO: pygbag.ini
The `pygbag.ini` file allows you to customize how Pygbag builds and packages your game. Its primary use is to define specific files and directories that should be excluded from your final web build (`.apk` or `.tar.gz`), keeping your game's download size as small as possible.

## File Format and Syntax

[Edit this page](https://github.com/pygame-web/pygame-web.github.io/edit/main/wiki/pygbag-configuration/README.md)
Pygbag parses this file using the `config-to-object` library. Because of this, the syntax for defining lists requires square brackets `[]` and quotes `""` around each item.

### Example `pygbag.ini`

Place this file in the root directory of your Pygbag project (right next to your `main.py`):

```ini
[DEPENDENCIES]
ignoreDirs = [".git", "venv", "docs"]
ignoreFiles = ["build_pwa.py", "README.md", ".gitignore"]