summaryrefslogtreecommitdiff
path: root/README.rst
blob: 1de236967a7193f19b852529d88ecb859152d1a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
How to use
----------

1. Build the XPI and install it. On Windows, use the "Send to ZIP" function and create a ZIP of the files in the src directory (not OF the src directory).
2. Add your trusted sites to the extensions.eib.trusted preference as follows:
   a. Open about:addons.
   b. Select Preferences for EVE-IGB Bridge.
   c. Input ``["^http://site1.com/", "^http://site2.com/.*\.php$"]``, etc. JSON array of regular expressions as strings. Note that there is no automatic ^$ token insertion.
3. Open "http://127.0.0.1:26001/" in the EVE in-game browser. We recommend that you set this page as your home page since there's nothing else the IGB is useful for.
4. Open one of your trusted sites and start clicking. A recommended starter is http://wiki.eveuniversity.com/ for their ship fittings.

Usage notes
-----------

This is alpha-level software.
It may not work.
It may crash Firefox.
It may format your hard drive.
It is recommended that you do not run this in your primary browser for the time being, as it may be insecure (i.e. allowing bad sites).

You must refresh all affected sites when upgrading EIB or changing the trusted sites.

Avoid excessively complex regular expressions, as they must be checked against each site that is visited.
If such expressions are required, put them at the end of the list as early exit is implemented in the trusted checker.