iris/iris-plugins
1
0
Fork 0
Code Issues 17 Pull requests Projects Releases Packages Wiki Activity Actions

iris-gamebox: Entwickler-Dokumentation als Tutorial (Klassen, Abläufe, Geschichte) #268

New issue
Closed
opened 2026-10-25 22:32:42 +00:00 by alf · 2 comments
alf commented 2026-10-25 22:32:42 +00:00
Owner
Copy link

Warum

Zum Plugin existieren PLAN.md (Entscheidungen, Chronik), Daily Logs und die Benutzer-Anleitung —
aber kein Text, der das Plugin als Ganzes erklärt: Klassen, Abläufe, und vor allem warum es so
gebaut ist. iris-gamebox ist inzwischen das Referenz-Plugin für fast alle Oberflächen-Verträge
(Anwenden-Seite, Konfiguration-Panel, panel_api, Seitenpanel-Reiter) — genau das right macht es
zum Lehrstück: eine Entwickler-Dokumentation, die sich als Tutorial liest, wie man ein Iris-Plugin
von Anfang bis Store entwickelt, am echten Beispiel.

Was

plugins/iris-gamebox/Entwickler-Doku.md, neu, mit 12 Mermaid-Diagrammen (alle mit mmdc
validiert):

  • Sinn und Design — Skript-Werkzeug vs. Agenten-Urteil, die vier tragenden Entscheidungen
  • Systemkarte — Paket vs. Anwenderordner (GAMEBOX_HOME), Manifest als Vertrag
  • Klassendiagramm — die Module von gamebox_cli.py nach Verantwortung + Fehlervertrag
    (ValueError in Helfern, die() nur am CLI-Rand) über beide Consolen
  • Abläufe — Indexbau aus vier Bibliotheks-Sprachen, der bundle-Entscheidungsbaum
    (vier Äste), verify-Messung, panel_api-Brücke, Bau als Hintergrund-Job, Reiter mit
    gemeinsamer Auswahl, post_install/Engines
  • Tutorial — ein eigenes Plugin in sieben Schritten (Anlegen, SKILL.md, Panel ohne
    Iris-Commit, Testen mit Sandbox-HOME, Reiter)
  • Entwicklungsgeschichte — Timeline 0.1.1→0.8.0 mit den Issues #235/#246/#255/#265 und
    dem Vorgänger iris-dosgame (#57–#72); Quellen: Forgejo-Issues inkl. Kommentare, Registry-Chronik
  • Veröffentlichen — der Weg über publish-plugins.sh samt Versionsregeln und Stand-im-Issue

Abgrenzung

Kein Code, kein Manifest, keine Store-Texte. PLAN.md bleibt die Chronik, die Doku erklärt den
Aufbau; Querverweise ersetzen keine Inhalte (Dopplungen vermieden, Genau-eine-Stelle-Regel).

## Warum Zum Plugin existieren PLAN.md (Entscheidungen, Chronik), Daily Logs und die Benutzer-Anleitung — aber kein Text, der das Plugin als Ganzes erklärt: Klassen, Abläufe, und vor allem *warum* es so gebaut ist. iris-gamebox ist inzwischen das Referenz-Plugin für fast alle Oberflächen-Verträge (Anwenden-Seite, Konfiguration-Panel, panel_api, Seitenpanel-Reiter) — genau das right macht es zum Lehrstück: eine Entwickler-Dokumentation, die sich als Tutorial liest, wie man ein Iris-Plugin von Anfang bis Store entwickelt, am echten Beispiel. ## Was `plugins/iris-gamebox/Entwickler-Doku.md`, neu, mit 12 Mermaid-Diagrammen (alle mit `mmdc` validiert): - **Sinn und Design** — Skript-Werkzeug vs. Agenten-Urteil, die vier tragenden Entscheidungen - **Systemkarte** — Paket vs. Anwenderordner (`GAMEBOX_HOME`), Manifest als Vertrag - **Klassendiagramm** — die Module von `gamebox_cli.py` nach Verantwortung + Fehlervertrag (`ValueError` in Helfern, `die()` nur am CLI-Rand) über beide Consolen - **Abläufe** — Indexbau aus vier Bibliotheks-Sprachen, der `bundle`-Entscheidungsbaum (vier Äste), `verify`-Messung, panel_api-Brücke, Bau als Hintergrund-Job, Reiter mit gemeinsamer Auswahl, post_install/Engines - **Tutorial** — ein eigenes Plugin in sieben Schritten (Anlegen, SKILL.md, Panel ohne Iris-Commit, Testen mit Sandbox-HOME, Reiter) - **Entwicklungsgeschichte** — Timeline 0.1.1→0.8.0 mit den Issues #235/#246/#255/#265 und dem Vorgänger iris-dosgame (#57–#72); Quellen: Forgejo-Issues inkl. Kommentare, Registry-Chronik - **Veröffentlichen** — der Weg über `publish-plugins.sh` samt Versionsregeln und Stand-im-Issue ## Abgrenzung Kein Code, kein Manifest, keine Store-Texte. PLAN.md bleibt die Chronik, die Doku erklärt den Aufbau; Querverweise ersetzen keine Inhalte (Dopplungen vermieden, Genau-eine-Stelle-Regel).
alf commented 2026-10-25 22:33:15 +00:00
Author
Owner
Copy link

PR #269 gemergt: docs(iris-gamebox): Entwickler-Dokumentation als Tutorial — Klassen, Abläufe, Geschichte, Veröffentlichen (#268)
#269

Commits:

  • docs(iris-gamebox): Entwickler-Dokumentation als Tutorial — Klassen, Abläufe, Geschichte, Veröffentlichen (#268)

Geändert

Neu: iris-gamebox/Entwickler-Doku.md (670 Zeilen, 12 Mermaid-Diagramme) —
Entwickler-Dokumentation, die als Tutorial gelesen werden kann: Sinn und tragende Entscheidungen,
Systemkarte (Paket vs. Anwenderordner), Klassendiagramm der Module, Abläufe als Sequenzdiagramme
(panel_api-Brücke, Bau als Hintergrund-Job, post_install/Engines, Reiter mit gemeinsamer Auswahl),
Entscheidungsbaum von bundle, Tutorial „ein eigenes Plugin in sieben Schritten“,
Entwicklungsgeschichte 0.1.1→0.8.0 und der Weg ins Publishing.

Geprüft

  • Alle 12 Mermaid-Blöcke mit mmdc validiert (ein Block mit verschachtelten Anführungszeichen
    im Label korrigiert); Text auf verschleppte CJK-Zeichen geprüft (zwei gefunden und ersetzt).
  • Faktengrundlage gegen den Code abgeglichen (gamebox_cli.py/panel_api.py im Detail kartiert:
    Subcommands, Kommandotabelle, Exit-Codes, Job-/Index-Orchestrierung, Auswahl-Datei) und gegen
    die Registry-Chronik nach frischem Pull (0.1.1–0.8.0, Commits und Daten).
  • Versionsgeschichte aus den Forgejo-Issues #235/#246/#255/#265 und iris-dosgame #57–#72
    inkl. Kommentare gelesen.

Nicht geprüft

  • Die Doku in einem Markdown-Renderer am Auge (Tabellen/Timeline-Block); Mermaid rendert in
    Forgejo/GitHub mit mmdc-grünen Blöcken in der Regel, gesehen ist es nicht.
  • Vollständigkeitsgefühl: Ob der Text für einen Fremd-Leser wirklich als Tutorial trägt,
    liest nur der erste fremde Leser.

Grenzen / Offen

Reine Doku — kein Code, kein Manifest, keine Store-Texte; keine neue Version nötig.
PLAN.md bleibt Chronik, die neue Doku erklärt Aufbau und Ablauf; gegenseitige Querverweise statt
Dopplungen.

PR #269 gemergt: docs(iris-gamebox): Entwickler-Dokumentation als Tutorial — Klassen, Abläufe, Geschichte, Veröffentlichen (#268) https://forgejo.lewerken.duckdns.org/iris/iris-plugins/pulls/269 Commits: - docs(iris-gamebox): Entwickler-Dokumentation als Tutorial — Klassen, Abläufe, Geschichte, Veröffentlichen (#268) --- ## Geändert Neu: `iris-gamebox/Entwickler-Doku.md` (670 Zeilen, 12 Mermaid-Diagramme) — Entwickler-Dokumentation, die als Tutorial gelesen werden kann: Sinn und tragende Entscheidungen, Systemkarte (Paket vs. Anwenderordner), Klassendiagramm der Module, Abläufe als Sequenzdiagramme (panel_api-Brücke, Bau als Hintergrund-Job, post_install/Engines, Reiter mit gemeinsamer Auswahl), Entscheidungsbaum von `bundle`, Tutorial „ein eigenes Plugin in sieben Schritten“, Entwicklungsgeschichte 0.1.1→0.8.0 und der Weg ins Publishing. ## Geprüft - Alle 12 Mermaid-Blöcke mit `mmdc` validiert (ein Block mit verschachtelten Anführungszeichen im Label korrigiert); Text auf verschleppte CJK-Zeichen geprüft (zwei gefunden und ersetzt). - Faktengrundlage gegen den Code abgeglichen (gamebox_cli.py/panel_api.py im Detail kartiert: Subcommands, Kommandotabelle, Exit-Codes, Job-/Index-Orchestrierung, Auswahl-Datei) und gegen die Registry-Chronik nach frischem Pull (0.1.1–0.8.0, Commits und Daten). - Versionsgeschichte aus den Forgejo-Issues #235/#246/#255/#265 und iris-dosgame #57–#72 inkl. Kommentare gelesen. ## Nicht geprüft - Die Doku in einem Markdown-Renderer am Auge (Tabellen/Timeline-Block); Mermaid rendert in Forgejo/GitHub mit `mmdc`-grünen Blöcken in der Regel, gesehen ist es nicht. - Vollständigkeitsgefühl: Ob der Text für einen Fremd-Leser wirklich als Tutorial trägt, liest nur der erste fremde Leser. ## Grenzen / Offen Reine Doku — kein Code, kein Manifest, keine Store-Texte; keine neue Version nötig. PLAN.md bleibt Chronik, die neue Doku erklärt Aufbau und Ablauf; gegenseitige Querverweise statt Dopplungen.
alf commented 2026-10-27 10:23:46 +00:00
Author
Owner
Copy link

Geschlossen auf ausdrücklichen Wunsch von Alf — nicht umgesetzt. Bei Bedarf wieder öffnen.

Geschlossen auf ausdrücklichen Wunsch von Alf — **nicht umgesetzt**. Bei Bedarf wieder öffnen.
alf closed this issue 2026-10-27 10:23:46 +00:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels
  
herkunft/alpha-feedback
Aus Rückmeldungen der Alpha-Tester

  
status
blockiert
 Wartet auf etwas anderes

  
status
zu-testen
 Gebaut, aber noch nicht im echten Einsatz geprüft

  
typ
bug
 Fehler

  
typ
docs
 Dokumentation

  
typ
enhancement
 Verbesserung einer vorhandenen Funktion

  
typ
feature
 Neue Funktion

  
typ
idea
 Idee, noch nicht entschieden

No labels
herkunft/alpha-feedback
status
blockiert
status
zu-testen
typ
bug
typ
docs
typ
enhancement
typ
feature
typ
idea
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
iris/iris-plugins#268
No description provided.