Skip to content

LeonardNolting/schule-labyrinth

Repository files navigation

Schnellstart

Bauen

Input

Editor

Output

Erklärung

Im Schulunterricht benutzen wir Filius und wollen für das Netzwerk unserer Klasse Spiele bereitstellen. Aufgrund der Einschränkungen hinsichtlich JS und CSS, entschieden wir uns für ein "HTML-only"-Labyrinth durch die Schule. Man kann sich dabei durch verschiedene HTML-Dateien klicken, die miteinander verlinkt sind und jeweils das aktuelle Szenario beschreiben.

Mit zunehmender Größe des Spiels wird die Verwaltung der HTML-Dateien stark aufwändiger, außerdem können Stylesheets nicht ausgelagert werden (sondern müssen in jedem einzelnen Dokument inline vorhanden sein), was das einheitliche Verändern des Designs erschwert.

Um diesen Problemen vorzubeugen, gibt es diesen "compiler", welcher Dateien im input-Ordner nimmt und transformiert in den output-Ordner legt. Dadurch ist das HTML-Overhead überflüssig (aber trotzdem erlaubt) und es werden Stylesheets automatisch auf alle Geschwister- und Kind-Dateien angewendet. Restliche Dateien, wie z.B. Bilder, werden ohne Veränderungen nach output kopiert. Aus Bequemlichkeit kann auch Markdown statt HTML verwendet werden, bzw. ein Mix (da HTML auch in Markdown erlaubt ist). Bei pushes zu main wird automatisch das Tag latest ersetzt und der gezippte Ordner output daran angehängt.

Weitere Funktionen, wie z.B. das Auslagern und Einbinden an verschiedenen Stellen von HTML, können noch hinzugefügt werden.

Benutzung

Geschichte bearbeiten

Melde dich mit deinem GitHub-Account an und bearbeite eine Datei in ./input.

Lege eine kurze Nachricht, die deine Veränderungen beschreibt, fest (optional) und bestätige die Veränderung.

Der Workflow wird ausgeführt was sich durch ein gelbes Licht unten zeigt.

Bauen

Sobald das Licht grün ist, kannst du hier die neue Zip-Datei herunterladen und in Filius einfügen. Das sollte innerhalb höchstens einer Minute passieren.

Falls etwas nicht funktioniert hat, wird die Anzeige rot und mir wird eine E-Mail geschickt. Du kannst dann evtl. die Schritte unter "Lokal bauen" befolgen, was aber etwas technisches Verständnis voraussetzt.

Editor

Möchtest du mehrere Dateien bearbeiten, kann es einfacher sein, einen Editor dafür zu benutzen. Drücke dazu einfach nur die "." (Punkt)-Taste auf der Tastatur, oder folge diesem Link.

Dadurch wird VSCode geöffnet, was dir z.B. Autovervollständigung, Syntax highlighting und andere Vorteile bietet.

Lokal bauen

npm i && npm run run

Das output befindet sich jetzt in einem Ordner output.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published