diff --git a/docs/features.md b/docs/features.md index 86893bbf..cbc5d7ab 100644 --- a/docs/features.md +++ b/docs/features.md @@ -22,6 +22,12 @@ title: Features ![Gem Item](/reference-images/GemCheck.png) +### Chat Commands{:.!mb-1} + +*Full Page: [Chat Commands](/chat-commands)*{:.text-sm} + +![Chat Macros](/reference-images/ChatMacros.png) + ### Map check{:.!mb-1} *Full Page: [Map Check](/map-check)*{:.text-sm} @@ -46,21 +52,17 @@ Save Regex's or specific strings to use to search in the stash. Also keybindable #### Dump sorting -![Stash Search](/reference-images/StashSearch1.png) +![Stash Search](/reference-images/DumpSortWidget.png) -![Stash Search Settings](/reference-images/StashSearchSettings1.png) +![Stash Search Currency](/reference-images/DumpSortCurrency.png) + +![Stash Search Settings](/reference-images/DumpSortSettings.png) #### Map rolling -![Stash Search 3](/reference-images/StashSearch3.png) +![Stash Search 3](/reference-images/MapRollingBurning.png) -![Stash Search Settings 2](/reference-images/StashSearchSettings2.png) - -### Chat Commands{:.!mb-1} - -*Full Page: [Chat Commands](/chat-commands)*{:.text-sm} - -![Chat Macros](/reference-images/ChatMacros.png) +![Stash Search Settings 2](/reference-images/StashSearchRollingSettings.png) ### Extra Widgets{:.!mb-1} diff --git a/docs/reference-images/DefaultMapRollSearch.png b/docs/reference-images/DefaultMapRollSearch.png new file mode 100644 index 00000000..7b3df202 Binary files /dev/null and b/docs/reference-images/DefaultMapRollSearch.png differ diff --git a/docs/reference-images/DumpSortCurrency.png b/docs/reference-images/DumpSortCurrency.png new file mode 100644 index 00000000..230d4b41 Binary files /dev/null and b/docs/reference-images/DumpSortCurrency.png differ diff --git a/docs/reference-images/DumpSortSettings.png b/docs/reference-images/DumpSortSettings.png new file mode 100644 index 00000000..850bbd3c Binary files /dev/null and b/docs/reference-images/DumpSortSettings.png differ diff --git a/docs/reference-images/DumpSortWidget.png b/docs/reference-images/DumpSortWidget.png new file mode 100644 index 00000000..c8e3eb33 Binary files /dev/null and b/docs/reference-images/DumpSortWidget.png differ diff --git a/docs/reference-images/MapRollingBurning.png b/docs/reference-images/MapRollingBurning.png new file mode 100644 index 00000000..8f8dc326 Binary files /dev/null and b/docs/reference-images/MapRollingBurning.png differ diff --git a/docs/reference-images/RollingMain.png b/docs/reference-images/RollingMain.png new file mode 100644 index 00000000..5793da75 Binary files /dev/null and b/docs/reference-images/RollingMain.png differ diff --git a/docs/reference-images/StashSearchAdd.png b/docs/reference-images/StashSearchAdd.png new file mode 100644 index 00000000..aae33686 Binary files /dev/null and b/docs/reference-images/StashSearchAdd.png differ diff --git a/docs/reference-images/StashSearchMapRolling.png b/docs/reference-images/StashSearchMapRolling.png new file mode 100644 index 00000000..c0c0afc3 Binary files /dev/null and b/docs/reference-images/StashSearchMapRolling.png differ diff --git a/docs/reference-images/StashSearchRollingSettings.png b/docs/reference-images/StashSearchRollingSettings.png new file mode 100644 index 00000000..7f0e037c Binary files /dev/null and b/docs/reference-images/StashSearchRollingSettings.png differ diff --git a/docs/stash-search.md b/docs/stash-search.md index a855ae0c..46f738ea 100644 --- a/docs/stash-search.md +++ b/docs/stash-search.md @@ -1,3 +1,59 @@ --- title: Stash Search --- + +Save text to use for searching in the stash or vendors. You can also bind keybinds to these. While not affiliated, [poe2.re](https://poe2.re/waystone) is extremely useful for generating regexes for various things you want to search for. Check out the [PoE Wiki](https://www.poewiki.net/wiki/Guide:Regex) for more information on PoE's version of Regex. + +To open the widget, press `Shift + Space` and then click either "Dump sorting" or "Map rolling" in the overlay. These are two Preset widgets but they can be customized to your liking. You can add as many of these widgets as you want, so do not feel limited by the presets. + +![Add search](/reference-images/StashSearchAdd.png) + +## Map Rolling + +Map(waystone) rolling is a preset widget that helps to match maps with certain mods on them. + +![Map rolling](/reference-images/StashSearchMapRolling.png) + +Clicking any of these buttons will paste the text into the search bar in the stash or vendor window. For example, clicking "Burning Ground" will paste the text `"Burning Ground"` in the stash search bar. This will then highlight any map(waystone) that has that mod on it. In this case, those could be highlighted and then vendored if you don't want to deal with burning ground. + +![Stash Search burning ground](/reference-images/MapRollingBurning.png) + +Here is what this looks like in settings for the widget. + +![Stash Search settings](/reference-images/StashSearchRollingSettings.png) + +## Dump Sorting + +Dump sorting is a preset widget that helps to highlight certain items, particularly useful when going through a dump tab after mapping. + +![Dump sorting](/reference-images/DumpSortWidget.png) + +Clicking any of these buttons will paste the text into the search bar in the stash or vendor window. Example of searching for currency in a dump tab. This will then highlight any item that contains "currency" in it's description. + +![Dump search currency](/reference-images/DumpSortCurrency.png) + +And it's settings. + +![Dump search settings](/reference-images/DumpSortSettings.png) + +## More Complex Example + +Here is a bit more of a complex example of how the stash search can be setup and used. + +This is using a complex regex to search for maps that do not have certain mods, "Burning Ground" and "Monsters penetrate #% Elemental Resistances". Along with that it also ensures the map is Tier 15+ and has more than 250% waystone drop chance. + +![Stash search example](/reference-images/DefaultMapRollSearch.png) + +In these settings, the actual regex is shown. It is quite unreadable and thus all of these use "Friendly Names", basically flavor text that is displayed in place of the actual used regex. Using this can make it easier to remember what each button does. + +The bottom one is most commonly used so it has been assigned a hotkey for convenience, `F2`. When in the stash, just pressing `F2` will automatically perform that search without even opening the overlay. This is especially useful for searching vendors for items after leveling up. + +![Stash search example settings](/reference-images/StashSearchSettings2.png) + +The hotkey is also visible in the overlay when it is opened, and can toggle all the hotkeys for the widget on and off with the switch in the top right of the widget. + +![Stash search example hotkey](/reference-images/RollingMain.png) + +## Settings + +Inside the settings of the widget, each saved search can be edited, deleted, moved around, be given an alias, and have hotkeys assigned to them. diff --git a/renderer/src/web/stash-search/WidgetStashSearch.vue b/renderer/src/web/stash-search/WidgetStashSearch.vue index 7fd93df9..6e3dadba 100644 --- a/renderer/src/web/stash-search/WidgetStashSearch.vue +++ b/renderer/src/web/stash-search/WidgetStashSearch.vue @@ -54,10 +54,10 @@ export default { }, enableHotkeys: true, entries: [ - { id: 1, name: "", text: '"Pack Size: +3"', hotkey: null }, - { id: 2, name: "", text: "Reflect", hotkey: null }, - { id: 3, name: "", text: '"Cannot Leech Life"', hotkey: null }, - { id: 4, name: "", text: '"Cannot Leech Mana"', hotkey: null }, + { id: 1, name: "", text: '"Increased Pack Size"', hotkey: null }, + { id: 2, name: "", text: '"Additional Packs"', hotkey: null }, + { id: 3, name: "", text: '"Burning Ground"', hotkey: null }, + { id: 4, name: "", text: '"Less Recovery Rate"', hotkey: null }, ], }, { @@ -75,16 +75,16 @@ export default { enableHotkeys: true, entries: [ { id: 1, name: "", text: "Currency", hotkey: null }, - { id: 2, name: "", text: '"Divination Card"', hotkey: null }, - { id: 3, name: "", text: "Fossil", hotkey: null }, - { id: 4, name: "", text: '"Map Tier"', hotkey: null }, + { id: 2, name: "", text: '"Martial Weapon"', hotkey: null }, + { id: 3, name: "", text: "Jewel", hotkey: null }, + { id: 4, name: "", text: '"Waystone Tier"', hotkey: null }, { id: 5, name: "", - text: '"Map Device" "Rarity: Normal"', + text: '"Rarity: Normal"', hotkey: null, }, - { id: 6, name: "", text: "Tane Laboratory", hotkey: null }, + { id: 6, name: "", text: "Trials:", hotkey: null }, ], }, ];