Recent versions: ||| Galaxytool: v5.1 ||| Galaxytoolbar: v2.6.32 |||

Difference between revisions of "Toolbar usage (Firefox)"

From Galaxytool wiki
Jump to: navigation, search
m (Status Window)
m (Submitting espionage reports)
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= How to open options =
+
= Version 2.6.* =
 +
== Automatic configuration ==
 
First of all, you have to define the correct setting for your universe/Galaxytool.
 
First of all, you have to define the correct setting for your universe/Galaxytool.
 +
If you use Galaxytool version 4.8 or above there is a simple way to configure the Galaxytool Plugin. To do this, logon to your Galaxytool account. At the overview page you should see something like this:
  
To do this, click on "Tools" -> "Add-ons" in Firefox:
+
[[Image:Add_settings.png]]
  
 +
If you don't see this, it might be deactivated in [[User options]].
 +
Now simply click on the button "Add settings to Galaxytool Plugin". The Galaxytool options window will show up with pre-filled settings:
  
[[Image:Tools.png]]
+
[[Image:New_profile.png]]
  
 +
Of course it is also possible to update/add the Logon Key with this button to an existing profile.
 +
For new profiles, you have to insert the OGame servername. You will easily get this address when logging in into your OGame account and copying everything from the address bar of you browser. Then paste it into the corresponding field at the Galaxytool Plugin Options. The Galaxytool Plugin will automatically cut all irrelevant information (like session and http://).
  
Find your Galaxytool addon and select the options button.
 
  
 +
[[Image:ogame-servername.png]]
  
[[Image:Add-Ons.png]]
+
Finally you can push the "Check"-Button, if you like. It will check all your settings and a green dot will appear in the button if everything is fine. If an error occurs, you'll get detailed information about what is wrong, and the colour of the dot will become yellow or red. Yellow means that the Galaxytool URL is correct but another problem occured -- for example a possible error with your username or password. <br>
 +
Please note that the Galaxytool URL and username/password are only checked with version <u>'''4.7'''</u> of the Galaxytool. With v4.6, only the Galaxytool URL is checked and the version of the Galaxytool is received. With v4.5.4 and below, only the Galaxytool URL is checked but nothing else.<br>
 +
A '''red''' dot means that the connection to your Galaxytool could <u>'''not'''</u> be established.<br><br>
  
 +
In the end it should look like this:
  
You can also reach the options screen via Firefox context menu:
+
[[Image:Toolbar-Options2.png]]
Just click somewhere with the right mouse, and select "Galaxytool Plugin" -> "GTP Options"
 
  
 +
<br>If you would like to add some more Galaxytool accounts, simply repeat the steps.
 +
It is possible to add an infinite number of Galaxytool accounts. The Firefox Add-On can send information from one universe to more than one Galaxytool.
  
[[Image:rightclick.png]]
+
<br>As you can see, for every Galaxytool account you can specify which information is 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 message archive in Galaxytool (from v4.7 only), you will have to enable that setting.
  
 +
If you would like to delete one Galaxytool, just select it in the drop-down menu and click on "<u>Delete</u>".<br><br>
  
= Version 2.5.* =
+
Please notice that all changed information (added/deleted tools, changed settings) will be saved when you click on "<u>OK</u>". New changes are undone by clicking on the "<u>Cancel</u>" button.
''' Please note: Version 2.5 has not been released yet, so the images differ from the current version! '''
 
== GTP Settings ==
 
  
In the beginning, you will see an empty profile:
+
== Manual configuration ==
  
[[Image:Toolbar-Options.png]]
+
Of course it is possible to configure the AddOn manually. This is done usually when you use an old Galaxytool. For this you have to open the settings window manually.
 +
To do this, click on the Firefox-Button and then on "Add-ons":
  
  
Now, you have to enter the <u>OGame Servername</u>. 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 domain name:
+
[[Image:Tools.png]]
  
  
[[Image:ogame-servername.png]]
+
Find your Galaxytool addon and select the options button.
  
  
'''electra.ogame.org''' - that is the <u>OGame Servername</u>.
+
[[Image:Add-Ons.png]]
  
In the next field you enter the path to the galaxyplugin.php. An example could be <u>'''http://www.yourdomain.de/galaxytool/secret/galaxyplugin.php'''</u>. You will have to adjust this address to your Galaxytool installation. If you are unsure, ask the admin of your Galaxytool, he will tell you the correct address.
 
  
Finally, enter the <u>'''username'''</u> and <u>'''password'''</u> from your Galaxytool account.<br><br>
+
You can also reach the options screen via Firefox context menu:
 +
Just click somewhere with the right mouse, and select "Galaxytool Plugin" -> "GTP Options"
  
After that, press the "<u>Check</u>" button. <br>
 
It will check all your settings and a green dot will appear in the button if everything is fine. If an error occurs, you'll get detailed information about what is wrong, and the colour of the dot will become yellow or red. Yellow means that the Galaxytool URL is correct but another problem occured -- for example a possible error with your username or password. <br>
 
Please note that the Galaxytool URL and username/password are only checked with version <u>'''4.7'''</u> of the Galaxytool. With v4.6, only the Galaxytool URL is checked and the version of the Galaxytool is received. With v4.5.4 and below, only the Galaxytool URL is checked but nothing else.<br>
 
A '''red''' dot means that the connection to your Galaxytool could <u>'''not'''</u> be established.<br><br>
 
  
Finally, it should look like this:
+
[[Image:rightclick.png]]
  
[[Image:Toolbar-Options2.png]]
+
Now the Options window opens and you can create new Galaxytool profiles or edit existing ones.
  
<br><br>If you would like to add some more Galaxytool accounts, just click on "<u>Add new Tool</u>".
+
== Configuring for oGeneral ==
It is possible to add an infinite number of Galaxytool accounts. The Firefox Add-On can send information from one universe to more than one Galaxytool.
 
  
[[Image:new_tool.png]]
+
Since v2.6 it is possible to configure the Galaxytool Plugin to send the information to a local udp port. This will be used in future by oGeneral, a desktop application comparable to the Galaxytool.
 +
If you want to use this option, simply open the Galaxytool options window manually and check the checkbox at the top right corner. The Galaxytool Plugin will switch the view and you can now set different settings:
  
<br><br>As you can see, for every Galaxytool account you can specify which information is 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 message archive in Galaxytool (from v4.7 only), you will have to enable that setting.
+
[[Image:OGeneral.png]]
  
If you would like to delete one Galaxytool, just select it in the drop-down menu and click on "<u>Delete</u>".<br><br>
+
For more information on the oGeneral take a look here: http://ogeneral.de/
 
 
Please notice that all changed information (added/deleted tools, changed settings) will be saved when you click on "<u>OK</u>". New changes are undone by clicking on the "<u>Cancel</u>" button.
 
 
 
== Status Window ==
 
 
 
As soon as the Add-On finds something to upload, a status window appears and shows what information was sent:
 
 
 
 
 
[[Image:galaxy_found.png]]
 
 
 
[[Image:galaxy_uploaded.png]]
 
 
 
[[Image:stats_found.png]]
 
 
 
[[Image:stats_uploaded.png]]
 
 
 
 
 
<u>Important:</u> The ogame window needs to be completely loaded for the Add-On to recognize relevant data.
 
  
 
== General settings ==
 
== General settings ==
Line 91: Line 79:
 
=== Debug Mode ===
 
=== 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
+
The <u>debug output</u> contains information which can help support staff to help you with possible problems. To get a <u>debug output</u>, you have to enable the check-box "''<u>Show debug information''</u>" in the settings
  
If you try to upload something after you enabled that option, the status window looks like this:
+
If you try to upload something after you enabled that option, the status window change to look like the next 2 examples.
  
This is, how it looks like with a recent version of Galaxytool:
+
How it looks like with the most recent version of Galaxytool:
  
 
[[Image:Debug_mode_on_xml.png]]
 
[[Image:Debug_mode_on_xml.png]]
  
This is, how it looks with an old Galaxytool (v4.5.4 or less):
+
How it looks with an older Galaxytool (v4.5.4 or below):
  
 
[[Image:debug_mode_on.png]]
 
[[Image:debug_mode_on.png]]
  
  
Copy the text into a [http://pastie.org 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.
+
Copy the text into a [http://pastie.org Paste-bin]. <br><br>
Finally, you can disable the Debug mode again.
+
 
 +
Do not copy the <u>debug output</u> directly into the IRC support chat window, you may be disconnected for unintentional flooding!<br>
 +
Do not forget to ''change your '''password'''''. After that, give the link to a support helper when he asks for it.<br>
 +
Once the problem has been solved, you can disable the <u>Debug mode</u> again.
  
 
===Requesting own OGame player ID===
 
===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.
+
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.<br>
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.
+
But if you get logged out after you logged in into Ogame, you can disable that function. This usually happens if the OGame payment-site from which the own player ID is taken, is unavailable or if another Firefox Add-On blocks those requests.
 +
 
 +
== Status Window ==
 +
 
 +
As soon as the Add-On finds something to upload, a status window appears and shows what information was sent.
 +
Some examples:
  
== Submitting espionage reports ==
+
[[Image:galaxy_found.png]] -> [[Image:galaxy_uploaded.png]]
 +
 
 +
[[Image:stats_found.png]] -> [[Image:stats_uploaded.png]]
 +
 
 +
[[Image:Tech_page_found.png]] -> [[Image:Reports_transfered.png‎]]
 +
 
 +
[[Image:Reports_page_found.png]] -> [[Image:Reports_transfered.png‎]]
 +
 
 +
[[Image:Message_found.png]] -> [[Image:Message_updated.png‎]]
  
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.
+
[[Image:Short_cr_found.png]] -> [[Image:Short_cr_updated.png‎]]
  
It could happen, that you get a message like this:
 
  
[[Image:Missing_techs.png]]
+
<u>Important:</u> The OGame window needs to be completely loaded for the Add-On to recognize relevant data.
  
In that case, simply click on the OK-Button, and the techtree will be parsed:
+
== Submitting espionage reports ==
  
[[Image:Techtree.png]]
+
From v2.5 and upwards, espionage reports are submitted automatically. Enable the option "''Show full spy report''" in the OGame options so several espionage reports can be sent simultaneously. The Add-On will only send unread espionage reports.<br><br>
 +
[[Image:fullspyreports.jpg]]
  
After that, try to submit the espionage reports manually. It should work now.
 
  
 +
If you need to submit old espionage reports, you can do this via click on the button in the message section:<br>
 
[[Image:submit_reports.png]]
 
[[Image:submit_reports.png]]
  
 
== Submitting fleet movements ==
 
== 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.
+
The Add-On will submit Phalanx reports automatically if the option is enabled for that Galaxytool.  
  
If you you want to submit your own fleet movements, you have to open the fleet movements overlay (also called Eventlist).
+
If you you want to submit your own fleet movements, you have to open the ''fleet movements'' (also known as ''Eventlist'').<br>
After that, you can submit the fleet movements manually via Firefox Context menu. Simply click on the command "Read fleet movements from page".
+
After that, you can submit the fleet movements manually via the Firefox Context menu. Simply click on the command "Read fleet movements from page".<br>
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.
+
Finally you should see a small notice that the information has been sent.<br>
  
 
= Version 2.1.* =
 
= Version 2.1.* =

Latest revision as of 20:46, 7 January 2013

Version 2.6.*

Automatic configuration

First of all, you have to define the correct setting for your universe/Galaxytool. If you use Galaxytool version 4.8 or above there is a simple way to configure the Galaxytool Plugin. To do this, logon to your Galaxytool account. At the overview page you should see something like this:

Add settings.png

If you don't see this, it might be deactivated in User options. Now simply click on the button "Add settings to Galaxytool Plugin". The Galaxytool options window will show up with pre-filled settings:

New profile.png

Of course it is also possible to update/add the Logon Key with this button to an existing profile. For new profiles, you have to insert the OGame servername. You will easily get this address when logging in into your OGame account and copying everything from the address bar of you browser. Then paste it into the corresponding field at the Galaxytool Plugin Options. The Galaxytool Plugin will automatically cut all irrelevant information (like session and http://).


Ogame-servername.png

Finally you can push the "Check"-Button, if you like. It will check all your settings and a green dot will appear in the button if everything is fine. If an error occurs, you'll get detailed information about what is wrong, and the colour of the dot will become yellow or red. Yellow means that the Galaxytool URL is correct but another problem occured -- for example a possible error with your username or password.
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. With v4.5.4 and below, only the Galaxytool URL is checked but nothing else.
A red dot means that the connection to your Galaxytool could not be established.

In the end it should look like this:

Toolbar-Options2.png


If you would like to add some more Galaxytool accounts, simply repeat the steps. It is possible to add an infinite number of Galaxytool accounts. The Firefox Add-On can send information from one universe to more than one Galaxytool.


As you can see, for every Galaxytool account you can specify which information is 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 message archive in Galaxytool (from v4.7 only), you will have to enable that setting.

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

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

Manual configuration

Of course it is possible to configure the AddOn manually. This is done usually when you use an old Galaxytool. For this you have to open the settings window manually. To do this, click on the Firefox-Button and then on "Add-ons":


Tools.png


Find your Galaxytool addon and select the options button.


Add-Ons.png


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


Rightclick.png

Now the Options window opens and you can create new Galaxytool profiles or edit existing ones.

Configuring for oGeneral

Since v2.6 it is possible to configure the Galaxytool Plugin to send the information to a local udp port. This will be used in future by oGeneral, a desktop application comparable to the Galaxytool. If you want to use this option, simply open the Galaxytool options window manually and check the checkbox at the top right corner. The Galaxytool Plugin will switch the view and you can now set different settings:

OGeneral.png

For more information on the oGeneral take a look here: http://ogeneral.de/

General settings

General settings.png


Status Window

Here you can define how the status window is shown with CSS styles. For example you can 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 window inside the iframe pages of OGame (e.g. opened player messages). This is an extra setting because otherwise if the status window is positioned on the left side of a message it would hide information like subject or sender.

Debug Mode

The debug output contains information which can help support staff to help you with possible problems. To get a debug output, you have to enable the check-box "Show debug information" in the settings

If you try to upload something after you enabled that option, the status window change to look like the next 2 examples.

How it looks like with the most recent version of Galaxytool:

Debug mode on xml.png

How it looks with an older Galaxytool (v4.5.4 or below):

Debug mode on.png


Copy the text into a Paste-bin.

Do not copy the debug output directly into the IRC support chat window, you may be disconnected for unintentional flooding!
Do not forget to change your password. After that, give the link to a support helper when he asks for it.
Once the problem has been solved, 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 after you logged in into Ogame, you can disable that function. This usually happens if the OGame payment-site from which the own player ID is taken, is unavailable or if another Firefox Add-On blocks those requests.

Status Window

As soon as the Add-On finds something to upload, a status window appears and shows what information was sent. Some examples:

Galaxy found.png -> Galaxy uploaded.png

Stats found.png -> Stats uploaded.png

Tech page found.png -> Reports transfered.png

Reports page found.png -> Reports transfered.png

Message found.png -> Message updated.png

Short cr found.png -> Short cr updated.png


Important: The OGame window needs to be completely loaded for the Add-On to recognize relevant data.

Submitting espionage reports

From v2.5 and upwards, espionage reports are submitted automatically. Enable the option "Show full spy report" in the OGame options so several espionage reports can be sent simultaneously. The Add-On will only send unread espionage reports.

Fullspyreports.jpg


If you need to submit old espionage reports, you can do this via click on the button in the message section:
Submit reports.png

Submitting fleet movements

The Add-On will submit Phalanx reports automatically if the option is enabled for that Galaxytool.

If you you want to submit your own fleet movements, you have to open the fleet movements (also known as Eventlist).
After that, you can submit the fleet movements manually via the Firefox Context menu. Simply click on the command "Read fleet movements from page".
Finally you should see a small notice that the information has been sent.

Version 2.1.*

Please follow this link

Browser Extension (Toolbar)
Installation FirefoxUsage Firefox

Installation ChromeUsage Chrome

CompatibilityFAQChangelog