EM_Tool Readme file. -------------------- Em_Tool gives the player extra real-time information while playing Evochron Mercenary. It is meant to run on a computer with a second monitor but also works using a second computer hooked up over a LAN network. To use it over a network you need to map a network drive from the computer that runs EM_Tool, to the folder where savedata.txt resides on the computer that runs Evochron Mercenary, and enter the path into the EM_Tool.cfg. Setting it up. -------------- You will need to turn on the games data output feature first. Making the game create the savedata.txt file. --------------------------------------------- Create a file in the same folder as the EvochronMercenary.exe file with the name savedatasettings.txt. Edit this file and place the following inside: 2000 c:\sw3dg\EvochronMercenary\ * The first line is the frequency to create the savedata.txt file in milliseconds. (2000=2 seconds) 2000 should work fine for most people but i recommend 500 if your system can handle it. * The second line is the path to where your pilot?.sw files are. (don't forget the trailing backslash) Installation: ------------- Place the EM_Tool.exe in the same folder as your pilot?.sw files. (you can place it in a separate folder if you prefer) Optionally create a shortcut to the EM_Tool.exe file. When you first run EM_Tool it will create several files and 1 folder in the same folder as it resides. All created files can be recognised by their names as they start with EM_Tool. If you installed EM_Tool.exe into a folder other than the same folder as your pilot?.sw files you will need to edit EM_Tool.cfg to include the path to the savedata.txt file (created by the game and placed in the same folder as your pilot?.sw files). Use notepad to edit the cfg file. On my system the folder with the pilot?.sw files is c:\sw3dg\EvochronMercenary so the entry for this for me would be c:\sw3dg\EvochronMercenary\savedata.txt. User Editable files. (you can use notepad to edit them) -------------------- The EM_Tool.cfg file. (Configuration) --------------------- savedata.txt <--- The path to your savedata.txt file 2000 <--- The update frequency (make it the same as in the savedatatextsettings file) SOUND=ON <--- Use sound (ON or OFF) USEWAVS=OFF <--- Use wav files instead of beeps. The files are EM_Tool_Fuel.wav and EM_Tool_Hostile.wav) UPDATEMAP=ON <--- Select whether or not to update the map automatically as you find them in-game. MINFUEL=25 <--- Set the percentage of fuel left before the alarm goes off. USEKEYS=ON <--- Turn on or off the FUNCTION KEYS used for zooming directly to the corresponding zoom level. The order of the configuration entries is significant. The EM_Tool.txt File. (Quadrant Map file) --------------------- This file is updated automatically as you fly around the universe but you can edit it manually as necessary. Each line in this file represents 1 item displayed on the map. (usually a named sector) A line looks like this: Sector=Sapphire,SX=0,SY=0,SZ=0,ZOOM1=UP,ZOOM2=RIGHT,ZOOM3=RIGHT,ZOOM4=RIGHT,ZOOM5=RIGHT,ZOOM6=RIGHT There should be NO SPACES between the comma and the next keyword. SECTOR= is the name of the sector. SX=, SY=, and SZ= are the sector coordinates. ZOOM1= thru ZOOM6= are about where to display the labels for each sector on the map at each zoom level. UP means above the sector marker. DOWN means below the sector marker. LEFT means to the left of the sector marker. RIGHT means to the right the sector marker. HIDE means to hide it at that zoom level. The EM_Tool2.txt File. (Sector Map file) --------------------- This file holds the detail for the in-sector (zoom 8) view. You can edit this file manually to add more detail. Each line in this file represents 1 item displayed on the map. A line looks like this: OBJECT=Sapphire,TYPE=STAR,X=40000,Y=30000,Z=0,SX=0,SY=0,SZ=1,LABEL=LEFT There should be NO SPACES between the comma and the next keyword. OBJECT= is the name of the object as displayed on the map. TYPE= is the type of object. (see below) X=, Y=, Z= are the in-sector coordinates. SX=, SY=, and SZ= are the sector coordinates. LABEL= is where to display the labels for each object on the map. UP means above the object marker. DOWN means below the object marker. LEFT means to the left of the object marker. RIGHT means to the right the object marker. HIDE means to hide it. Object TYPES are: STATION (Cyan) PLANET (Green) STAR (White) CARRIER (Cyan) ASTEROID (Brown) GATE (Magenta) WORM (Magenta) BLACK (Red) MOON (Grey) NEBULA (Orange) CRATE (Yellow) CAVE (Yellow) WRECK (Yellow) Any other types will be displayed in yellow. EMToolNotes\EM_Tool_Notes_(SX)_(SY)_(SZ).txt. --------------------------------------------- Where (SX), (SY) and (SZ) are the sector coordinates for the sector notes. There will be 1 of these files for each sector that you create notes in. These files will reside in a folder called EMToolNotes located in the EM Tool install folder. The EM_Tool.Dat file. (Last screen position of the EM_Tool Windows) --------------------- Delete this file if you can't access the EM_Tool window or the Sector Notes window. Other files. ------------ All files created and used by EM_Tool have a name that starts with EM_Tool. The button files (.bmp) can be replaced with your own art. The sound files (.wav) can be replaced with your own sounds. Program Info. ------------- * The large input box allows you to type in search criteria. * Press the [S] button after entering search criteria to initiate the search. * The [F] button is used to turn Follow mode on and off. (The map will stop following you around if this is off). * The arrow buttons are for panning the map. * The [+] and [-] buttons zoom the map in and out. * At ZOOM level 8 you can click on the OBJECT markers to see a tooltip with coordinates of the object. * The 2 small input boxes allow you to type in map coordinates (SX and SZ) that you want to see on the map. * Press the [X] button after entering the coordinates to move the map to that position which will be marked with a red X. * The [N] Button is for editing/viewing NOTES about each sector. It will be RED when there are existing notes for the current sector. * The Sector Notes window can be moved by clicking and dragging the title. It can also be resized. * At ZOOM levels below 8 you can click on the SECTOR markers to bring up the sector notes window for that sector. * The [L] Button turns on and off the Ships Log. When this is on, changes in sector will be logged to the SHIPS LOG window and to a file on disk named EM_Tool.log. * The FUNCTION KEYS F1 thru F8 can be used to ZOOM directly to the corresponding ZOOM level. * The F9 key gives a count of sectors and objects collected in the EM_Tool.txt and EM_Tool2.txt files. * The sound checkbox (bottom right of screen) turns the sound on and off. Update Notes: ------------- Version 2.03. ------------- * Added this readme file. * Added current centre co-ordinates of the map to the top and left side of the map. * Added current zoom level display to the button panel. * Added an extra ZOOM level. (actually its an extra ZOOM OUT level to see more of the map) * Changed Zoom Level 6 to zoom in more. * Added ability to set where to display map item labels and coords according to ZOOM level. (map needs to be edited or recreated) * Fixed zoom not focusing on correct position when panning or using the [X] button. * Fixed Target Faction now displays a ? when the target display is in list mode as that info is not updated by the game unless you are in detail mode. * Added ability to RESIZE/MAXIMISE the window. * Changed EM Tool only allows 1 instance of itself to be running at a time. Version 2.03 Install notes. --------------------------- Rename your EM_Tool.txt file to something else to allow the program to recreate it. Copy and paste any extra items you have in your old EM_Tool.txt file and edit them to comply with the new format. Version 2.04. ------------- * Added search facility to find a sector by name. (exact match or first occurrence of partial match) * Added an extra zoom in level 7. * Added a display of the current scale. (as per the zoom level) * Replaced EM_Tool_Hostile.wav with another sound. (the old one stopped working for some reason even when replaced with the original) * Changed the hostile warning beep to 3 shorter higher pitched beeps. (used when sound is on and wavs are off) * Added a RELOAD MAP button to save having to close and reload the program after a map edit. * Added some error checking for when reading in the Map files. (EM_Tool.txt and EM_Tool2.txt) * Added a ZOOM level 8 for a detailed in-sector view. (This level uses EM_Tool2.txt NOT EM_Tool.txt) * Added data for the known universe to ZOOM level 8. * Added tooltips to the object markers on ZOOM level 8 containing the coordinates of the object. (click the object marker to view) * Added FUNCTION KEYS F1 - F8 can now ZOOM directly to the corresponding ZOOM level. (This can be disabled in the CFG file) * Added FUNCTION KEY F9 shows a count of mapped sectors and mapped objects. Version 2.04 Install notes. --------------------------- Delete the EM_Tool.gif and allow the program to recreate it. Rename your EM_Tool.txt file to something else to allow the program to recreate it. Copy and paste any extra items you have in your old EM_Tool.txt file and edit them to add the extra zoom level (,ZOOM7=UP). There should be NO SPACES between the comma and the next keyword on each line in the map files. (Due to the new error checking) Delete the EM_Tool_Hostile.wav file if it isn't working and allow the program to replace it. Add the following line to the bottom of your EM_Tools.cfg file: USEKEYS=ON Version 2.05. ------------- * Added a timeout to the F9 count window. * Added a timer to keep track of how long you have been playing. * Added ability to Enter/Edit/View/Track Sector Notes. (per sector) * Added ability to click on SECTOR markers (when below ZOOM level 8) to bring up the sector notes for that sector. * Added equipment slots to the display. Version 2.05 Install notes. --------------------------- Delete the EM_Tool.gif and allow the program to recreate it. Version 2.06. ------------- * Added a DELETE button to the Sector Note window. * Added Rank and Rating to the display. * Fixed RELOAD not working after opening a Sector Note window. Version 2.06 Install notes. --------------------------- Delete the EM_Tool.gif and allow the program to recreate it. Version 2.07. ------------- * Added a Ships Log to track where you have been. (EM_Tool.log) * Added empty sector notes will now have an underlined heading with the SYSTEM NAME that the sector is in when they are started.