Revision as of 21:47, 27 January 2011

How to open options

First of all, you have to define the correct setting for your universe/Galaxytool.

To do this, click on "Tools" -> "Add-ons" in Firefox:

Find your Galaxytool addon and select the options button.

You can also reach the options screen via Firefox context menu: Just click somewhere with the right mouse, and select "Galaxytool Plugin" -> "GTP Options"

Version 2.5.*

Please note: Version 2.5 has not been released yet, so the images differ from the current version!

GTP Settings

In the beginning, you can see an empty profile:

Now, you have to enter the OGame Servername. You will easily get this address when logging in into you OGame account and copying everything from the address bar of you browser, except of the leading "http://" and without all the things behind the TLD:

electra.ogame.org - this would the OGame Servername.

In the next field you have to enter the path to the galaxyplugin.php. An example could be http://www.yourdomain.de/galaxytool/secret/galaxyplugin.php. Of course you have to adjust this address to your Galaxytool installation. If you are unsure, ask the admin of your Galaxytool, he should know the address.

Finally, you have to enter your username/password from your Galaxytool account.

After that, push the "Check"-Button. It will check all your settings and in case, everything is fine, a green dot appears at the button. If an error occurs, you'll get detailed information about what has been wrong, and the color of the dot becomes yellow or red. Yellow means, that the Galaxytool URL is correct, but another problem occured, for example something with your username or password was wrong. Please note, that the Galaxytool URL and username/password are only checked with version 4.7 of the Galaxytool. With v4.6, only the Galaxytool URL is checked and the version of the Galaxytool is received. And with v4.5.4 and below, only the Galaxytool URL is checked, but nothing more. Red means, that no connection to your Galaxytool could be established.

Finally, it should look like this:

If you would like to add some more Galaxytools, just click on "Add new Tool". It is possible to add an infinite number of Galaxytools. The Firefox Add-On sends information from one universe also to different Galaxytools.

As you can see, you can set for every single Galaxytool which information shall be sent. Please note, that the setting "Submit also the contents of player messages" is turned off by default. If you would like to use the messages archive in Galaxytool (from v4.7 only), you have to enable that setting.

If you would like to delete one Galaxytool, just select it in the dropdown menu and click on "Delete".

Please notice, that all changed information (added/deleted tools, changed settings) will be saved, when you click on "OK". All changes can be made undone by clicking on the "Cancel"-button.

Status Window

As soon, as the Add-On finds something to upload, a status window appears and shows, what has been sent:

Important: The website needs to be loaded completely, otherwise the Add-On won't recognize anything.

General settings

Status Window

Here you can define the view of the status window via CSS styles. For example you could replace left with right, so the window would be displayed on the right side of OGame instead on the left side. You can also set the position of the status for the iframe pages of OGame (e.g. opened player messages). There is an extra setting, because otherwise (if the status window would be positioned on the left side) it would hide information like subject or sender of a message.

Debug Mode

The debug output may contain information, which could help supporters to help you with your problems. To get a debug output, you have to enable the checkbox "Show debug information" in the settings

If you try to upload something after you enabled that option, the status window looks like this:

This is, how it looks like with a recent version of Galaxytool:

This is, how it looks with an old Galaxytool (v4.5.4 or less):

Copy the text into a Pastebin. (Don't copy it directly into the IRC window, you may become disconnected then!) Don't forget to replace the password. After that, give the link to a supporter. Finally, you can disable the Debug mode again.

Requesting own OGame player ID

This setting is used to disable the request to the OGame server which is sent to get the own player ID. This setting should stay turned on, because it prevents the Galaxytool from creating duplicate player entries and incorrectly assigned planets. But if you get logged out once you logged in into Ogame, you could try to disable that function. This usually happens, if the OGame payment-site (from which the own player ID is taken) is unavailable, probably because of other AddOns blocking such requests. Therefore, it is possible to disable that request.

Submitting espionage reports

From v2.5, espionage reports are submitted automatically. Please enable in OGame the option "Show full spy report" so several espionage reports can be sent at the same time. The AddOn will only send the unread espionage reports then.

It could happen, that you get a message like this:

In that case, simply click on the OK-Button, and the techtree will be parsed:

After that, try to submit the espionage reports manually. It should work now.

Submitting fleet movements

The AddOn will submit Phalanx reports automatically, if the option is enabled for that Galaxytool. Of course, you can also submit them via Firefox Context menu, but this should only be necessary, if the previous submission failed due to missing language information.

If you you want to submit your own fleet movements, you have to open the fleet movements overlay (also called Eventlist). After that, you can submit the fleet movements manually via Firefox Context menu. Simply click on the command "Read fleet movements from page". Finally you should see a small notice that the information were sent. Please note, that a complete status window only appears, if debug mode is turned on. The normal status window would hide important fleet information, that's why only a small notice is displayed.

Version 2.1.*

GTP Settings

That will bring you to the new options screen.

There is room for up to 5 universes through the plugin.

You have to fill in the server of your universe in the "Ogame Servername" field. You can get the server address by right-clicking on the "overview" link at OGame and choose "copy link location". You will get an address like this:

http://uni15.ogame.de/game/overview.php?session=yoursession (german Uni 15).

Now you remove the "http://" and everything from "/game" to the end. That's your server address:

uni15.ogame.de 

you have to fill in the first column.

In the "Galaxytool URL" field you need to fill in the path to the galaxyplugin.php of the corresponding galaxytool. Normally the file galaxyplugin.php is stored at the secret folder of your galaxytool. That file receives the information from the toolbar and its URL must be inserted at the URL textfield. You need to fill in the complete path, e.g. http://www.yourdomain.com/pathtogalaxytool/secret/galaxyplugin.php The admin can delete the file if he does not want the usage of the toolbar. He can also rename the file, so nobody knows the URL except authorized users. So if you are not sure ask your admin what the URL is to the required file.

Note-http://www.yourdomain.com/pathtogalaxytool/secret/galaxyplugin.php
Your link should look like that, with the /secret/galaxyplugin.php.

The "Username" and "Password" fields should be filled in with your Galaxytool username/password.

Also, the universe field should fill itself on upon your first login to ogame with the toolbar 2.0 enabled.

Save the data by clicking "ok".

Now your toolbar is ready to use!

If the data was sent successfully the status of the toolbar changes to show what you have updated.

The status information and all texts of the toolbar are only available in english but you can use them with every OGame language! It works with english as well as with french, spanish...

Important: Your browser needs to load the pages (stats or galaxy view) completely! Otherwise the script won't start and the information will not be sent to the galaxytool.

Updating Galaxies

To upload galaxy data to your Galaxy, just view the Galaxy. Pay special attention to your status window within ogame.

Upon viewing the galaxyview has finished loading completely you should see:

Once it says the information is updated, you're ready to change views.

Updating Statistics

Updating statistics is done much like updating galaxies, upon viewing the statistics, you will see they're found, and that they've finished updating.

Uploading Espionage Reports

One of the new features of the plugin is the ability to automatically upload your espionage reports.

Please make sure you don't have the truncated view option selected in your ogame options for this to work.

Upon clicking on "Messages" in your ogame menu, the reports should be uploaded automatically, and you should receive a status update.

Disabling Automatic Espionage Report Upload

You may enable/disable automatic uploading of espionage reports via the Galaxyplugin options in the

Manual uploading of espionage reports

To upload espionage reports with automatic report uploading disabled, you may right click on your browser window and choose to manually upload your reports. Please note that you must of course be on your messages window for this function to work.

Redesign universes

In the current version for redesign universes this is the only possibility to upload espionage reports via Firefox Extension. Automatic Transmission has been disabled for performance reasons. Make sure, that you enabled in your ogame account the option to show full espionage reports.

Enable debugging functionality

Sometimes it is helpful to activate the debug printout to allow developer or supporter to analyze the problem. In this case you need to activate the debugging at your toolbar options.

After that you can view every page as usual but you will get a lot more information.

Please remove your password from the printout if you submit those information to anybody.

Don't try to copy & paste the entire text into any IRC Channel. Instead use http://galaxietool.pastebin.com/pastebin.php submit your debug info and forward the link to your paste on to whoever is helping you.