Metadata-Version: 2.4
Name: pacab
Version: 0.1.2
Summary: Pacab - The Point and Click Adventure Builder
Home-page: https://gitlab.com/neilsimp1/pacab
Author: neilsimp1
Author-email: Neil Simpson <neilsimp1@gmail.com>
License-Expression: GPL-3.0-only
Project-URL: Homepage, https://gitlab.com/neilsimp1/pacab
Project-URL: Issues, https://gitlab.com/neilsimp1/pacab/-/issues
Project-URL: Source Code, https://gitlab.com/neilsimp1/pacab
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Software Development :: Libraries :: pygame
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: COPYING
Requires-Dist: altgraph==0.17.4
Requires-Dist: click==8.2.1; python_full_version >= "3.10"
Requires-Dist: markdown-it-py==3.0.0; python_full_version >= "3.8"
Requires-Dist: mdurl==0.1.2; python_full_version >= "3.7"
Requires-Dist: packaging==25.0; python_full_version >= "3.8"
Requires-Dist: pillow==12.0.0; python_full_version >= "3.9"
Requires-Dist: pygame-ce==2.5.6; python_full_version >= "3.9"
Requires-Dist: pygame-menu-ce==4.5.4; python_full_version >= "3.8" and python_full_version < "4"
Requires-Dist: pygments==2.19.1; python_full_version >= "3.8"
Requires-Dist: pyinstaller==6.16.0; python_full_version >= "3.8" and python_full_version < "3.14"
Requires-Dist: pyinstaller-hooks-contrib==2025.8; python_full_version >= "3.8"
Requires-Dist: pyperclip==1.9.0
Requires-Dist: rich==14.0.0; python_full_version >= "3.8"
Requires-Dist: setuptools==80.9.0; python_full_version >= "3.9"
Requires-Dist: shellingham==1.5.4; python_full_version >= "3.7"
Requires-Dist: toml==0.10.2; python_full_version >= "2.6"
Requires-Dist: typer-slim[standard]==0.20.0; python_full_version >= "3.7"
Requires-Dist: typing-extensions==4.13.2; python_full_version >= "3.8"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: platform
Dynamic: requires-python

![Pacab logo](https://gitlab.com/neilsimp1/pacab/-/raw/main/icon.png "Pacab")

# Pacab

Pacab is the Point and Click Adventure Builder.
It's a game engine/utility/library written in Python that leverages Pygame, Pygame Menu, Pyinstaller, and others.
Pacab takes as input a bunch of image files and text files describing those images, and turns it into a playable game.

# How to use

Pacab has documentation for how to build a game available [here](./doc/intro.md).
It also comes bundled with an example game (Alt+Escape) which is meant as a demo of every feature in this game engine.

# How to run the example game

Using `uv`:
`uv add -r requirements.txt` to install dependencies.

Run `uv run python -m pacab.cli.cli --help` to get help on the CLI.
Example commands for running the example game:

```sh
uv run python -m pacab.cli.cli run --debug ./example/alt-escape.toml
uv run python -m pacab.cli.cli build ./example/alt-escape.toml
```

# How to start your own Pacab game

```sh
mkdir my-game
cd my-game
uv run pip install -i https://pypi.org/simple pacab
uv run python -m pacab.cli.cli init
```

# Credits

- pillow
- pygame-ce
- pygame-menu-ce
- pyinstaller
- tomlib
- typer
