RoseWish README

项目的 README,来自 github.com/AhmadHassan-BTed/RoseWish。合并为一个 markdown 文件:README.md。

RoseWish Banner

RoseWish 🌹

Rose Day Special: Wishing Visual Novel

Python 3.12 License: MIT Ahmad Hassan (B-Ted) PRs Welcome

A high-fidelity, story-driven pixel art experience crafted for the spirit of Rose Day. Designed by Ahmad Hassan (B-Ted).

Features • Quick Start • Architecture • Contributing


A Gift for Your Loved One

This game was crafted as a heartfelt way to express your love. Use it to wish your special someone a Happy Rose Day, customize it with your private memories, and let the pixel-art magic do the rest. It's not just a game; it's a personalized wish wrapped in code.


The Rose Day Wishing Game is more than just a project; it's a digital rose garden where code meets emotion. Crafted with love and a focus on high-fidelity storytelling, this interactive experience brings the magic of Rose Day to your screen.

Built on a professional, service-oriented architecture, it seamlessly blends engineering maturity with a heartwarming narrative of two souls, MrLover and MissLovely, as they journey through a day of dreams, napping, and heartfelt surprises.

"Like a rose, a project is beautiful not just in its bloom, but in the care put into its roots."

This project was built to demonstrate clean engineering practices in game development while providing a meaningful, personalized gift experience.



Features


Architecture

The repository follows a modern decoupled structure, ensuring 100% cohesion and minimal coupling between systems.

System Workflow

graph TD
    A[main.py] --> B[GameEngine]
    B --> C[Service Registry]
    B --> D[State Machine]

    subgraph Services
        C --> S1[AudioService]
        C --> S2[RenderService]
    end

    subgraph Game Systems
        D --> E1[Narrative Director]
        D --> E2[Particle Manager]
        D --> E3[Dialogue System]
    end

    subgraph Entities
        E1 --> P1[MrLover Character]
        E1 --> P2[MissLovely Character]
    end

Internal Module Structure

classDiagram
    class GameEngine {
        +run()
        +update(dt)
        +render()
    }
    class Character {
        +update(dt)
        +draw(screen)
    }
    class MissLovely {
        +draw_sleeping()
        +draw_standing()
    }
    class MrLover {
        +holding_rose: bool
    }
    Character <|-- MissLovely
    Character <|-- MrLover
    GameEngine *-- ParticleManager
    GameEngine *-- DialogueBox
    GameEngine *-- Background

Repository Structure

Rose-Day-Wishing-Game/
├── src/
│   ├── core/           # Dependency injection and event bus
│   ├── engine/         # Main game loop and state management
│   ├── entities/       # Character logic and pixel-art rendering
│   ├── services/       # Decoupled Audio and Rendering services
│   ├── ui/             # Backgrounds and dialogue overlays
│   ├── utils/          # Particle systems and constants
│   ├── config/         # Environment-based configuration
│   └── main.py         # Application entry point
├── docs/               # Technical specifications
├── .env.example        # Configuration template
├── pyproject.toml      # Build system and metadata
└── requirements.txt    # Project dependencies

Quick Start

1. Prerequisites

2. Installation

# Clone the repository
git clone https://github.com/AhmadHassan-BTed/Rose-Day-Wishing-Game.git
cd Rose-Day-Wishing-Game

# Install dependencies
pip install -r requirements.txt

3. Configuration

The game is pre-configured with generic values in the .env file. You can modify these values to personalize the experience:

# Open .env and change names/messages
# Example: PLAYER_NAME="Your Name"

4. Launch & Wish

python src/main.py

Run the game and share the screen with your loved one to wish them in style!


Data Flow & Lifecycle

  1. Initialization: The GameEngine initializes services and registers them in the central Registry.
  2. Configuration: Settings are loaded from .env and validated via the config module.
  3. Execution Loop:
    • Handle Input: Events are captured via pygame.
    • Update: Systems update based on Delta Time (dt) for frame-independent movement.
    • Render: The RenderService composites the background, entities, and UI.
  4. Shutdown: Clean termination of the Pygame mixer and display.

Contributing

Contributions that improve architecture, performance, or narrative depth are welcomed.

  1. Fork the repository.
  2. Create a feature branch.
  3. Submit a pull request with a detailed description of changes.

License & Credits

Every rose has a story. This one is yours.

Designed for the one who makes your world bloom. On this special Rose Day.

RoseWish (AhmadHassan-BTed/RoseWish)

正在搜索数据库…

这是什么?RoseWish 是一款用 Python 开发的互动叙事小游戏,专为玫瑰日打造。它配有可动态切换的对话系统、动画粒子特效和音频,用来送出一份充满心意的专属浪漫礼物。
这是完整的视觉小说引擎,还是一个固定的故事?它是一个预先写好的单一像素风故事,讲述两个角色 MrLover 和 MissLovely 一起度过一个特别的日子,而不是通用的故事引擎。
怎么让它跑起来?克隆仓库,安装 pip 依赖,然后启动游戏脚本。快速开始部分会依次说明前置条件、安装、配置和启动的步骤。
我需要先安装什么?Python 3.12 或更高版本,以及 pip。游戏本身基于 Pygame 运行,Pygame 在内部处理输入事件、显示和音频混音。
我能把故事改成适合我们两个人的吗?可以通过 .env 配置文件个性化名字、问候语和隐藏的秘密,但剧情节点和状态机本身是固定的代码,并不是拖拽式编辑器。
它能在 Windows、Mac 和 Linux 上运行吗?README 没有specifically列出支持的操作系统。不过它是纯 Python/Pygame 桌面应用,通过标准 pip 安装,因此只要支持 Python 3.12+ 和 Pygame,理论上都能运行。
作者为什么要做这个,而不是用通用的电子贺卡?它是作者亲手编写的专属玫瑰日礼物,同时也用一个小型 Python 游戏展示了清晰、面向服务的架构设计。
游戏实际玩起来是什么样子?手绘的像素风背景会从阳光明媚的白天过渡到傍晚的神秘氛围和梦幻闪光。对话进行时,粒子系统会在屏幕上飘落雪花、漂浮爱心和玫瑰花瓣。
MrLover 和 MissLovely 是谁?他们是故事中心的两个自定义角色,通过一个多阶段的状态机推进剧情,经历一整天的梦境、午睡和充满心意的惊喜。
代码内部是怎么组织的?GameEngine 会把渲染、音频、配置等服务初始化并注册到一个中央 Registry 中,然后基于帧间隔时间(delta time)运行更新和渲染循环,最后干净地关闭 Pygame。
大小
9.6 MB
星标
4.8K
更新
提交Jul 06
时长
6个月
提交 · 90 天