Metadata-Version: 2.5
Name: SimVX-Examples
Version: 0.0.0.dev3104
Summary: The SimVX example library: feature references, tutorials, demos and ports of existing games.
Project-URL: Homepage, https://simvx.com
Project-URL: Documentation, https://simvx.com/docs/examples/index.html
Project-URL: Source, https://git.simvx.com/simvx/simvx
Project-URL: Issues, https://git.simvx.com/simvx/simvx/issues
Project-URL: Changelog, https://git.simvx.com/simvx/simvx/commits/branch/main
Author-email: SimVX <contact@simvx.com>
License-Expression: MIT AND GPL-3.0-or-later AND Zlib AND CC0-1.0 AND CC-BY-3.0 AND CC-BY-SA-4.0
License-File: ENGINE_LICENCE.md
License-File: LICENSE
License-File: ports/balatro_feel/ATTRIBUTION.md
License-File: ports/balatro_feel/LICENSE
License-File: ports/casual_crusade/ATTRIBUTION.md
License-File: ports/casual_crusade/LICENSE
License-File: ports/casual_crusade/UPSTREAM_LICENSE.md
License-File: ports/claustrowordia/ATTRIBUTION.md
License-File: ports/claustrowordia/LICENSE
License-File: ports/clear_code_zelda/ATTRIBUTION.md
License-File: ports/clumsy_bird/ATTRIBUTION.md
License-File: ports/clumsy_bird/UPSTREAM_LICENSE.md
License-File: ports/dodge_the_creeps/ATTRIBUTION.md
License-File: ports/dodge_the_creeps/UPSTREAM_LICENSE.md
License-File: ports/gdquest_open_rpg/ATTRIBUTION.md
License-File: ports/gdquest_open_rpg/UPSTREAM_LICENSE.md
License-File: ports/heartbeast_rpg/ATTRIBUTION.md
License-File: ports/heartbeast_rpg/UPSTREAM_LICENSE.md
License-File: ports/hexgl/ATTRIBUTION.md
License-File: ports/hexgl/UPSTREAM_LICENSE.md
License-File: ports/hextris/ATTRIBUTION.md
License-File: ports/hextris/UPSTREAM_LICENSE.md
License-File: ports/mr_rescue/ATTRIBUTION.md
License-File: ports/mr_rescue/LICENSE
License-File: ports/piratemaker/ATTRIBUTION.md
License-File: ports/procedural_planets/ATTRIBUTION.md
License-File: ports/procedural_planets/UPSTREAM_LICENSE.md
License-File: ports/q1k3/ATTRIBUTION.md
License-File: ports/q1k3/UPSTREAM_LICENSE.md
License-File: ports/raylib_asteroids/ATTRIBUTION.md
License-File: ports/raylib_asteroids/UPSTREAM_LICENSE.md
License-File: ports/raylib_snake/ATTRIBUTION.md
License-File: ports/raylib_snake/UPSTREAM_LICENSE.md
License-File: ports/raylib_tetris/ATTRIBUTION.md
License-File: ports/raylib_tetris/UPSTREAM_LICENSE.md
License-File: ports/snkrx/ATTRIBUTION.md
License-File: ports/snkrx/UPSTREAM_LICENSE.md
License-File: ports/solitaire/ATTRIBUTION.md
License-File: ports/squash_the_creeps/ATTRIBUTION.md
License-File: ports/squash_the_creeps/UPSTREAM_LICENSE.md
License-File: ports/tanks_of_freedom/ATTRIBUTION.md
License-File: ports/tanks_of_freedom/UPSTREAM_LICENSE.md
License-File: ports/tiny_yurts/ATTRIBUTION.md
License-File: ports/tiny_yurts/UPSTREAM_LICENSE.md
License-File: ports/tower_defence_tut/ATTRIBUTION.md
License-File: ports/tower_defence_tut/LICENSE
License-File: ports/ultimate_pygame_intro/ATTRIBUTION.md
License-File: ports/ultimate_pygame_intro/LICENSE
License-File: ports/youre_the_os/ATTRIBUTION.md
License-File: ports/youre_the_os/UPSTREAM_LICENSE.md
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Education
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.14
Description-Content-Type: text/markdown

# SimVX Examples

The SimVX example library: runnable programs you list, run and copy with the `simvx examples`
command. Each one's module docstring says what it shows.

> **Pre-alpha.** SimVX publishes development releases only (`0.0.0.devN`) and is under active
> development; the API changes between builds. Once stable versions ship to PyPI, development
> builds continue on pypi.simvx.com.

## Install

```bash
pip install --pre "simvx[examples]"
```

Latest development build: add `--extra-index-url https://pypi.simvx.com/`. Install the extra
rather than `simvx-examples` alone, which brings neither the engine nor the `simvx` command.

## Use

```bash
simvx examples list                        # every example, by tier
simvx examples list physics                # search ids, titles, descriptions and tags
simvx examples list --tier demos           # one tier: features, tutorials, demos or ports
simvx examples path tutorials_pong         # the example's entry file, for other commands
simvx examples run tutorials_pong
simvx examples copy tutorials_pong --to my-pong
```

`copy` puts the example and everything beside it in a directory you own, with its licence. The
tiers are `features` (one API area per file), `tutorials`, `demos` and `ports` (re-implementations
of existing games). Some 3D examples fetch third-party glTF models into a per-user cache on first
run; `features/3d/assets/ATTRIBUTION.md` names their sources and terms.

## Licence

| Part | Licence |
| --- | --- |
| `features`, `tutorials`, `demos` | MIT (the SimVX Examples Licence in [`LICENSE`](https://git.simvx.com/simvx/simvx/src/branch/main/examples/LICENSE)): copy into any project, closed-source included |
| `ports` | Each port's own licence, stated in its `ATTRIBUTION.md` |
| Bundled third-party assets | Their own licences, noted beside each example |
| The SimVX engine they import | AGPL-3.0-or-later with Additional Terms, including the Game-Distribution Exception ([`ENGINE_LICENCE.md`](https://git.simvx.com/simvx/simvx/src/branch/main/examples/ENGINE_LICENCE.md)) |

[Documentation](https://simvx.com/docs/examples/index.html) ·
[Source](https://git.simvx.com/simvx/simvx/src/branch/main/examples)
