                      ---===  QUAKEMAP  ===---        für Windows 95

Version 2.0  (beta 4)

Dies ist die Dokumentation für den Quake Map Explorer.
Für Dokumentationen über Quake Map Editor, lesen Sie bitte EDITOR.TXT.


** Was ist Quake Map Explorer ? ***

Mit Quake Map können Sie Informationen über Karten speichern, die Sie nicht in einer Standardkarte 
speichern konnten (z.B. gruppierte Polyhedrons).

Sie können jetzt mehrere verschiedene Daten speichern, wie z.B. neue Texturen oder Sound und 
Modell-Dateien.

Große Karten benötigen viel Arbeitsspeicher. Deswegen habe ich die Möglichkeit eingebaut,
BSP-Dateien ohne Texturen in QuakeMap Dateien zu importieren (dies ist legal). Dadurch wird 
der benötigte Speicher kleiner.

Ich habe auch meinen eigenen Compiler "REACC" beigefügt, der dem QCC Compiler von ID
ähnelt. Dies hat zwei Vorteile:
1.) Es ist eine bessere Möglichkeit, QuakeC Patches zu verteilen, denn Teile von veränderten Dateien 
     können Verteilt werden.
2.) Sie können QuakeC Patches mit verschiedenen Levels verbinden. 

Sie können auch bestimmte Handlungen mit neuen Tasten belegen ("impuls" Befehle). Es wird Ihnen
eine Liste von neuen Handlungen der installierten Patches gezeigt, in der Sie eine Taste für jede 
Handlung  auswählen können.


** Einleitung **

Beim öffnen von QuakeMap sehen Sie zuerst den QuakeMap Explorer. Wenn Sie eine .qme Datei öffnen,
erscheinen auf der linken Seite des Bildschirms die eingebundenen Wesen sowie Texterklärungen oder
Patches.

Wenn Sie ein Objekt (Karte, Code Patch,etc.) anklicken, sehen Sie dessen Eigenschaften auf der 
rechten Seite des Bildschirms. Sie können Objekte addieren, ausschneiden, neubenennen, löschen 
oder kleben. Um ein neues Objekt hinzuzufügen, wählen Sie de Objekttyp im Menü "New".
Um zu spielen drücken Sie auf "GO" in der rechten Bildschirmhälfte.

Wenn Sie eine .qme Datei erstellen und diese einer anderen Person geben, muß diese Person auch
QuakeMap besitzen um diese zu benutzen. Wenn diese .qme Datei geladen wird, können Sie direkt 
anfangen zu spielen, indem Sie "GO" drücken.Die erste Karte wird automatisch geladen und das 
Spiel kann beginnen.

QuakeMap erstellt ein paralleles Verzeichnis zu Quake mit dem Namen QMapExec. Wenn es Quake 
startet, gibt es ihm den Parameter "-game QMapExec". Quake überprüft zunächst das Verzeichnis
QMapExec und dessen Unterverzeichnisse. Wenn Sie mit einer .qme Datei spielen, werden alle
Dateien in die entsprechenden Unterverzeichnisse extrahiert: z.B. Karten werden im Verzeichnis 
"QMapExec\maps" gespeichert. Kopieren Sie nie selber etwas in das Verzeichnis QMapExec, da
es jedes Mal gelöscht wird wenn "GO" gedrückt wird.


** Beschreibungen **

Der erste Eintrag in eine .qme Datei sollte eine allgemeine Beschreibung ("description") sein.
Sie können auf der rechten Seite des Bildschirms einen Eintrag in "descriptions" machen.
Um eine externe .txt Datei zu erstellen, wählen Sie "export as .txt" im Menü "descriptions".
Beschreibungen werden nicht automatisch extrahiert, wenn Sie auf "GO" drücken.


** Karten **

Eingaben vom Typ "map"sind Karten, die nicht im .map Format gespeichert sind aber in einer binären 
Form, in der Sie Zusatzinformationen wie z.B. Gruppenhierarchien speichern können.
Wenn Sie "map" auswählen, sehen Sie auf der rechten Bildschirmseite eine Voraussicht Ihrer Karte.
Um diese zu editieren, müssen Sie den QuakeMap Editor öffnen, indem Sie den entsprechenden Knopf
anklicken.

Sie können jeder Datei einen DOS-Dateinamen geben (8 Zeichen maximum). Geben Sie diesen unter
"File Name after extraction" ein. Der DOS Dateiname wird beim erstellen der .map Datei vergeben.
Dieser Name wird dann später zum spielen benutzt. Wenn Sie z.B. den Namen "MyTest" vergeben,
wird dieser als "MyTest.map" extrahiert und Sie können dann mit der Eingabe "MAP MYTEST"
spielen.

Mit "export as map" können Sie eine Karte im standard .map Dateiformat abspeichern. 
Mit "Save in new entry" können Sie eine Karte als neuen Eingang in eine .qme Datei abspeichern.
Wenn Sie eine Karte in einer anderen .qme Datei speichern wollen, müssen Sie diese zuerst in
der aktuellen .qme Datei speichern und anschließend ausschneiden und in die gewünschte .qme
Datei einfügen.

Karten werden automatisch extrahiert, wenn Sie auf  "GO" drücken. QBSP,VIS und LIGHT werden 
gestartet.


 ** QuakeC **

Sie können "Patches" in standard QuakeC schreiben. Auf bestimmte Sachen müssen Sie jedoch
achten:

- Der integrierte QC Compiler ist ein patch Compiler, d.h. er modifiziert die originale Progs.dat Datei 
  und schreibt eine neue. Sie müssen (und können) die ganzen .qc Dateien nicht mehr Recompilieren.

- Verteilen Sie nicht ganze .qc Dateien als Patch, sondern schreiben Sie nur eine modifizierte Version
  von einem Patch.

- Um den Benutzer mehrere Patches von mehreren Quellen spilen zu lassen, ändern Sie ,wenn möglich,
  Funktionen nur am Anfang oder am Ende. Dies könne Sie mit der Funktion "inherited" erreichen.
  In "Rockets.qme" finden Sie einige Beispiele hierzu.

- Manche Schlüsselwörter verbinden Aktionen mit Tasten. Sie können das Abhandeln einer Funktion
  auf eine Taste legen. In "Radar.qme" und "Bindtest" finden Sie Beispiele hierzu.

- Wenn Sie ein QuakeC Patch starten, der "bind" Befehle beinhaltet, müssen Sie angeben welche 
  Tasten Sie mit welchen Aktionen belegen wollen. So kann der Benutzer der .qme Dateien diese
  Festlegungen gegebenfalls ändern.


** Compilierte BSP **

Sie können eine compilierte Karte in Ihre .qme Datei einbinden. So können andere Benutzer Ihre
Karten benutzen, ohne vorher QBSP/VIS/LIGHT laufen zu lassen. Diese Methode ist vor allem
vorteilhaft, wenn deren Computer über "wenig" Arbeitsspeicher oder einen langsamen Prozessor
verfügt.

Sie müssen jedem .bsp einen DOS Dateinamen vergeben, der für die Extrahierung benutzt wird.
Sie können die Karte und deren .bsp Datei in ein und derselben .qme Datei speichern. Solange 
deren DOS Namen identisch sind, wird die .bsp Datei wie die compilierte Version der Karte
behandelt. Die Kartewird nicht extrahiert und recompiliert, wenn Sie auf "GO" drücken, sondern
nur die .bsp.

Die Texturen der beigefügten .bsp Dateien wurden entfernt und getrennt abgespeichert.
In einer .qme Datei können Sie Teile einer .bsp ablagern. In eine standard .bsp Datei kann
eine bestimmte Anzahl von Eintragungen getätigt werden, ähnlich wie bei .pak Dateien,
jedoch ohne expliziten Dateinamen. Die ersten Einträge sind die Daten der Wesen, dann kommen 
Daten der Ebenen, dann die Texturen usw. QuakeMap liest jede der Einträge in die .bsp und 
speichert diese in der .qme ab, ausgenommen von den Texturen,die als Liste von Texturnamen
abgespeichert werden. Wenn Sie mit QuakeMap integrierte .qme extrahieren, benutzt es die 
Texturnamen und deren Originaltexturenin den .pak Dateien um ein Standard .bdp zu
rekonstruieren.

Mit dieser geläufigen Version von QuakeMap, können Sie keine persönlichen Texturen benutzen,
die Sie sich selbst angefertigt-, oder woanders herbekommen haben. Aber ich plane an einer
Verbesserung dafür. Sie müßten eine neuen Zugang zur .qme Datei schaffen, der Ihre Texturen 
enthält. Auf diese Weise könnten Sie Ihre .qme Dateien ohne Probleme verteilen -
nicht Standard-Texturen würden systematisch in der Datei gespeichert werden. Schauen Sie
unter "Neue Texturen" in dem "Neu" Menü. 


** Neue Texturen **

noch nicht eingebunden !


** Importierte Dateien **

Importierte Dateien sind Dateien, die direkt in der .qme Datei gespeichert sind, bereit, um in das
spezielle Unterverzeichnis extrahiert zu werden. Wenn Sie z.B. einen neuen Sound in Ihre .qme
einbinden wollen, brauchen Sie nur eine neue Eingabe und importieren die WAV Datei darein.
So wie für Karten und compilerte BSPs müssen Sie dieser Datei den DOS Dateinamen geben,
aber diesmal mit dem Pfad. So müssen z.B. Sounds in dem "Sounds" Unterverzeichnis abgelegt
werden. Dann würden Sie Ihrer Datei den DOS Dateinamen:"Sounds/MySound.wav" geben.
Zusätzliche Informationen finden Sie unter Radar.qme.

Importierte Dateien werden automatisch extrahiert, wenn Sie auf den "GO" Knopf drücken.


** Verbindungen zu IDs Texturen **

Diese Art der Eingabe ist für Sie nicht erhältlich. Ich habe sie in der Datei Models.qme benutzt,
um Verbindungen für ID's Originaltexturen herzustellen und sie in Gruppen zu organisieren.
Sie können diese Gruppenformation noch nicht verändern.


** Standard Models.qme Datei **

Diese Datei sollte für QuakeMap funktionieren. Sie enthält mehrere wichtige Informationen, wie
Modelle für neue Zugänge, die Liste von neuen Wesen, die Sie in Ihre Karten setzen möchten,
die Verbindung zu Texturen etc.
      
