Metadata-Version: 2.5
Name: bomb3d
Version: 0.1.0
Summary: Parametric models for the IRL version of a game based on KTANE
Project-URL: Repository, https://github.com/reinodovo-bomb/bomb3d
Project-URL: Issues, https://github.com/reinodovo-bomb/bomb3d/issues
Author-email: Pedro Sousa <pedroteosousa@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Manufacturing
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Graphics :: 3D Modeling
Requires-Python: >=3.11
Requires-Dist: build123d>=0.11
Description-Content-Type: text/markdown

# bomb3d

Parametric 3D models for modules of an IRL game based on
[Keep Talking and Nobody Explodes](https://keeptalkinggame.com/), built with
[build123d](https://github.com/gumyr/build123d).

## Installation

```bash
pip install bomb3d
```

## Usage

```python
from bomb3d import ModuleType, module_bottom, module_top

top_main = module_top(10, ModuleType.Main)
top_puzzle = module_top(10, ModuleType.Puzzle)
top_needy = module_top(10, ModuleType.Needy)
bottom = module_bottom(10)
```

Each part is a `build123d` `Part`, so it can be exported to STL/STEP or
previewed with any build123d-compatible tool, e.g.
[ocp-vscode](https://github.com/bernhard-42/vscode-ocp-cad-viewer):

```python
from ocp_vscode import show
from build123d import pack

show(*pack([top_main, top_puzzle, top_needy, bottom], padding=10))
```

## Development

Install the dev dependency group (adds `ocp-vscode` for previewing parts):

```bash
pip install -e . --group dev
```

`scripts/preview.py` renders the module parts for a quick visual check.

## License

MIT, see [LICENSE](LICENSE).
