pygame-framecraft 1.0.0__tar.gz

pygame_framecraft-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 CodeRoom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pygame_framecraft-1.0.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: pygame-framecraft
+Version: 1.0.0
+Summary: A lightweight educational game framework built on top of Pygame.
+Author: CodeRoom
+License-Expression: MIT
+Project-URL: Homepage, https://www.coderoom.eu/en/framecraft
+Project-URL: Repository, https://github.com/gab211/pygame-framecraft
+Project-URL: Issues, https://github.com/gab211/pygame-framecraft/issues
+Keywords: pygame,education,game-development,teaching,python,coderoom
+Classifier: Intended Audience :: Education
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Education
+Classifier: Topic :: Games/Entertainment
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pygame>=2.5
+Dynamic: license-file
+
+# frameCraft
+
+A lightweight educational game framework built on a pygame-compatible API.
+
+**frameCraft** is designed for teaching and beginner-friendly game development. The same game code can run:
+
+- inside **CodeRoom** using its pygame-light host runtime
+- locally with standard **CPython + pygame**
+
+> frameCraft is an independent project built on top of pygame-compatible APIs. It is not affiliated with or maintained by the pygame project.
+
+## Installation
+
+Once published on PyPI:
+
+```bash
+pip install pygame-framecraft
+```
+
+The existing import remains intentionally unchanged:
+
+```python
+import frameCraft as fc
+```
+
+This preserves compatibility with existing CodeRoom content.
+
+## Minimal standalone example
+
+```python
+import frameCraft as fc
+
+fc.GAME(
+    "frameCraft Test",
+    window=(640, 400),
+    fps=60
+)
+
+fc.SCENE("main")
+
+@fc.SCENE_BUILD("main")
+def build(ctx):
+    fc.ENTITY("player", (320, 200), tag="player")
+    fc.RECT("player", 40, 40)
+
+fc.START()
+```
+
+## CodeRoom host integration
+
+CodeRoom keeps ownership of its existing game loop and calls:
+
+```python
+FC_BOOT(scene)
+FC_STEP(events, dt)
+FC_DRAW(screen)
+```
+
+The hosted API and the standalone API use the same frameCraft implementation.
+
+## Source layout
+
+Insert the three existing runtime files into `src/`:
+
+```text
+src/
+├── frameCraft.py
+├── frameCraftGFX.py
+└── frameCraftUI.py
+```
+
+Do **not** rename them for the first public version.
+
+Keeping the filenames unchanged has two advantages:
+
+1. Existing CodeRoom code using `import frameCraft as fc` remains compatible.
+2. The exact same source files can be copied into the CodeRoom deployment and packaged for PyPI.
+
+A future major version could introduce a conventional lowercase package layout if desired, but that should be treated as a separate compatibility decision.
+
+## Project layout
+
+```text
+pygame-framecraft/
+├── .github/
+│   └── workflows/
+├── src/
+│   ├── frameCraft.py
+│   ├── frameCraftGFX.py
+│   └── frameCraftUI.py
+├── examples/
+├── tests/
+├── CHANGELOG.md
+├── CONTRIBUTING.md
+├── LICENSE
+├── README.md
+├── pyproject.toml
+└── .gitignore
+```
+
+## Build
+
+Install the build tool:
+
+```bash
+python -m pip install build
+```
+
+Build wheel and source distribution:
+
+```bash
+python -m build
+```
+
+The package configuration deliberately publishes the three existing modules from `src/` without requiring a source-code rename.
+
+## CodeRoom runtime artifact
+
+For CodeRoom deployments, the release workflow creates a small ZIP containing exactly:
+
+```text
+frameCraft.py
+frameCraftGFX.py
+frameCraftUI.py
+```
+
+This lets GitHub remain the development source of truth while CodeRoom can continue shipping the same three files under:
+
+```text
+jsEditor.App/scripts/python/
+```
+
+## Versioning
+
+Use semantic version tags:
+
+```text
+v0.1.0
+v0.2.0
+v1.0.0
+```
+
+CodeRoom should always reference a fixed release version rather than `main` or `latest`.
+
+## License
+
+MIT. See [LICENSE](LICENSE).

pygame_framecraft-1.0.0/README.md

@@ -0,0 +1,147 @@
+# frameCraft
+
+A lightweight educational game framework built on a pygame-compatible API.
+
+**frameCraft** is designed for teaching and beginner-friendly game development. The same game code can run:
+
+- inside **CodeRoom** using its pygame-light host runtime
+- locally with standard **CPython + pygame**
+
+> frameCraft is an independent project built on top of pygame-compatible APIs. It is not affiliated with or maintained by the pygame project.
+
+## Installation
+
+Once published on PyPI:
+
+```bash
+pip install pygame-framecraft
+```
+
+The existing import remains intentionally unchanged:
+
+```python
+import frameCraft as fc
+```
+
+This preserves compatibility with existing CodeRoom content.
+
+## Minimal standalone example
+
+```python
+import frameCraft as fc
+
+fc.GAME(
+    "frameCraft Test",
+    window=(640, 400),
+    fps=60
+)
+
+fc.SCENE("main")
+
+@fc.SCENE_BUILD("main")
+def build(ctx):
+    fc.ENTITY("player", (320, 200), tag="player")
+    fc.RECT("player", 40, 40)
+
+fc.START()
+```
+
+## CodeRoom host integration
+
+CodeRoom keeps ownership of its existing game loop and calls:
+
+```python
+FC_BOOT(scene)
+FC_STEP(events, dt)
+FC_DRAW(screen)
+```
+
+The hosted API and the standalone API use the same frameCraft implementation.
+
+## Source layout
+
+Insert the three existing runtime files into `src/`:
+
+```text
+src/
+├── frameCraft.py
+├── frameCraftGFX.py
+└── frameCraftUI.py
+```
+
+Do **not** rename them for the first public version.
+
+Keeping the filenames unchanged has two advantages:
+
+1. Existing CodeRoom code using `import frameCraft as fc` remains compatible.
+2. The exact same source files can be copied into the CodeRoom deployment and packaged for PyPI.
+
+A future major version could introduce a conventional lowercase package layout if desired, but that should be treated as a separate compatibility decision.
+
+## Project layout
+
+```text
+pygame-framecraft/
+├── .github/
+│   └── workflows/
+├── src/
+│   ├── frameCraft.py
+│   ├── frameCraftGFX.py
+│   └── frameCraftUI.py
+├── examples/
+├── tests/
+├── CHANGELOG.md
+├── CONTRIBUTING.md
+├── LICENSE
+├── README.md
+├── pyproject.toml
+└── .gitignore
+```
+
+## Build
+
+Install the build tool:
+
+```bash
+python -m pip install build
+```
+
+Build wheel and source distribution:
+
+```bash
+python -m build
+```
+
+The package configuration deliberately publishes the three existing modules from `src/` without requiring a source-code rename.
+
+## CodeRoom runtime artifact
+
+For CodeRoom deployments, the release workflow creates a small ZIP containing exactly:
+
+```text
+frameCraft.py
+frameCraftGFX.py
+frameCraftUI.py
+```
+
+This lets GitHub remain the development source of truth while CodeRoom can continue shipping the same three files under:
+
+```text
+jsEditor.App/scripts/python/
+```
+
+## Versioning
+
+Use semantic version tags:
+
+```text
+v0.1.0
+v0.2.0
+v1.0.0
+```
+
+CodeRoom should always reference a fixed release version rather than `main` or `latest`.
+
+## License
+
+MIT. See [LICENSE](LICENSE).

pygame_framecraft-1.0.0/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=77.0.3", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pygame-framecraft"
+version = "1.0.0"
+description = "A lightweight educational game framework built on top of Pygame."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+license-files = ["LICENSE"]
+
+authors = [
+    { name = "CodeRoom" }
+]
+
+keywords = [
+    "pygame",
+    "education",
+    "game-development",
+    "teaching",
+    "python",
+    "coderoom"
+]
+
+classifiers = [
+    "Intended Audience :: Education",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Education",
+    "Topic :: Games/Entertainment"
+]
+
+dependencies = [
+    "pygame>=2.5"
+]
+
+[project.urls]
+Homepage = "https://www.coderoom.eu/en/framecraft"
+Repository = "https://github.com/gab211/pygame-framecraft"
+Issues = "https://github.com/gab211/pygame-framecraft/issues"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+py-modules = [
+    "frameCraft",
+    "frameCraftGFX",
+    "frameCraftUI"
+]

pygame_framecraft-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+