Vorlagen
Erfahre, wie du ein Pixi’VN-Projekt aus einer Vorlage erstellst, es in deiner IDE einrichtest, ausführst, anpasst und seine Projektstruktur verstehst.
Du kannst ein neues Projekt aus einer Vorlage erstellen, indem du Folgendes ausführst:
npm create pixi-vn@latestInteraktive Demo
So verwendest du eine Vorlage
Wenn du diese Seite liest, hast du wahrscheinlich bereits ein Projekt aus einer Vorlage erstellt. Die folgenden Abschnitte führen dich durch die ersten Schritte, um es zum Laufen zu bringen.
Ersteinrichtung
Öffne den Projektordner in deiner IDE. Die folgenden Beispiele verwenden Visual Studio Code.
Sobald das Projekt geöffnet ist, schlägt VS Code automatisch einige Schritte vor:
- Empfohlene Erweiterungen installieren — eine Benachrichtigung fordert dich auf, die für den Arbeitsbereich empfohlenen Erweiterungen zu installieren. Es wird dringend empfohlen, dies zu bestätigen. Wenn die Benachrichtigung nicht erscheint, kannst du sie manuell im Bereich „Erweiterungen“ installieren, indem du nach empfohlenen Erweiterungen filterst.
- Startaufgaben ausführen — VS Code kann dich auffordern, die konfigurierten Startaufgaben auszuführen, die alle Projektabhängigkeiten installieren. Wenn du das lieber manuell erledigen möchtest, führe Folgendes aus:
npm installPlattformübergreifend
Wenn du eine Vorlage für Desktop- oder Mobilplattformen ausgewählt hast, musst du die zusätzlichen Abhängigkeiten für Tauri installieren (Rust-Toolchain und plattformspezifische Build-Werkzeuge). Da Tauri eng in die Systemumgebung integriert ist, musst du VS Code wahrscheinlich ein- oder mehrmals neu starten, bevor sich das Projekt als Desktop-Anwendung starten lässt.
Projekt starten
Die Vorlage enthält mehrere vorkonfigurierte Startkonfigurationen für VS Code. Falls du sie noch nicht kennst: Startkonfigurationen sind Verknüpfungen, die VS Code mitteilen, wie dein Projekt gestartet werden soll (und optional einen Debugger anhängen). So musst du die Befehle nicht jedes Mal im Terminal eingeben. Du findest sie im Bereich Ausführen und Debuggen (über das Wiedergabesymbol in der linken Seitenleiste oder mit F5). Wähle oben im Bereich die gewünschte Konfiguration aus dem Dropdown-Menü aus und klicke auf die grüne Wiedergabeschaltfläche.

Folgende Konfigurationen stehen zur Verfügung:
- Debug Game: Dies ist die Konfiguration, die du während der Entwicklung am häufigsten verwendest – jedes Mal, wenn du eine Datei speicherst, lädt der Browser die Seite automatisch neu. Beachte, dass Animationen in diesem Modus möglicherweise nicht ganz flüssig laufen und Assets langsamer geladen werden als in der endgültigen veröffentlichten Version.
- Debug Game Preview: Diese Konfiguration simuliert das Verhalten des Spiels nach der Veröffentlichung möglichst genau: Animationen laufen flüssig, Ladezeiten sind realistisch und Optimierungen sind aktiviert. Verwende diese Konfiguration, um vor der Veröffentlichung zu prüfen, ob alles wie vorgesehen aussieht und funktioniert.
- Run as Desktop App (Dev): Kompiliert das Rust/Tauri-Backend und startet das Spiel in einem nativen Desktop-Fenster. Wenn deine Vorlage nicht für Desktop- oder Mobilplattformen gedacht ist, ist diese Konfiguration nicht vorhanden.
Stil anpassen
Die Benutzeroberfläche der Vorlage basiert vollständig auf shadcn/ui. Du kannst daher das Farbschema anpassen, ohne den Code einer Komponente zu ändern.
Öffne den Theme-Generator von shadcn/ui, passe die Farben nach deinem Geschmack an und wechsle dann zum Abschnitt Copy, um den generierten CSS-Befehl zu kopieren. Führe diesen Befehl im Stammverzeichnis deines Projekts aus:
npx shadcn@latest add <paste-the-generated-command-here>Anschließend empfiehlt es sich, die Quelldateien neu zu formatieren:
npm run formatWeitere Anpassungen — Schriftarten, globale Stile und mehr — findest du unter Stile und Schriftarten.
Projektstruktur
Bildschirme der Vorlage
Die Vorlage enthält vorgefertigte Bildschirme, die die wichtigsten Bestandteile einer Visual Novel abdecken. Jeder Bildschirm ist eine React-Komponente, die mit einer von TanStack Router verwalteten Route verbunden ist.
- Hauptmenü (
/) — der erste Bildschirm, den Spieler beim Start des Spiels sehen. Hier können Spieler ein neues Spiel beginnen, einen gespeicherten Spielstand fortsetzen und die Einstellungen öffnen. - Erzählbildschirm (
/game/narration) — der zentrale Spielbildschirm, auf dem die Geschichte dargestellt wird. Er zeigt Dialoge, Charakter-Sprites, Hintergründe und Auswahlmöglichkeiten an. - Einstellungen — der Einstellungsbereich hat keine eigene Route. Stattdessen verwendet er Search Params, um sich über den gerade aktiven Bildschirm zu legen. So bleibt die URL übersichtlich, während Spieler die Einstellungen überall im Spiel öffnen und zwischen den Einstellungsbereichen (Audio, Anzeige, Sprache usw.) wechseln können, ohne ihren bisherigen Kontext zu verlieren.
- Navigationsbildschirm (
/game/navigation) — nur für Point & Click. Er ermöglicht es den Spielern, zwischen Räumen zu wechseln und die am aktuellen Ort verfügbaren Aktionen auszuführen. - Kartenbildschirm (
/game/map) — nur für Point & Click. Er zeigt die Karte an und lässt die Spieler von einem Ort zum anderen wechseln. Außerdem unterstützt er die Verwaltung mehrerer Karten.