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

Difference between revisions of "Toolbar usage (Firefox)"

From Galaxytool wiki
Jump to: navigation, search
(Version 2.3.*)
m (Submitting espionage reports)
 
(27 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
= 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.3.* =
+
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.
== GTP Settings ==
 
  
 +
== 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":
  
  
In the beginning, 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:
+
[[Image:Tools.png]]
  
  
[[Image:ogame-servername.png]]
+
Find your Galaxytool addon and select the options button.
  
  
'''electra.ogame.org''' - this would the OGame Servername.
+
[[Image:Add-Ons.png]]
  
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.
 
  
It is possible to add an infinite number of Galaxytools. The Firefox Add-On sends information from one universe also to different Galaxytools.
+
You can also reach the options screen via Firefox context menu:
 +
Just click somewhere with the right mouse, and select "Galaxytool Plugin" -> "GTP Options"
  
Finally, you have to enter your username/password from your Galaxytool account.
 
 
If you would like to add some more Galaxytools, just click on "Add new Tool".
 
  
 +
[[Image:rightclick.png]]
  
[[Image:new_tool.png]]
+
Now the Options window opens and you can create new Galaxytool profiles or edit existing ones.
  
 +
== Configuring for oGeneral ==
  
As you can see, you can set for every single Galaxytool which information shall be sent.
+
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:
  
If you would like to delete one Galaxytool, just select it in the dropdown menu and click on "Delete".
+
[[Image:OGeneral.png]]
  
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.
+
For more information on the oGeneral take a look here: http://ogeneral.de/
 
 
== Status Window ==
 
 
 
As soon, as the Add-On finds something to upload, a status window appears and shows, what has been sent:
 
 
 
 
 
[[Image:galaxy_found.png]]
 
 
 
[[Image:galaxy_uploaded.png]]
 
 
 
[[Image:stats_found.png]]
 
 
 
[[Image:stats_uploaded.png]]
 
 
 
 
 
Important: The website needs to be loaded completely, otherwise the Add-On won't recognize anything.
 
  
 
== General settings ==
 
== General settings ==
Line 77: Line 74:
 
=== Status Window ===
 
=== 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.
+
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 ===
 
=== 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.
  
 +
How it looks like with the most recent version of Galaxytool:
  
[[Image:debug_mode_on.png]]
+
[[Image:Debug_mode_on_xml.png]]
  
 +
How it looks with an older Galaxytool (v4.5.4 or below):
  
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.
+
[[Image:debug_mode_on.png]]
Finally, you can disable the Debug mode again.
 
  
== Submitting espionage reports ==
 
  
It is possible to submit espionage reports only via Firefox context menu. Please enable in OGame the option "Show full spy report" so several espionage reports can be sent at the same time.
+
Copy the text into a [http://pastie.org Paste-bin]. <br><br>
  
 +
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.
  
[[Image:submit_reports.png]]
+
===Requesting own OGame player ID===
  
= Version 2.1.* =
+
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>
== GTP Settings ==
+
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.
  
That will bring you to the new options screen.
+
== Status Window ==
  
[[Image:Gtp2b-3.jpg]]
+
As soon as the Add-On finds something to upload, a status window appears and shows what information was sent.
 +
Some examples:
  
There is room for up to 5 universes through the plugin.
+
[[Image:galaxy_found.png]] -> [[Image:galaxy_uploaded.png]]
  
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:
+
[[Image:stats_found.png]] -> [[Image:stats_uploaded.png]]
  
http://uni15.ogame.de/game/overview.php?session=yoursession  (german Uni 15).
+
[[Image:Tech_page_found.png]] -> [[Image:Reports_transfered.png‎]]
  
Now you remove the "http://" and everything from "/game" to the end. That's your server address:  
+
[[Image:Reports_page_found.png]] -> [[Image:Reports_transfered.png‎]]
'''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
+
[[Image:Message_found.png]] -> [[Image:Message_updated.png‎]]
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.
 
  
<i>Note-http://www.yourdomain.com/pathtogalaxytool/secret/galaxyplugin.php<br>Your link should look like that, with the /secret/galaxyplugin.php. </i>
+
[[Image:Short_cr_found.png]] -> [[Image:Short_cr_updated.png‎]]
  
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.
+
<u>Important:</u> The OGame window needs to be completely loaded for the Add-On to recognize relevant data.
  
 +
== Submitting espionage reports ==
  
Save the data by clicking "ok".  
+
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]]
  
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.
+
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]]
  
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...
+
== Submitting fleet movements ==
  
 +
The Add-On will submit Phalanx reports automatically if the option is enabled for that Galaxytool.
  
''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.''
+
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 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 has been sent.<br>
  
== Updating Galaxies ==
+
= Version 2.1.* =
 
+
[[Toolbar_Usage_v2.1|Please follow this link]]
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:
 
 
 
[[Image:Gtp u1.jpg]]
 
 
 
Once it says the information is updated, you're ready to change views.
 
 
 
[[Image:Gtp u2.jpg]]
 
 
 
== 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.
 
 
 
[[Image:Gtp u3.jpg]]
 
 
 
[[Image:Gtp u4.jpg]]
 
 
 
== 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.
 
 
 
[[Image:Gtp u5.jpg]]
 
 
 
=== Disabling Automatic Espionage Report Upload ===
 
 
 
You may enable/disable automatic uploading of espionage reports via the Galaxyplugin options in the
 
 
 
[[Image:Gtp_options.png]]
 
 
 
=== 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.
 
 
 
[[Image:Manualesp.jpg]]
 
 
 
==== 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.
 
 
 
[[Image:Debuginfo.png]]
 
 
 
After that you can view every page as usual but you will get a lot more information.
 
 
 
[[Image:Debugoutput.png]]
 
 
 
'''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.
 
  
 
{{Toolbar}}
 
{{Toolbar}}

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