chore: initialize project structure for Sprint 0
This commit is contained in:
111
README.md
Normal file
111
README.md
Normal file
@@ -0,0 +1,111 @@
|
||||
# 🏥 Cozypaw Hospital
|
||||
|
||||
> Ein werbefreies Sandbox-Spiel für Kinder — ein kuscheliges Krankenhaus voller Häschen und Kätzchen.
|
||||
|
||||
## Über das Projekt
|
||||
|
||||
Cozypaw Hospital ist eine digitale Puppenstube: Kinder erkunden ein dreistöckiges Krankenhaus mit niedlichen Tier-Figuren, bewegen Gegenstände, erzählen Geschichten. Keine Ziele, kein Scheitern, keine Werbung, keine Datensammlung.
|
||||
|
||||
Inspiriert von Yasa Pets Hospital, aber liebevoll eigenständig gemacht — und ohne die Probleme des Originals (pervasive Werbung, Datentracking, fragwürdige Spielmechaniken).
|
||||
|
||||
## Features
|
||||
|
||||
- 🏥 Dreistöckiges Krankenhaus mit 12 interaktiven Räumen
|
||||
- 🐰 Häschen und 🐱 Kätzchen als Figuren
|
||||
- 🎨 Handgezeichneter Cartoon-Stil
|
||||
- 📴 Offline-first, keine Internetverbindung nötig
|
||||
- 🚫 Keine Werbung, keine In-App-Käufe, keine Analytics
|
||||
- 👨👩👧👦 Designed für Kinder ab 3 Jahren
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Engine:** Godot 4.x
|
||||
- **Sprache:** GDScript
|
||||
- **Zielplattformen:** Android, iOS
|
||||
- **Version Control:** Git (self-hosted Gitea)
|
||||
|
||||
## Projektstruktur
|
||||
|
||||
```
|
||||
cozypaw-hospital/
|
||||
├── project.godot # Godot-Projektdatei
|
||||
├── scenes/ # Alle .tscn Scene-Dateien
|
||||
│ ├── main/ # Haupt-Scene, Menüs
|
||||
│ ├── rooms/ # Räume (Empfang, Apotheke, etc.)
|
||||
│ ├── characters/ # Figuren-Scenes
|
||||
│ ├── objects/ # Interaktive Objekte
|
||||
│ └── ui/ # UI-Elemente, HUD
|
||||
├── scripts/ # GDScript-Dateien
|
||||
│ ├── autoload/ # Globale Singletons
|
||||
│ ├── characters/ # Character-Logik
|
||||
│ ├── objects/ # Objekt-Logik
|
||||
│ └── systems/ # Core Systems (Save, Audio, etc.)
|
||||
├── assets/
|
||||
│ ├── sprites/ # 2D-Grafiken
|
||||
│ ├── audio/ # Sounds und Musik
|
||||
│ ├── fonts/ # Schriftarten
|
||||
│ └── ui/ # UI-Grafiken
|
||||
├── localization/ # CSV-Dateien für Übersetzungen
|
||||
├── addons/ # Godot-Plugins
|
||||
├── docs/ # Dokumentation, Design-Docs
|
||||
└── builds/ # Build-Outputs (nicht im Git)
|
||||
```
|
||||
|
||||
## Entwicklung
|
||||
|
||||
### Voraussetzungen
|
||||
|
||||
- Godot 4.x ([Download](https://godotengine.org/download))
|
||||
- Git
|
||||
- Android Studio + SDK (für Android-Export)
|
||||
- Xcode + Apple Developer Account (für iOS-Export, später)
|
||||
|
||||
### Einrichtung
|
||||
|
||||
```bash
|
||||
# Repo klonen
|
||||
git clone https://git.race-cave.cloud/steven/Cozypaw-Hospital.git
|
||||
cd Cozypaw-Hospital
|
||||
|
||||
# Projekt in Godot öffnen
|
||||
godot -e
|
||||
```
|
||||
|
||||
### Branching-Strategie
|
||||
|
||||
- `main` — stabiler Stand, jederzeit releasebar
|
||||
- `develop` — aktuelle Entwicklung
|
||||
- `feature/<name>` — einzelne Features (z.B. `feature/reception-room`)
|
||||
- `sprint/<nummer>` — Sprint-Branches (z.B. `sprint/01-proof-of-concept`)
|
||||
|
||||
### Commits
|
||||
|
||||
Conventional Commits Format:
|
||||
- `feat:` neues Feature
|
||||
- `fix:` Bugfix
|
||||
- `refactor:` Refactoring ohne Funktionsänderung
|
||||
- `assets:` Asset-Updates (Sprites, Sounds)
|
||||
- `docs:` Dokumentation
|
||||
- `chore:` Build, Config, etc.
|
||||
|
||||
Beispiel: `feat(rooms): add reception room with waiting number system`
|
||||
|
||||
## Sprint-Fortschritt
|
||||
|
||||
- [x] Sprint 0: Repo-Setup
|
||||
- [ ] Sprint 1-2: Proof of Concept
|
||||
- [ ] Sprint 3-4: Core Systems
|
||||
- [ ] Sprint 5-7: Erdgeschoss
|
||||
- [ ] Sprint 8-10: 1. Obergeschoss
|
||||
- [ ] Sprint 11-13: 2. Obergeschoss
|
||||
- [ ] Sprint 14: Zuhause & Garten
|
||||
- [ ] Sprint 15: Polish & Sound
|
||||
- [ ] Sprint 16+: Release-Vorbereitung
|
||||
|
||||
## Lizenz
|
||||
|
||||
Privates Familienprojekt. Alle Rechte vorbehalten.
|
||||
|
||||
## Kontakt
|
||||
|
||||
Steven — [git.race-cave.cloud/steven](https://git.race-cave.cloud/steven)
|
||||
Reference in New Issue
Block a user