Coder Social home page Coder Social logo

flbraun / poe-palette Goto Github PK

View Code? Open in Web Editor NEW
29.0 1.0 1.0 10.3 MB

A command palette for accessing your favorite Path of Exile resources.

License: GNU General Public License v3.0

Python 58.37% CSS 3.92% JavaScript 36.44% HTML 1.26%
electron overlay path-of-exile pathofexile pathofexile-tools

poe-palette's Introduction

PoE Palette

Screen workers love command palettes to quickly access actions in their frequently used programs. Since Path of Exile is basically a second job and the comunity offers a lot of external resources and tools, it's about time it got its own palette!

demo

Capabilities

PoE Palette also knows about a hand-curated list of other smaller tools and websites, e.g. PoELab, Vorici Chromatic Calculator, Timeless Jewel Finder and the Patch Notes Archive.

Installation

  1. Download the latest release from the release page.
  2. Extract the archive and run the poe-palette.exe you will find inside. When you first start the program, you will probably be warned that it will put your computer at risk. This is because the application does not digitally sign its code. As long as you download the official version from the above page, you can be sure that the program is safe to use! Click "More info", then "Run anyway" to proceed.
  3. PoE Palette will now start in the background and appear in your system tray.

Configuration

You can configure the app by right clicking its tray icon (the Mirror of Kalandra icon).

Here you can choose which type of results should appear in your search results and in which league you are playing. The latter is important for referring you to the correct external resources (e.g. trade links).

Using the palette

The palette can be opened (and hidden) by pressing the shortcut Ctrl+P.

Start typing for what you're looking, e.g. abberath. PoE Palette will now perform a fuzzy, case-insensitive search for your term against its internal index and present you with a list of results.

From here on you can either refine your search, or navigate through the results with the Up and Down arrow keys. Hitting Enter will open the currently highlighted result and close the palette.

Performing a prefixed search

You may also perform a prefixed search. A prefixed search consists of a special prefix (see below) followed by a colon followed by your search term, e.g. wiki:abberath. This will limit search results to - in this case - articles in the community wiki. This is very handy when you already know where you want to go, saving you time when navigating through the result list.

The available search prefixes are wiki, poedb, ninja, trade, tft, antiq, craft and tool.

Please note that prefixed searches for resources disabled in the configuration will not work!

Opening the palette for an ingame item

You may also hover over an item in the game and press the shortcut Ctrl+Shift+P. The palette will then open prefilled with the item's name. This allows for quickly opening that item in an external resource, e.g. poe.ninja.

FAQ

Search results don't show a PoE Ninja result for my item!

PoE Ninja does not list every item in the game because they pull their data from GGG's public stash API. So, if no player lists a worthless or exceedingly rare item it does not appear on PoE Ninja, and consequently PoE Palette will not show results for it. If your item is actually listed on poe.ninja please open an issue.

How can I change the palette shortcuts?

You are able to change the shortcuts for both toggling the palette and the ingame item search, but there is no UI for it currently. You can change them manually by editing PoE Palette's config file with a text editor (e.g. Notepad) though. The config file is located at %APPDATA%\poe-palette\config.json. Please exit PoE Palette before modifying this file. Check the official Electron documentation for available key codes and modifiers.

It's league start and the tool isn't working properly!

For PoE Palette to work correctly, all connected tools need to make their adaptations for the new league first. Some tools handle this more graceful than others. On top of that there may be changes required to PoE Palette itself. All of that takes time, and the developers likely want to play the new league just as much as you want. As a general guideline, expect everything to be ironed out at the end of the first week.

Contributing

Pull requests are generally welcome! If you want to add new features or substantially change an existing one, please open an issue beforehand so we can align on the required changes.

Apart from the required code changes, please also provide necessary adjustments to public documentation (e.g. this readme, GitHub wiki, etc).

poe-palette's People

Contributors

dependabot[bot] avatar flbraun avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

kameronbsmiley

poe-palette's Issues

Periodically check for data updates

Currently PoE Palette only checks for new search data on startup. For users who have PoE Palette running in the background for long periods of time this means that they'll miss out on new data (it's re-calculated daily).

Implement a periodic check, and download and rebuild the local search index when a new data file is found.

3.25 Settlers of Kalguur compatibility

Living list of changes required to achieve full 3.25 compatibility.

  • monitor poe.ninja for new categories
  • TFT channels
  • Craft of Exile links for new/changed item bases

TFT integration

Quick access to bulk channels (e.g. bulk-essences-wts-asc, bulk-sets-wts-asc) would be nice.

  • Data scripts must collect channel URLs and write them to the appropriate data files.
  • Opt-in setting to show in search results (TFT is a spicy topic for some folks).
  • Open in Discord desktop app if protocol handler is registered, browser otherwise (just replace https:// of the channel URL with discord://).

Add Craft of Exile support

It would be amazing to add Craft of Exile support. So I could type a base like "Boots" and it would open it in craft of exile. (Or similarly for poedb).

Create settings window

Currently all settings of poe-palette are configured via the context menu of the tray icon. This works well for simple settings (e.g. toggles), but prevents us from creating more complex settings that require text inputs and such.

Create a new settings window that can be brought up from the context menu. Keep the tool and league selection in the tray as well, they're likely to be accessed frequently.

Search for ingame item

When hovering an item ingame, hitting a shortcut should open the overlay with the search bar prepopulated with the item's name.

Add user configured bookmarks

It would be cool to let users configure their own items. For example I could link to my poeplanner build and save it for easy access later, or a YT build video, or a saved POE trade search.

3.23 Compatibility

  • update TFT container phrases
  • observe poe.ninja for new/changed categories

3.24 Necropolis compatibility

Living list of changes required to achieve full 3.24 compatibility.

  • scarabs bulk trading URL generation
  • monitor poe.ninja for new categories
  • purge compass-related stuff
  • TFT channels

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.