summaryrefslogtreecommitdiff
path: root/Data/BuiltIn/Libraries/lua-addons/addons/Lookup/README.md
blob: d091c0e983bc643f58a463885d9224da9cccb61c (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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# Lookup
A simple [Windower4](http://www.windower.net/) addon that looks up search terms through in-game commands.

The default search is performed with the following command:
```
//lookup "Search Term"
```
Alternatively, the shorthand `lu` can be used:
```
//lu "Search Term"
```

Running this command will open up the search in your default browser.

The search term can be plain text, auto-translate text, or one of the available [selectors](#selectors). If the search term contains a space, it must be surrounded in quotes (this does not apply to selectors).

The default search sites are [FFXIclopedia](http://ffxiclopedia.wikia.com/), [BGWiki](http://www.bg-wiki.com), [FFXIAH](http://www.ffxiah.com), [FFXIDB](http://www.ffxidb.com), and [Google](http://www.google.com). See the [site command](#site) for how to add additional sites.

See the [commands](#commands) section for a list of all available commands.

## Selectors
Selectors can be used in place of plain text search terms. They are very useful for quickly getting information about something in the environment or a recently obtained item.

The following selectors are accepted by this addon:

| Selector | Replacement |
|----------|-------------|
| `<job>`<br>`<mjob>` | The current player's main job. |
| `<sjob>` | The current player's subjob. |
| `<zone>` | The current area/zone. |
| `<item>` | The last item placed in the player's inventory, including items moved from other bags. |

The selectors found in [Windower's documentation](https://github.com/Windower/Lua/wiki/FFXI-Functions#windowerffxiget_mob_by_targettarget) are also accepted. Some of the more useful selectors are listed below, for convenience:

| Selector | Replacement |
|----------|-------------|
| `<t>` | The current target's name. |
| `<bt>` | The current battle target'name . |
| `<pet>` | The name of the current player's pet. |
| `<me>` | The current player's name. |
| `<r>` | The name of the player that last sent a tell to you. |

## Commands
```
//lookup "Search Term"
```
Searches for the term on the default site. The default site is set to "ffxiclopedia" initially, but can be changed with the "default" command.

Alternatively, the shorthand `lu` can be used:
```
//lu "Search Term"
```

#### Default
```
//lookup default "site"
```
Sets the default site to search with. Saved in the global settings (not character-specific).

```
//lookup default player "site"
```
```
//lookup default p "site"
```
Saves the default site only for the current player.

#### Site
```
//lookup site "site" search "http://www.example.com/search?q=${term}"
```
Adds or modifies the site lookup capability.

The second argument, `"site"` is the site that you're modifying. For example, specifying `"ffxiclopedia"` would modify the settings for `ffxiclopedia` searches. New sites can also be added this way.

The third argument, `search`, can be substituted for `zone` or `item` if the site supports zone or item ids in its url.

The last argument is the url of the search. The `${term}` in the url will be substituted for the search term when a lookup is performed.

```
//lookup site "site" remove
```
Removes all lookup capability for the specified site (`"site"`).

```
//lookup site "site" search remove
```
Removes the `search` lookup capability for the specified site (`"site"`). The `search` argument can also be substituted for `zone` or `item`.

#### FFXIclopedia
```
//lookup ffxiclopedia "Search Term"
```
```
//lookup ffxi "Search Term"
```
```
//lookup wikia "Search Term"
```
Searches for the term on [FFXIclopedia](http://ffxiclopedia.wikia.com/).

#### BGWiki
```
//lookup bg-wiki "Search Term"
```
```
//lookup bgwiki "Search Term"
```
```
//lookup bg "Search Term"
```
Searches for the term on [BGWiki](http://www.bg-wiki.com).

#### FFXIAH
```
//lookup ffxiah "Item"
```
```
//lookup ah "Item"
```
Searches for the item on [FFXIAH](http://www.ffxiah.com).

```
//lookup ffxiahplayer "Player"
```
```
//lookup ffxiahp "Player"
```
```
//lookup ahp "Player"
```
Searches for the player on [FFXIAH](http://www.ffxiah.com).

#### FFXIDB
```
//lookup ffxidb "Search Term"
```
```
//lookup db "Search Term"
```
Searches for the term on [FFXIDB](http://www.ffxidb.com).

#### Google
```
//lookup google "Search Term"
```
Searches for the term on [Google](http://www.google.com).