IfRPG Dokumentation¶

Willkommen in der Dokumentation zu IfRPG.

IfRPG ist ein lokal im Browser laufendes Lernspiel im Stil klassischer Action-RPGs. Der spielerische Kern ist bewusst einfach gehalten: Welt erkunden, NPCs ansprechen, Quests lösen, Java-Code schreiben und das Ergebnis direkt im Spiel erleben. Optional kann der Fortschritt auf einen separaten Cloud-Speicherserver mit PHP und SQLite geladen und gesichert werden.

Abdeckung¶

Die Dokumentation umfasst:

• Spielbetrieb: Startbildschirm, Speichern, Laden, Cloud, Quest Viewer, Journal, Erfolge und System-Menü
• Inhaltserstellung: Level Editor, Quest Editor, Journal Editor, Tileset Editor, World- und Global-Settings sowie H5P Importer
• Levelbau: Layer, Tiles, Entities, States, Templates, Treasures, Spawnpunkte, Effekte und Trigger
• Lerninhalte: Java-Quests, H5P, Rich-Content, Mermaid, Mermaid-Objektdiagramme und NSD
• Technik: Weltstruktur, Runtime-Architektur, Savegames und optionaler Cloudserver

Schnellstart¶

Benutzerhandbuch¶

Für Spielerinnen, Spieler und Testende:

• Startbildschirm, Menüs und Steuerung
• Quest Viewer, Journal, Erfolge und System-Menü
• lokale und Cloud-Spielstände
• Java- und H5P-Aufgaben
• Rich-Content in Quests und Journalen

Autoren und Level-Design¶

Editoren und Werkzeuge¶

• Level Editor Handbuch
• Quest Editor Handbuch
• Journal Editor Handbuch
• Tileset Editor Handbuch
• World- und Global-Settings
• H5P Importer Handbuch

Konzepte und Gestaltung¶

• Level-Design Konzepte
• Quest-Design Konzepte

Referenzen¶

• Interaktionstypen-Referenz
• Game API Referenz

Technische Dokumentation¶

• Architektur
• World System

Screenshot-Überblick¶

Die wichtigsten Arbeitsbereiche sind in den Handbüchern mit aktuellen Screenshots dokumentiert:

• Startbildschirm, Quest Viewer, Journal, Erfolge und System-Menü im Benutzerhandbuch
• Java- und H5P-Aufgabenansicht sowie die Reiter Skins und Begleiter ebenfalls im Benutzerhandbuch
• Level Editor mit Tiles-, Layer-, Entity- und Settings-Ansichten im Level Editor Handbuch
• Quest Editor mit Allgemein-, Starter-Code-, Lernziele-, Hinweise- und Rewards-Tab im Quest Editor Handbuch
• H5P-Konfigurationsansicht im Quest Editor Handbuch
• Journal Editor mit General-, Content- und Preview-Ansicht im Journal Editor Handbuch
• Tileset Editor im Tileset Editor Handbuch
• World Settings mit General, Audio, Security, Assets, Templates, Treasures, Erfolgen, Skins, Pets und Global Settings mit Sound, Grafik, Interaktionen und Cloud in World- und Global-Settings
• H5P-Importer im H5P Importer Handbuch

Projektcharakter¶

IfRPG befindet sich weiterhin in einer Alpha-Phase. Inhalt, Quests, Welten und Editorfunktionen sind bereits umfangreich, das Projekt entwickelt sich aber fortlaufend weiter. Die Dokumentation ist deshalb so aufgebaut, dass sie Spielbetrieb, Inhaltserstellung und technischen Unterbau gemeinsam verständlich macht.