voiceChecklist V1.2 Oliver Strauss oliver.strauss@gmail.com
Including bass.dll from un4seen.com as sound engine.


English
Manual:


1. Introducing
2. Installation
3. Standard flow
4. Own Flow
5. Configuration
6. How to use


1. Introducing:
voiceChecklist is a small application to play recorded checklists. To add a new checklist 
make sure it is placed into the "checklist" folder. The foldername of the new checklist 
will selectable in the menubox, so use short names like "pmdg 737", please.


2. Installation:
Extract all files and folder to a folder of your choice.
The tree should look like this example:

C:\Program Files\voiceChecklist\voiceChecklist.exe
	bass.dll
	|
	---> checklist\
		      |
		      ---> my_checklist\
				       |
				       ---> receiving aircraft\
				       |                      |---> 0.ogg "Receiving aircraft Checklist"
				       |	              |---> 1.ogg "Circuit Brkrs. and Emergency Equip"
				       |                      |---> 2.ogg "Oxygen"
			               |...
				       ---> ....

Updating from 1.0 or 1.1:

- just overwrite the old voiceChecklist.exe

bass.dll is a file for the sound output. It won't work without it!
settings.ini is a file where your settings are stored.


3.Standard Flow:																		 
The sound files can be recorded in the format wav, mp3 and ogg. Important: The first 
filename must be zero, for example "0.ogg" or "0.mp3".For the following files simply 
continue to count. I uploaded some soundpacks at avsim search for "voiceChecklist". 
Feel free to create your own soundpacks.


I use the following sequence for a checklist flow which is hardcoded:

	Receiving Aircraft
	Before Engine start
	After Engine start
	Taxi checklist
	Before Takeoff
	After Takeoff
	Cruise
	On Descend
	On Approach
	Before landing
	After landing
	Parking
	Termination
	
If for example Receiving Aircraft is not a part of your checklist, you can leave this folder 
empty.


4. Own Flow
NEW since 1.2:
If you want to create/rename your own lists with own names follow the next steps:
- create your folder structur like:
	
C:\Program Files\voiceChecklist\voiceChecklist.exe\
	bass.dll
	|
	---> checklist\
		      |
		      ---> my_checklist\
				       |
				       ---> after seating\
				       ---> how to start engines\
				       ...

- create a text file like this:
	1. line:	"after seating:we're sitting"
	2. line:	"how to start engines:a checklist to start engines"
	....
  The first line is the first checklist, the second line is the second checklist and so on. 
  The first part of a line is the foldername, the second separated by ":" is the 
  checklistname which will shown in the application and FS.
  !!IMPORTANT!!: Don't leave any lines emtpy. 

- save this file as "checklists.txt" in your root checklistfolder. 
  (i.e. C:\Program Files\voiceChecklist\checklist\my_checklists\checklists.txt)

- like the standard flow the audiofile name must start with zero "0.mp3","1.mp3"


5. Configuration:
For the first time you will asked to set a key combination. If not press the "Config"
button to set it manully. If you like the see the checklistname in your FS, set a mark
at "Send Checklistname". Press "Ok" to save the config.


6. How to use:
voiceChecklist is easy to use. For example, I set "Ctrl + Shift + x" for the next checklist
and "Ctrl + Shift + C" for the next item. To start with the first checklist select your
desired checklist in the first menu and press "Ctrl + Shift + x". To play the first item 
press "Ctrl + Shift + C".To play the next checklist press the first combination again. 
To repeat the last item, press "Ctrl + Shift + C" twice like a mouse double click.
The small delay is normal.
If you have more than one sound device, you can select a different one with the second menu. 
If not, the standart Windows sound device will be used. 

That's all you need to fly. Have fun!

What's new? 1.2

- create your own checklist name and folders 
  i.e. before engine start = how to start it?
  or   after landing = puuuh, we are alive
- send the checklistname to the FS via FSUIPC (thanks to Pelle Liljendal)
  you need a registered version of FSUIPC
- starting from a certain checklist
- play the last item again

What's new? 1.1

- last opened checklist is selected
- last used audio device is selected
- you can set your own shortcut
- a list of all available checklists in your checklist folder
- you can minimize voiceChecklist to the systray
- less bugs ;)
- an ini File to store the data



Oliver Strauss


Deutsch
Anleitung:

1. Einleitung
2. Installation
3. Standard Struktur
4. Eigener Struktur
5. konfigurieren
6. Anwendung


1. Einleitung
voiceChecklist ist eine einfache kleine Anwendung, mit der man vorher aufgenommene Checklisten 
abspielen kann. Dabei nimmt es die Rolle des Abfragenden ein.


2. Installation
Entpacke alle Dateien in einen Ordner deiner Wahl.
Der Verzeichnissaufbau sollte dementsprechend etwa so ausschauen:

C:\Programme\voiceChecklist\voiceChecklist.exe\
	bass.dll
	|
	---> checklist\
		      |
		      ---> my_checklist\
				       |
				       ---> receiving aircraft\
				       |                      |---> 0.ogg "Receiving aircraft Checklist"
				       |	              |---> 1.ogg "Circuit Brkrs. and Emergency Equip"
				       |                      |---> 2.ogg "Oxygen"
			               |...
				       ---> ....

Update von 1.0 oder 1.1:

- einfach die alte voiceChecklist.exe überschreiben

bass.dll ist für die Soundausgabe zuständig, ohne wird es nicht laufen.
settings.ini hier werden die Einstellungen gespeichert.


3. Standard flow
Es können jederzeit Checklisten hinzugefügt werden. Dabei ist darauf zu achten, dass diese 
im "checklist" Verzeichnis liegen. Der Name des Ordners in dem sich die Checkliste befindet, 
wird im Auswahlmenü angezeigt, er sollte deswegen auch nicht zu lang sein.
						
Die Sounddateien können im Format wav, mp3 und ogg aufgenommen werden. Wichtig: Der Name der 
ersten Datei muss immer Null sein, z.B. "0.ogg" oder "0.mp3". Für die folgenden Dateien 
einfach weiter zählen. Ich habe bereits ein paar Checklisten bei Avsim hochgeladen, einfach 
nach "vc_Beech_1900.zip", "vc_Level-D_767.zip", "vc_PMDG_737.ZIP", "vc_wilco_737.zip" suchen.


Bei der Reihenfolge der Checklisten habe ich mich an unterschiedlichen Quellen orientiert und 
habe die eigentlich gängige Reihenfolge eingebaut:

	Receiving Aircraft
	Before Engine start
	After Engine start
	Taxi checklist
	Before Takeoff
	After Takeoff
	Cruise
	On Descend
	On Approach
	Before landing
	After landing
	Parking
	Termination

Sollte z.B. Receiving Aircraft in einer Checkliste nicht auftauchen, so kann dieser Ordner 
leer gelassen werden.


4. Eigener Struktur
NEU ab 1.2:
Wenn du eingene Namen für die Dateiordner vergeben möchtest, dann tue folgendes:
- erzeuge eine eigene Verzeichnisstruktur:
	
C:\Programme\voiceChecklist\voiceChecklist.exe\
	bass.dll
	|
	---> checklist\
		      |
		      ---> my_checklist\
				       |
				       ---> nach dem hinsetzen\
				       ---> wie man den Motor an macht\
				       ...

- erstelle eine Textdatei mit folgendem Inhalt:
	1. Zeile:	"nach dem hinsetzen:Wir sitzen"
	2. Zeile:	"wie man den Motor an macht:Ja wie geht das denn"
	....
  In der ersten Zeile steht die erste Checkliste, in der zweiten dem entsprechend die zweite 
  Checkliste, usw. Im ersten Teil der Zeile steht der Ordnername der Checkliste. Im zweiten 
  Teil durch den Doppelpunkt getrennt, steht der Text, welcher später in der Anwendung 
  angezeigt wird. 
  !!WICHTIG!!: Es darf KEINE leere Zeile vorhanden sein.

- speicher die Datei unter dem Namen "checklists.txt" in dem dazu gehörigen Ordner ab. 
  (z.B. C:\Programme\voiceChecklist\my_checklists\checklists.txt)

- auch hier müssen die Dateinamen wieder mit Null anfangen "0.mp3, "1.mp3" usw.


5. Konfiguration:
Beim ersten Programmstart wird man zur Eingabe einer Tastenkombination gefragt. Sollte dies
nicht geschehen, so klicke man auf den Schalter "Config". Wenn man den Namen der aktuellen
Checkliste im FS angezeigt haben möchte, so setzt man ein Häkchen bei "Send Checklistname". 
Drücke "Ok" die Einstellungen zu speichern.


6. Anwendung	
Die Anwendung von voiceChecklist ist recht einfach gehalten. Um ein kurzes Beispiel durch
zu gehen habe ich zum aufrufen der Checkliste "Strg + Umschaltt. + X" gewählt und für die
einzelnen Punkte "Strg + Umschaltt. + C". Wähle nun die gewünschte Checkliste im linken
Menü aus und drücke "Strg + Umschaltt. + X". Für die jeweiligen Punkte auf der Checkliste
drücke "Strg + Umschaltt. + C". Zum wiederholen des letzten Punktes drückt man
"Strg + Umschaltt. + C" zweimal hintereinander, wie bei einem Maus doppelklick.
Die kleine Verzögerung ist normal und gewollt.  
Sollte man mehr als eine Soundkarte installiert haben, so kann man diese mit dem zweiten Menü 
auswählen. Sollte man hier nichts auswählen, so wird automatisch die Standardsoundkarte 
gewählt.

Mehr braucht man zum fliegen eigentlich nicht. Viel spaß!



Was ist neu? 1.2

- unabhängig von der vorgegebenen Struktur eigene Namen
  für Checklisten vergeben und so viele man will
- den Namen der Checkliste an den FS schicken über FSUIPC (danke an Pelle Liljendal)
  (registrierte Version von nöten)
- von einer bestimmten Checkliste anfangen
- letzten Punkt wiederholen

Was ist neu? 1.1

- zuletzt verwendete Checkliste wird automatisch ausgewählt
- zuletzt verwendete Soundkarte wird automatisch ausgewählt
- man kann selber eine Tastenkombination auswählen
- es werden alle installierten Checklisten angezeigt
- man kann nun voiceChecklist vollständig minimieren
- weniger Fehler ;)
- eine Ini-Datei zum speichern der Daten

Oliver Strauss

