SWGAide_README.txt


Installation
============

In the StarWarsGalaxies folder, backup the profiles folder and screen
shots. Any archiving utility, such as WinZip, will do.

Create a new folder anywhere.

Drop the SWGAide.jar file in the folder.

Double click the icon of SWGAide.jar.

SWGAide now starts and will guide you through its initialization.
Actually, you only need to verify (or possibly find) the location of the
StarWarsGalaxies folder.

SWGAide creates a number of files and folders in its new directory. They
are all self explanatory.



Launching problems
==================

Some users have had problems starting SWGAide. Here comes some suggestions
on how to deal with these issues. Test whether double clicking SWGAide
works after each step, otherwise continue with next step.

1) Do you have the most recent version of Java installed? Try to uninstall
all previous versions of Java from your system and reinstall the latest
version from java.sun.com

2) Verify if Java works with JAR files. Open a Command Prompt and navigate
to the folder with SWGAide.jar by the help of such arcane commands as

    chdir "Program Files\SWGAide"

assuming you created folder "SWGAide" within "Program Files". Located
where the SWGAide.jar file is at, type the following command to launch
SWGAide

    java -jar SWGAide.jar

If this worked but double clicking the SWGAide.jar icon does not, continue
to 3), otherwise verify whether the Java installation works with other Java
applications as there may be a problem with your Java installation.

3) Ensure that Windows handles Java JAR files correctly:
    Go to My Computer -> Tools -> Folder Options -> File Types.
    Find file extension "JAR":
        If JAR is not found:
            Create a new type for JAR.
            Select the new file extension and see next lines.
        Select and click Advanced:
            Click Edit.
            Verify that the program path and trailing characters looks
            similar to this example (its exact look depends on your
            system):

        "C:\Program Files\Java\jre1.6.0_02\bin\javaw.exe" -jar "%1" %*

        Be very careful with the quotes and other signs.
        "Use DDE" should be checked and
        for application "javaw" should be named.



Errors and problems
===================

I welcome all reports, requests, criticism, or whatever you send me.
Please send them to Gorath.Zimoon or to simongronlund at gmail . com.
Kindly give me a few days as IRL may hog me.

Any error is logged to a file read in the "logs" folder. Please attach
that file to a description of what you were doing and how to reproduce the
error, if possible. The better description the more likely I can fix the
problem.

The log files can always be deleted at your leisure.



Usage
=====

My first suggestion is to play around and left and right click to your
heart's content.

The tree-like structure at the leftmost pane presents your stations, i.e.
your accounts, and the galaxies you have (had) a character at. In the case
the characters saved some in-game mails to harddisk these characters are
present. Files such as aliases, macros, and notes files are presented.

Notice that to be able to read in-game mails in SWGAide's mail client you
must regularly issue a command in game, namely

    /mailsave

After some seconds delay a system message tells how many mails were saved.
The more mails to save the longer delay as they are retrieved on demand. At
that point it is safe to delete any mail in game as they are saved at your
harddisk.

However, if such a system message never shows up, then you most probably
have some very old mail listed which cannot be retrieved. In game, select
messages one at a time. If the selected message's text body never shows up,
delete it since it is gone or corrupt at the server.

Mails and screen shots are moved from their original location on the
harddisk to the SWGAide folders. That is of two reasons: 1) safety (SWG
sometimes overwrites screen shots), 2) performance.

It is possible to edit the notes files. Notice though, you should not have
the very same file open in game while editing it outside of the game. Also,
remember to backup regularly (a right click option).



Uninstall
=========

SWGAide does not add anything to the Windows Registry and neither does it drop 
any files anywhere other than in the folder you created for SWGAide. After 
rescuing screenshots and mails you can simply delete folder for SWGAide. 



Have fun

Zimoon @ Gorath
