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 и запустите скрипт игры. В разделе Quick Start описаны требования, установка, настройка и запуск.
Что нужно установить заранее?Python 3.12 или новее и pip. Сама игра работает на Pygame, который внутри обрабатывает события ввода, вывод на экран и микшер звука.
Можно ли изменить историю под наши отношения?Можно персонализировать имена, приветствия и скрытые секреты через файл настроек .env. Но сами сюжетные этапы и логика состояний заданы в коде, это не редактор с перетаскиванием.
Работает ли это на Windows, Mac и Linux?В README конкретные операционные системы не указаны. Но это настольное приложение на чистом Python и Pygame с обычной установкой через pip, так что оно должно работать везде, где поддерживаются Python 3.12+ и Pygame.
Зачем автор сделал это, а не обычную открытку?Это персональный подарок ко Дню розы, написанный кодом. Заодно он показывает чистую архитектуру с разделением на сервисы в небольшой игре на Python.
Как на самом деле выглядит игра?Нарисованные вручную пиксель-арт фоны меняются от солнечного дня к вечерней загадочности и мечтательным искоркам, а система частиц заполняет экран плывущим снегом, летающими сердечками и лепестками роз, пока идёт диалог.
Кто такие MrLover и MissLovely?Это два персонажа в центре истории, которые проходят через многоэтапную машину состояний. Их день включает сны, дневной сон и трогательные сюрпризы.
Как устроен код внутри?GameEngine запускает сервисы (отрисовку, звук, конфигурацию) и помещает их в центральный Registry. Затем работает цикл обновления и отрисовки, который опирается на delta time, а в конце аккуратно завершает работу Pygame.
Какие есть похожие проекты?CursedTomorrow, benilla, Pixelorama, osu, flame, flutter_scene, PixelSRPG-Forge, box2d
Размер
9.6 MB
Звёзды
4.8K
Обновлён
КоммитJul 06
Возраст
6 мес
Коммиты · 90 дней