UI-Vorschau
Nichts, das das Aussehen der Spieloberfläche verändert, wird gebaut, bevor jemand eine HTML-Vorschau davon abgestimmt und auf „Speichern“ gedrückt hat. Die gespeicherte values.json ist die Spezifikation: Jede Zahl darin wird zu einer Editor-exponierten Property oder einem Theme-Eintrag, niemals zu einer magischen Zahl im Code. Eine Änderung, die niemand sehen kann, braucht keine Vorschau.
Arbeitsreihenfolge: was vorzupreaken → ein Screenshot dieser Stelle → die Vorscha-Seite → das Review-Sheet → sie stimmen ab und drücken Speichern → aus values.json bauen → Build-vs.-Vorschau-Sheet.
1. Einrichtung (einmal pro Projekt)
- Kopiere
assets/kit/nachdocs/mockups/kit/(ein anderer Ordner funktioniert auch: übergib--mockupsan die Skripte). Engine-spezifische Dateien können weggelassen werden, wenn sie nicht verwendet werden:godot_theme.js+apply_godot.py(Godot),unity_theme.js+apply_uss.py(Unity),unreal_theme.js+apply_unreal.py(Unreal). Godot: kopiere zusätzlichassets/godot/project.jsinkit/und fülle es aus (Schriftarten, Tastensymbole); die Godot-Seiten laden es von dort. project.cssist die einzige Kit-Datei, die bearbeitet werden muss: die Schriftarten des Spiels (@font-face) und die Bedienfeld-Palette, einschließlich--display. kit.js lädt jede deklarierte Schriftart vor dem Zeichnen.- Halte die Vorschauen aus dem Engine-Import fern (Godot: eine leere
.gdignoreindocs/mockups/) und fügedocs/mockups/*/values.draft.jsonunddocs/mockups/*/shots/zu.gitignorehinzu. - Starte den Server im Projektstamm:
python docs/mockups/kit/serve.py(nur Stdlib), dann öffnehttp://127.0.0.1:8765/docs/mockups/<feature>/. Seiten laden die Spielgrafiken über relative Pfade und speichern ihre Abstimmungen auf der Festplatte (§5). - Einlesen der eigenen Styles des Projekts in das Bedienfeld: Godot
GodotTheme(Theme.tres), UnityUnityTheme(.uss, ScriptableObject.asset), UnrealUnrealTheme(C++-Klassen-Standardwerte aus dem Header undDefault*.ini, DataTable exportiert als JSON/CSV). Siehereferences/engines.md; jedes hat eine funktionierende Beispielseite inassets/<engine>/.
2. Fragen, dann den echten Hintergrund holen
- Frage, welcher Bildschirm, welches Element oder welcher Effekt und in welcher Situation, es sei denn, das ist bereits klar.
- Mache einen Screenshot dieser Stelle in der Viewport-Größe des Spiels (der Projekt-Auflösungseinstellung; auch das
stage-Feld im Manifest) mit ausgeblendetem UI, plus einen mit dem heutigen UI als Ausgangsbasis. Verwende ein kleines Skript, das die Engine ausführt (Godot-Vorlage:assets/godot/game_shots.gd; andere:references/engines.md) und behalte es neben der Vorschau für den Build-Check. - Frage die Person nur dann nach einem Screenshot, wenn die Stelle nicht per Skript erreicht werden kann. Wenn es etwas Neues gibt, das noch nicht fotografiert werden kann, oder wenn die Engine hier nicht ausgeführt werden kann, verwende einen einfachen oder vorgetäuschten Hintergrund und sage dies in der Bildunterschrift des Zustands.
3. Die Seite schreiben
Kopiere assets/template/ (oder assets/<engine>/) nach docs/mockups/<feature>/. Das Seitenformat, die Bedienfeld-Spezifikationen, Kit.spec und URL-Parameter sind in references/kit.md.
manifest.json: Titel,stage([w, h]),states(einer pro Situation, die der Spieler sehen kann: leer, voll, fokussiert, deaktiviert, längster Text, mittendrin in einer Animation; jeder mit einer Bildunterschrift undshotTime),variants(2–4, wenn es eine echte Wahl gibt, jeder mit einem Namen und einer Notiz),recommend(Variante und warum, in ein oder zwei Zeilen).index.html:Kit.start({ feature, images, groups, variants, draw }). Gib einer Gruppe von mehr als etwa sechs Wertensections, damit das Bedienfeld sie einklappen kann. Jede Gruppe ist der Ort, an dem die Werte in der Engine leben werden (eine Skriptklasse, ein Theme-Typ, ein Shader), jeder Schlüssel ist der Property-Name, den der Build verwenden wird, in den Einheiten der Engine.draw(ctx, values, s)muss eine reine Funktion vons.tsein (Animationen mitt % lengthloopen).- Das eigene Aussehen des Spiels, keine Annäherung: seine Schriftarten und -größen, Theme-Farben (eine neue Farbe ist ein Vorschlag: sage, zu welcher Palette sie gehört), echte Grafiken über relativen Pfad, echte Texte und Zahlen, und Eingabeaufforderungen, die die tatsächlich gebundenen Tasten zeigen.
- Pixel-Art: ganze Pixel, kein Glätten (der Kit-Standard).
- Bewegungen laufen mit ihrer echten Dauer und Easing. Alles, was wackelt, driftet, blinkt oder aufleuchtet, erhält Reduce Motion / Reduce Flashing-Umschalter in einer
preview: true-Gruppe, die zeigen, was diese Einstellungen daraus machen. - Wenn etwas abgestimmt wird, das bereits existiert, zeichnet Variante
aes genau so, wie es heute ist. Überprüfe es mit dem Ausgangs-Screenshot, bis sie übereinstimmen, oder jede andere Variante wird mit einer falschen Baseline verglichen. - Etwas, das mehrere Vorschauen zeichnen, wird in eine gemeinsame Datei im Kit gelegt, nicht pro Seite kopiert.
4. Das Review-Sheet
python docs/mockups/kit/shots.py <feature>(benötigt Chrome, Edge oder Chromium und Pillow ≥ 10.1) schreibtshots/<variant>_<state>.pngund erstelltsheet.png. Es verwendet die gespeichertevalues.jsonfür seine Variante (--defaultsfür die Standardwerte der Seite) und beendet sich mit einem Fehler ungleich null, wenn eine Seite fehlschlägt, wobei der Fehler auf diesen Shot gezeichnet wird.- Sieh dir das Sheet an, bevor du es zeigst; schneide das, worüber entschieden wird, bei 2× zu: abgeschnittener oder überlappender Text, die falsche Schriftart, irgendetwas außerhalb der Bühne, eine Animation, die in einem langweiligen Moment eingefroren ist (verschiebe ihr
shotTime). - Sende das Sheet, die Live-URL und die zu treffenden Entscheidungen mit deiner Empfehlung.
5. Die Abstimmung lesen
- Während sie abstimmen, wird jede Änderung in
<feature>/values.draft.jsongeschrieben. Lies es, wenn sie fragen, was du denkst; baue niemals daraus. - Speichern (oder Strg/Cmd+S) schreibt
<feature>/values.json, die genehmigte Spezifikation, und die Seite öffnet dann darauf: Zeilen, die sich unterscheiden, werden markiert, ↺ setzt einen Wert zurück, Reset setzt alle zurück. Nur-Vorschau-Werte werden weder markiert noch gespeichert. - Ohne
serve.pylebt die Abstimmung nur im Browser: Speichern kopiert das JSON (und behält es als Standardwerte dieses Browsers), sie fügen es in den Chat ein, und du speicherst es alsvalues.json. - Format:
{"feature", "variant", "values": {Group: {Key: value}}}; Nur-Vorschau-Gruppen werden weggelassen.
6. Aus der Spezifikation bauen
- Godot:
python docs/mockups/kit/apply_godot.py <feature>listet auf, was die Spezifikation im Theme.tresund in den[Export]/@export-Standards des Skripts ändert, das jede Gruppe benennt, in den Uniform-Standards einer<name>.gdshader-Gruppe, Schlüsseln ohne Export, und Szenen, die diese Properties überschreiben.--writewendet an. - Unity:
python docs/mockups/kit/apply_uss.py <feature>macht dasselbe für USS-Custom-Properties (uss:-Gruppen). ScriptableObject-Werte werden von Hand angewendet. - Unreal:
python docs/mockups/kit/apply_unreal.py <feature>listet auf, was die Spezifikation in der C++-Klasse jeder Gruppe ändert:Config/Default<Config>.ini-Überschreibungen für eine Config-Klasse (--target headerschreibt stattdessen die Standardwerte der Deklaration um), Schlüssel ohne UPROPERTY (mit einer einzufügenden Deklaration) und von Hand zu setzende Standardwerte.--writewendet an. DataTable-Werte werden durch Neuladen des bearbeiteten Exports angewendet. - Baue, was noch nicht existiert: Farben, Schriftarten und Bedienfelder im Theme- oder Style-System der Engine; Größen, Abstände, Dauern und Stärken als Editor-exponierte Properties, gruppiert wie das JSON, mit den genehmigten Werten als Standard.
- Überprüfe im laufenden Spiel: mache einen Screenshot jedes Zustands, den die Vorschau hat, und erstelle
<feature>/build_vs_preview.png, Spiel-Screenshot neben Vorschau-Screenshot. Korrigiere, was abweicht. Sage, was nicht überprüft wurde; Browser- und Engine-Text-Antialiasing unterscheiden sich, also beurteile Position und Größe, nicht einzelne Pixel. - Eine spätere Änderung an einem genehmigten Aussehen ist eine neue Runde: Vorschau, Sheet, Speichern, Bauen.
Regeln
- Vorschauen bleiben im Repository: Sie dokumentieren, warum das UI so aussieht, wie es ist. Committe
sheet.pngundvalues.json;shots/und Entwürfe werden neu generiert. - Kein Build vor dem Vorhandensein von
values.json; baue niemals aus dem Entwurf. - Wenn dem Kit etwas fehlt, das eine Vorschau benötigt, füge es zum Kit hinzu, nicht zu einer einzelnen Seite.