Difference between revisions of "Project-GC UserScript"

From Project-GC
Jump to: navigation, search
m (4265399 moved page UserScript to Project-GC UserScript: Quick Rename (not the permanent name))
m (Change headers)
Line 1: Line 1:
−
= Project-GC UserScript =
 
 
<table style="width:100%;">
 
<table style="width:100%;">
 
<tr>
 
<tr>
 
<td style="width:70%; vertical-align:top;">
 
<td style="width:70%; vertical-align:top;">
−
== Description ==
+
= Description =
 
This tool is a user-enabled script that extends the user experience at the [https://geocaching.com Geocaching.com website].  The audience for this script are primarily geocaching power-users, however some of the basic features can make the novice or beginner experience easier as well.
 
This tool is a user-enabled script that extends the user experience at the [https://geocaching.com Geocaching.com website].  The audience for this script are primarily geocaching power-users, however some of the basic features can make the novice or beginner experience easier as well.
  
 
This script was originally written by Jonas "lillfiluren" Högström; and has been maintained and improved upon by various other [https://github.com/magma1447/greasemonkey-geocaching-projectgc/graphs/contributors geocaching community members]].
 
This script was originally written by Jonas "lillfiluren" Högström; and has been maintained and improved upon by various other [https://github.com/magma1447/greasemonkey-geocaching-projectgc/graphs/contributors geocaching community members]].
−
== Prerequisites ==
+
= Prerequisites =
 
* While ''not required'' - it is highly recommended that you have a [https://project-gc.com/Home/Membership Project-GC membership].  ''Many features will not be present without a membership.''
 
* While ''not required'' - it is highly recommended that you have a [https://project-gc.com/Home/Membership Project-GC membership].  ''Many features will not be present without a membership.''
 
* You need to know how to install an extension<ref name="extension">Web browser extensions are also known as add-ons or plug-ins</ref> into your web browser.
 
* You need to know how to install an extension<ref name="extension">Web browser extensions are also known as add-ons or plug-ins</ref> into your web browser.
Line 16: Line 15:
 
</table>
 
</table>
  
−
== Installation ==
+
= Installation =
 
There are TWO different things you must install:
 
There are TWO different things you must install:
 
# A userscript manager web browser extension.
 
# A userscript manager web browser extension.
 
# The script (userscript) itself.
 
# The script (userscript) itself.
  
−
=== Web browser extension installation ===
+
== Web browser extension installation ==
  
 
Depending on the web browser that you use, follow the directions below to install the extension<ref name="extension" />.  Then proceed to the next section
 
Depending on the web browser that you use, follow the directions below to install the extension<ref name="extension" />.  Then proceed to the next section
  
−
==== Firefox ====
+
=== Firefox ===
 
''These directions are for Firefox v104.* and might vary with older or newer versions.''
 
''These directions are for Firefox v104.* and might vary with older or newer versions.''
 
# From the "Tools" menu, choose "Add-ons and Themes".
 
# From the "Tools" menu, choose "Add-ons and Themes".
Line 36: Line 35:
 
''At anytime, if you wish to change which extension you are using or want to remove the extension, repeat the steps above, and click the "Remove" button that will appear in place of the "Add" button.''
 
''At anytime, if you wish to change which extension you are using or want to remove the extension, repeat the steps above, and click the "Remove" button that will appear in place of the "Add" button.''
  
−
==== Chrome ====
+
=== Chrome ===
 
''These directions are for Google Chrome v104.* and might vary with older or newer versions.''
 
''These directions are for Google Chrome v104.* and might vary with older or newer versions.''
 
# Open (launch) Google Chrome.
 
# Open (launch) Google Chrome.
Line 45: Line 44:
 
''At anytime, if you wish to change which extension you are using or want to remove the extension, repeat the steps above, and click the "Remove from Chrome" button that will appear in place of the "Add" button.''
 
''At anytime, if you wish to change which extension you are using or want to remove the extension, repeat the steps above, and click the "Remove from Chrome" button that will appear in place of the "Add" button.''
  
−
==== Other web browsers ====
+
=== Other web browsers ===
 
Firefox and Chrome are recommended, however depending on the web browser, there may be a Userscript manager available for it.  Tampermonkey<ref name="tampermonkey" /> is the only extension (as of 8/2022) that lists various other browsers that it supports.
 
Firefox and Chrome are recommended, however depending on the web browser, there may be a Userscript manager available for it.  Tampermonkey<ref name="tampermonkey" /> is the only extension (as of 8/2022) that lists various other browsers that it supports.
  
−
=== Userscript installation ===
+
== Userscript installation ==
 
# Visit the [https://greasyfork.org/en/scripts/9713-geocaching-com-project-gc Greasy Fork] website.
 
# Visit the [https://greasyfork.org/en/scripts/9713-geocaching-com-project-gc Greasy Fork] website.
 
# Find and click on the <span style="color:green;">green</span> "Install this script" button.  
 
# Find and click on the <span style="color:green;">green</span> "Install this script" button.  

Revision as of 21:59, 31 August 2022

Description

This tool is a user-enabled script that extends the user experience at the Geocaching.com website. The audience for this script are primarily geocaching power-users, however some of the basic features can make the novice or beginner experience easier as well.

This script was originally written by Jonas "lillfiluren" Högström; and has been maintained and improved upon by various other geocaching community members].

Prerequisites

  • While not required - it is highly recommended that you have a Project-GC membership. Many features will not be present without a membership.
  • You need to know how to install an extension[1] into your web browser.
  • Familiarity with GreaseMonkey[2] or TamperMonkey[3], or Firemonkey[4] managers that enable the this tool and many others based on Userscripts[5].

Installation

There are TWO different things you must install:

  1. A userscript manager web browser extension.
  2. The script (userscript) itself.

Web browser extension installation

Depending on the web browser that you use, follow the directions below to install the extension[1]. Then proceed to the next section

Firefox

These directions are for Firefox v104.* and might vary with older or newer versions.

  1. From the "Tools" menu, choose "Add-ons and Themes".
  2. On the left, locate "Extensions" and click it.
  3. At the top of the window, look for "Find more add-ons" with a search-box next to it. Type in "greasemonkey" (one word) into the box and press return.
  4. A list of extensions will show up, choose the extension you wish to use (Greasemonkey[2], Tampermonkey[3], or Firemonkey[4])
  5. On the page describing the extension, looked for a blue "Add to Firefox" button. Click it.
  6. A pop-up will appear to re-iterate what the extension will do, click "Add".

At anytime, if you wish to change which extension you are using or want to remove the extension, repeat the steps above, and click the "Remove" button that will appear in place of the "Add" button.

Chrome

These directions are for Google Chrome v104.* and might vary with older or newer versions.

  1. Open (launch) Google Chrome.
  2. Visit the following website: https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo
  3. Click the blue "Add to Chrome" button.
  4. A page describing the extension after it is installed will appear, it is safe to close this tab/window.

At anytime, if you wish to change which extension you are using or want to remove the extension, repeat the steps above, and click the "Remove from Chrome" button that will appear in place of the "Add" button.

Other web browsers

Firefox and Chrome are recommended, however depending on the web browser, there may be a Userscript manager available for it. Tampermonkey[3] is the only extension (as of 8/2022) that lists various other browsers that it supports.

Userscript installation

  1. Visit the Greasy Fork website.
  2. Find and click on the green "Install this script" button.
  3. A new window will appear, giving more information about the script. It is encourage to always read what the script will do before installing.
  4. Find the "Install" button and click it.

Once the script is installed, you can view the script source code or enable/disable the script. Once a script is installed, most userscript managers will keep it up-to-date automatically as part of the default settings. Refer to additional pages regarding the various Userscript managers on their usage.

Notes

  1. ↑ 1.0 1.1 Web browser extensions are also known as add-ons or plug-ins
  2. ↑ 2.0 2.1 For more info about Greasemonkey, see Wikipedia article on Greasemonkey
  3. ↑ 3.0 3.1 3.2 For more info about TamperMonkey, see Wikipedia article on Tampermonkey
  4. ↑ 4.0 4.1 For more info about TamperMonkey, see [ https://addons.mozilla.org/en-US/firefox/addon/firemonkey/ More information about Firemonkey]
  5. ↑ For more info about Userscripts, see Wikipedia article on Userscripts
Retrieved from "https://project-gc.com/wiki/index.php?title=Project-GC_UserScript&oldid=1985"