gen-adventure 0.1.7__tar.gz

gen_adventure-0.1.7/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Johnny Matos
+
+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.

gen_adventure-0.1.7/PKG-INFO

@@ -0,0 +1,255 @@
+Metadata-Version: 2.4
+Name: gen-adventure
+Version: 0.1.7
+Summary: Generate and play AI-powered interactive adventures.
+Author: Johnny Matos
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/DS-Johnny/gen-adventure
+Keywords: ai,game,adventure,pygame,gemini,interactive,story,fantasy
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: google-genai
+Requires-Dist: pygame
+Dynamic: license-file
+
+# Gen-Adventure
+
+Generate and play AI-powered interactive adventures with Python, Pygame, and Google Gemini.
+
+Gen-Adventure allows you to:
+
+* Create interactive branching stories using Google's Gemini models.
+* Play generated stories through a graphical interface built with Pygame.
+* Load stories from local JSON files or remote URLs.
+* Explore built-in example adventures.
+
+---
+
+## Features
+
+* AI-powered story generation using Gemini.
+* Interactive branching adventures.
+* Pygame graphical interface.
+* Local and remote story support.
+* JSON-based story format.
+* Built-in example stories.
+
+---
+
+## Installation
+
+```bash
+pip install gen-adventure
+```
+
+---
+
+## Requirements
+
+* Python 3.11+
+* Google Gemini API Key
+
+---
+
+## Playing an Adventure
+
+Load a local JSON story:
+
+```python
+from gen_adventure import Adventure
+
+game = Adventure("my_story.json")
+game.start()
+```
+
+Load a story hosted online:
+
+```python
+from gen_adventure import Adventure
+
+game = Adventure(
+    "https://example.com/my_story.json"
+)
+
+game.start()
+```
+
+---
+
+## Built-in Example Stories
+
+Gen-Adventure includes several example stories hosted in the project's repository.
+
+```python
+from gen_adventure import Adventure, StoryExamples
+
+examples = StoryExamples()
+
+game = Adventure(examples.fantasy)
+game.start()
+```
+
+Available examples:
+
+* fantasy
+* hacker
+* formatura
+* love_story
+
+---
+
+## Generating Stories with Gemini
+
+Create a story and save it as a JSON file:
+
+```python
+from gen_adventure import StoryImaginator
+
+imaginator = StoryImaginator()
+
+imaginator.gemini_api_key = "YOUR_GEMINI_API_KEY"
+
+imaginator.imagine(
+    "A cyberpunk hacker fighting an evil corporation",
+    "cyberpunk_story.json"
+)
+```
+
+The generated file can then be loaded into the game:
+
+```python
+from gen_adventure import Adventure
+
+game = Adventure("cyberpunk_story.json")
+game.start()
+```
+
+---
+
+## Story Format
+
+Stories are stored as JSON files.
+
+Example:
+
+```json
+{
+    "pages": [
+        {
+            "id": 1,
+            "text": "You wake up in a mysterious forest.",
+            "options": [
+                {
+                    "text": "Follow the path",
+                    "target": 2
+                },
+                {
+                    "text": "Enter the cave",
+                    "target": 3
+                }
+            ]
+        }
+    ]
+}
+```
+
+Each page contains:
+
+| Field   | Description       |
+| ------- | ----------------- |
+| id      | Page identifier   |
+| text    | Story content     |
+| options | Available choices |
+
+Each option contains:
+
+| Field  | Description                  |
+| ------ | ---------------------------- |
+| text   | Text displayed to the player |
+| target | Destination page             |
+
+---
+
+## Customizing Colors
+
+You can customize the interface colors:
+
+```python
+from gen_adventure import Adventure
+
+game = Adventure("story.json")
+
+game.text_color = (255, 255, 255)
+game.background_color = (25, 25, 25)
+game.button_background_color = (50, 50, 50)
+
+game.start()
+```
+
+---
+
+## Example Workflow
+
+Generate a story:
+
+```python
+from gen_adventure import StoryImaginator
+
+imaginator = StoryImaginator()
+
+imaginator.gemini_api_key = "YOUR_GEMINI_API_KEY"
+
+imaginator.imagine(
+    "A medieval knight searching for a lost kingdom",
+    "kingdom.json"
+)
+```
+
+Play the generated adventure:
+
+```python
+from gen_adventure import Adventure
+
+game = Adventure("kingdom.json")
+game.start()
+```
+
+---
+
+## Project Structure
+
+```text
+gen_adventure/
+├── adventure.py
+├── pages.py
+├── story_imaginator.py
+└── __init__.py
+```
+
+---
+
+## Dependencies
+
+* pygame
+* google-genai
+* requests
+
+---
+
+## License
+
+This project is licensed under the MIT License.
+
+See the LICENSE file for details.
+
+---
+
+## Author
+
+Johnny Matos
+
+GitHub: https://github.com/DS-Johnny

gen_adventure-0.1.7/README.md

@@ -0,0 +1,237 @@
+# Gen-Adventure
+
+Generate and play AI-powered interactive adventures with Python, Pygame, and Google Gemini.
+
+Gen-Adventure allows you to:
+
+* Create interactive branching stories using Google's Gemini models.
+* Play generated stories through a graphical interface built with Pygame.
+* Load stories from local JSON files or remote URLs.
+* Explore built-in example adventures.
+
+---
+
+## Features
+
+* AI-powered story generation using Gemini.
+* Interactive branching adventures.
+* Pygame graphical interface.
+* Local and remote story support.
+* JSON-based story format.
+* Built-in example stories.
+
+---
+
+## Installation
+
+```bash
+pip install gen-adventure
+```
+
+---
+
+## Requirements
+
+* Python 3.11+
+* Google Gemini API Key
+
+---
+
+## Playing an Adventure
+
+Load a local JSON story:
+
+```python
+from gen_adventure import Adventure
+
+game = Adventure("my_story.json")
+game.start()
+```
+
+Load a story hosted online:
+
+```python
+from gen_adventure import Adventure
+
+game = Adventure(
+    "https://example.com/my_story.json"
+)
+
+game.start()
+```
+
+---
+
+## Built-in Example Stories
+
+Gen-Adventure includes several example stories hosted in the project's repository.
+
+```python
+from gen_adventure import Adventure, StoryExamples
+
+examples = StoryExamples()
+
+game = Adventure(examples.fantasy)
+game.start()
+```
+
+Available examples:
+
+* fantasy
+* hacker
+* formatura
+* love_story
+
+---
+
+## Generating Stories with Gemini
+
+Create a story and save it as a JSON file:
+
+```python
+from gen_adventure import StoryImaginator
+
+imaginator = StoryImaginator()
+
+imaginator.gemini_api_key = "YOUR_GEMINI_API_KEY"
+
+imaginator.imagine(
+    "A cyberpunk hacker fighting an evil corporation",
+    "cyberpunk_story.json"
+)
+```
+
+The generated file can then be loaded into the game:
+
+```python
+from gen_adventure import Adventure
+
+game = Adventure("cyberpunk_story.json")
+game.start()
+```
+
+---
+
+## Story Format
+
+Stories are stored as JSON files.
+
+Example:
+
+```json
+{
+    "pages": [
+        {
+            "id": 1,
+            "text": "You wake up in a mysterious forest.",
+            "options": [
+                {
+                    "text": "Follow the path",
+                    "target": 2
+                },
+                {
+                    "text": "Enter the cave",
+                    "target": 3
+                }
+            ]
+        }
+    ]
+}
+```
+
+Each page contains:
+
+| Field   | Description       |
+| ------- | ----------------- |
+| id      | Page identifier   |
+| text    | Story content     |
+| options | Available choices |
+
+Each option contains:
+
+| Field  | Description                  |
+| ------ | ---------------------------- |
+| text   | Text displayed to the player |
+| target | Destination page             |
+
+---
+
+## Customizing Colors
+
+You can customize the interface colors:
+
+```python
+from gen_adventure import Adventure
+
+game = Adventure("story.json")
+
+game.text_color = (255, 255, 255)
+game.background_color = (25, 25, 25)
+game.button_background_color = (50, 50, 50)
+
+game.start()
+```
+
+---
+
+## Example Workflow
+
+Generate a story:
+
+```python
+from gen_adventure import StoryImaginator
+
+imaginator = StoryImaginator()
+
+imaginator.gemini_api_key = "YOUR_GEMINI_API_KEY"
+
+imaginator.imagine(
+    "A medieval knight searching for a lost kingdom",
+    "kingdom.json"
+)
+```
+
+Play the generated adventure:
+
+```python
+from gen_adventure import Adventure
+
+game = Adventure("kingdom.json")
+game.start()
+```
+
+---
+
+## Project Structure
+
+```text
+gen_adventure/
+├── adventure.py
+├── pages.py
+├── story_imaginator.py
+└── __init__.py
+```
+
+---
+
+## Dependencies
+
+* pygame
+* google-genai
+* requests
+
+---
+
+## License
+
+This project is licensed under the MIT License.
+
+See the LICENSE file for details.
+
+---
+
+## Author
+
+Johnny Matos
+
+GitHub: https://github.com/DS-Johnny

gen_adventure-0.1.7/gen_adventure/__init__.py

@@ -0,0 +1,14 @@
+"""
+Gen-Adventure
+
+Generate and play AI-powered interactive adventures.
+"""
+
+from .adventure import Adventure, StoryExamples
+from .story_imaginator import StoryImaginator
+
+__all__ = [
+    "Adventure",
+    "StoryExamples",
+    "StoryImaginator"
+]