; This is a sample file of ugf2sgf.txt
; This text file describes the behaviour of the ugf2sgf.exe
;
; Lines starting with ; are ignored during processing
; (Empty lines are ignored too).


; +--------------------------+
; |  TO DO: INSERT COMMANDS  |
; +--------------------------+
;
; IMHO opinion the best thing to do is to start the PandaEgg client from the ugf2sgf executable, so all the files are converted
; automatically after closing the IGS client.
;
; To do so, save both ugf2sgf.exe and ugf2sgf.txt to the PandaEgg client directory and:
; comment out the "ForceError" line and remove the comments from the following 3 lines.
; (See the lines later on, how to create an link which does autostart the PandaNet client).


ForceError: The    ugf2sgf.txt    file - section [TO DO:]  has to be edited.  You can use notepad to do this.

;OUT=data\sgf
;IN=data
;CLOSE


; Nothing to change from this point on.
;
;
; +--------------------------+
; |   COMMAND DESCRIPTIONS   |
; +--------------------------+
;
; The following commands are recognized:
;
;     OUT=<PATH>
;                   This sets the outputpath to the specified path.
;                   All .sgf files found with the following "IN" command will be written to this directory.
;                   This path will remain the output path till another OUT= is specified.
;                   The path may be relative.
;                   This command must be the first command in the file. If it is missing the application will abort with an error.
;                   If this path does not exist, it will be created. If creation failes, the application will abort with an error.
;     IN=<PATH>
;                   Start converting all the .ugf and .ugi files in the specified directory and all its subdirectories.
;                   If no OUT has been specified before, the application will abort with an error.
;                   All .ugf and .ugi files from all subdirs will be written to the output directory flat. The subdirectory
;                   structure of the IN path will not be recreated in the OUT directory.
;     CLOSE
;                   The application will stop and the log window is closed.
;                   If the end of this file is reached without encountering the CLOSE command, the application will end with
;                   the log window open and you will have to close it by hand.


; +-------------+
; |   SAMPLES   |
; +-------------+
;
; Sample 1:
;    OUT=c:\sgf
;    IN=c:\
;                   All the .ugf and .ugi files from the complete c: disk will be converted and written to c:\sgf.
;                   Although files converted before will be skipped, traversing a complete disk can be quite time-consuming.
;
; Sample 2:
;    IN=c:\
;                   Oops, IN without an OUT: error
;
; Sample 3:
;    OUT=c:\panda\egg\data\sgf001
;    IN=c:\panda\egg\data\sys001
;    OUT=c:\panda\egg\data\sgf002
;    IN=c:\panda\egg\data\sys002
;                   The .ugf and .ugi files from within the PandaNet IGS Client save map SYS001 will be converted to the SGF001 map
;                   The .ugf and .ugi files from within the PandaNet IGS Client save map SYS002 will be converted to the SGF002 map
;
; Sample 4:
;    OUT=c:\panda\egg\data\sgf
;    IN=c:\panda\egg\data\sys001
;    IN=c:\panda\egg\data\sys002
;                   The .ugf and .ugi files from within the PandaNet IGS Client save map SYS001 will be converted to the SGF map
;                   The .ugf and .ugi files from within the PandaNet IGS Client save map SYS002 will be converted to the same SGF map
;
; Sample 5:
;    OUT=c:\panda\egg\data\sgf
;    IN=c:\panda\egg\data
;                   Same a sample 4. This will still work if a SYS003 will be added by the client in the future.
;
; Sample 6:
;    OUT=data\sgf
;    IN=.
;    CLOSE
;                   The converted files will be written to the subdirectory data\SGF in the current map.
;                   The .ugf and .ugi files will be searched from the current directory.
;                   After running (without error) the application will close itself.
;                   If the executable is in the same directory as the PandaEgg IGS client, this sample does the same as the samples 4 and 5.


;
; +--------------------------------------+
; |   CREATE A SHORTCUT WHICH DOES ALL   |
; +--------------------------------------+
;
; Put both the ugf2sgf.exe and ugf2sgf.txt file in the PandaNet directory.
; (If you don't know where it's located, right click the client icon and choose "properties".
;  The field "Target" tells you where it is located.
;  The path will probably be "c:\panda\egg" of if you changed it "c:\program files\panda\egg")
; 
; Now create a startup link to the ugf2sgf.exe.
; (If you don't know: right click the ugf2sgf.exe file and choose "Copy to..." -> "Desktop (create shortcut)"
;  An icon will be added to your desktop now.
;  Right click this icon and choose "properties". Position the text cursor in the field "Target" after the text.
;  Type a space and then the name of the executable to start. Normally this will be "egg.exe".
;  The field target now should contain something like       "c:\Panda\ugf2sgf.exe" egg.exe
;  Close the window.
;  Now you can rename the shortcut into something sensible like "IGS").
;
; Don't forget to edit this .txt file, section "TO DO" above!
;
; If you don't want to put the file in the Panda directory, you can still make it function like the description above,
; just use full path names.
;
; (c) 2006, Jan van Loenen, jvloenen@xs4all.nl, http://www.xs4all.nl/~jvloenen/ugf2sgf