The runtime ships in the project’s environment (.venv). Inside it, the command is python -m pgstudio.
| Command |
What it does |
run <project> |
Runs the game. |
preview <project> |
The preview server the editor uses to draw the scene (needs the websockets package). |
export <project> --out <folder> |
Builds a program for this system (needs PyInstaller). |
docs |
Generates the node reference as Markdown. |
schema |
Exports the node class schema as JSON. |
run
python -m pgstudio run .
python -m pgstudio run . --scene scenes/fase2.scene.json
python -m pgstudio run . --headless --frames 30
| Option |
What it does |
--scene |
Scene to open. The default is start_scene from project.toml. |
--headless |
No window (tests and CI). |
--frames N |
Quit after N frames. |
--dev |
Opens the development channel the editor uses (needs websockets). |
--no-raise |
Don’t bring the game window to the front. |
export
python -m pgstudio export . --out dist --name MyGame
python -m pgstudio export . --out dist --web
| Option |
What it does |
--out |
Output folder (required). |
--name |
Program name. The default is the project’s. |
--icon |
Icon: .icns on Mac, .ico on Windows, .png on Linux. |
--web |
Builds a browser folder with pygbag instead of a desktop program (experimental). |