Skip to content

Latest commit

 

History

History
170 lines (118 loc) · 6.66 KB

README.md

File metadata and controls

170 lines (118 loc) · 6.66 KB
Raw

PoE Overlay (Community Fork)

PoE Overlay is a tool for Path of Exile. The core aspect is to blend in with the game. Built with Electron and Angular.

Community Development

This version of PoE Overlay was forked on 2020-06-10 to snapshot the app before it was converted to utilizing Overwolf.

We have a Discord server here where we discuss features, bugs, and development. All are welcome to join.

Features

Feature Overview As Video

Evaluation of items

  • Select your preferred currencies and language
  • Uses the official pathofexile.com/trade website
  • A graphical display of the price distribution
    Click to see imageitem
  • Filter your search on all supported properties on click
    Click to see imageitem_filter
  • An in game browser to display the created search
    Click to see imagebrowser
  • Lets you price tag the item by clicking the desired bar/value

Trade Companion

  • Inspired by MercuryTrade's trade notifications
  • Receive a (small) notification popup when being whispered (or whispering someone else) for a trade
  • Has quick-action buttons to invite, trade, dismiss, whisper, ask-if-still-interested, repeat-trade-whisper, etc...
  • Customizable buttons with your own label that send your own customizable text to the buyer/seller
  • Configurable (positioning & coloring) grid overlay for both Normal & Quad tabs
  • Item highlighting to quickly find the item you're selling (uses the grid overlay & customizable highlight colors)
  • Demo Video

Other Features

  • Bind in game commands to a custom hotkey
  • Premade /hideout on F5 and /dnd on F6
  • Bind websites to hotkeys
  • Navigating storage with Ctrl + MWheel
  • Highlighting items with Alt + F
  • An in game menu to change all settings
    Click to see imagemenu

Getting Started

Supported Platforms

  • Windows 10 x64
  • Windows 7 x64 (with keyboard support enabled)
  • Linux x64

Prerequisites

  • Path of Exile must be in windowed fullscreen mode
  • PoE Overlay should run with privileged rights
  • You may need to install vc_redist

Installation

Head over to Releases and download one of the following files:

Use poe-overlay-Setup-<version>.exe to install locally. This supports auto update / auto launch.

Use poe-overlay-<version>.exe for the portable version. This does not support auto update / auto launch.

Usage

  1. Run PoE Overlay
  2. Start Path of Exile
  3. Wait until you can see PoE Overlay in the bottom left corner
  4. Hit F7 and set Language and League to meet your game settings

Shortcuts

You can change these shortcuts in the user settings menu.

Shortcut Description
Ctrl+D Displays the item in a frame and evaluates the price. You can open the offical trade site on click of the currency value
F7 Opens the user settings menu
Click to see full list
Shortcut Description
Ctrl+D Displays the item in a frame and evaluates the price. You can open the offical trade site on click of the currency value
Alt+T As above - displays the item translated
Alt+W Opens item in wiki
Ctrl+Alt+W As above - but in external browser
Alt+G Opens item in poedb
Ctrl+Alt+G As above - but in external browser
Alt+Q Shows map info (layout, bosses)
Alt+F Highlights item in stash
Ctrl+MWheel Navigates through stash tabs
F5 Go to Hideout
F6 Toggle DND
F7 Opens the user settings menu
F8 Exits overlay
Alt + Num1 Open https://www.poelab.com/
Alt + Num2 Open https://wraeclast.com/
Esc Close latest dialog
Space Close all dialogs

Roadmap

Module Status Notes
Linux In Progress - Allow running this app on Linux
Vulkan In Progress - Support for Vulkan video modes

Developer Docs

See here.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Disclosures

Client Logs

The app reads and parses the client log file generated by the game for the purpose of obtaining whisper and trade-related data such as joining/leaving of players.

PoE Account Sign-in

The app allows signing in to your PoE Account. Doing so will accumlate the following account data for usage within the app:

  • Account profile info [name, realm, etc...] (to show that you're logged in, and used to access other account-related data such as stashes, characters, etc...)
  • A List of private leagues (to allow selecting them from the Leagues list in the settings)
  • Stash info [names, types, etc...] (to allow the appropriate grid overlay to be shown)

Privacy

The app does not collect and distribute/communicate any personal data to a third-party website/location/service.

Third-Party Notice

This app isn't affiliated with Grinding Gear Games in any way.