Skip to content

Phantasm Engine is a Python-based Hybrid Visual Novel Framework designed to bridge the gap between desktop reality and fictional narratives.

License

Notifications You must be signed in to change notification settings

corp14x3/PHANTASM-ENGINE

Repository files navigation

🌑 Phantasm Engine

Phantasm Engine is a "Meta-Horror" and "Desktop Augmented Reality" framework designed for creating games that manipulate the user's desktop environment. It allows characters to interact with other windows, "hijack" applications, and talk to the user via AI-powered voice or chat interfaces.


🚀 Quick Usage Examples

🖼️ Simple Overlay Mode

Show a character on the desktop that reacts to clicks with a glitch effect.

from phantasm.engine import DarkEngine

core = DarkEngine()
core.overlay_mode(
    id=1,
    image="./images/character.png",
    chat="Why are you clicking me?",
    pos="center",
    anchor="center"
)

🪟 Window Hijack Mode

Attach a character to a specific window (e.g., Chrome) and "shake" it.

core.hijack_mode(
    id=2, 
    image="./images/scary.png",
    target_name="Chrome",
    effects="shake, clear", # clear minimizes other windows
    pos="top-right",
    anchor="top-left"
)

🏗️ Project Structure

  • phantasm/engine.py: Core logic for window management and modes.
  • phantasm/sounds.py: Async audio manager for SFX and music.
  • phantasm/intelligence.py: AI integration (Gemini, ChatGPT, Grok).
  • phantasm/media.py: Windows media session tracking (Spotify, Browser, etc.).
  • phantasm/files.py: Safe file/folder manipulation tools.

📖 Documentation & API Reference


🛠 Features

  • Sticky characters: Characters that follow specific Windows windows.
  • Overlay Rendering: Render transparent, click-through characters on your desktop.
  • AI Integration: Voice-to-text and text-to-voice interaction using modern LLMs.
  • Media Tracking: Detect what the user is listening to and react accordingly.
  • Meta-Horror Effects: Screen shakes, digital glitches, and window manipulations.

📦 Installation & Setup

  1. Install Requirements:
    • pip install -r phantasm/requirements.txt
  2. Run the Example:
    • Run python game.py to see the engine in action.

⚖️ License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

About

Phantasm Engine is a Python-based Hybrid Visual Novel Framework designed to bridge the gap between desktop reality and fictional narratives.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages