mr-glubschi / seat-market-orders
SeAT plugin: your characters' sell and buy orders next to the best competing price, with one click to the market window in the game.
Package info
github.com/mr-glubschi/seat-market-orders
Type:seat-plugin
pkg:composer/mr-glubschi/seat-market-orders
Requires
- php: ^8.2
- eveseat/eveapi: ^5.0
- eveseat/services: ^5.0
- eveseat/web: ^5.0
Requires (Dev)
- orchestra/testbench: ^8.0
- phpunit/phpunit: ^10.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
A SeAT 5 plugin that shows the open sell and buy orders of your characters next to the best competing price at the same market, and opens an item's market window in the game with one click, so you can adjust the order right away.
Status: v0.2 (order tables).
Sister plugin: Quick Sell.
What it does
- Characters: pick one, several or all of your characters (remembered). Each shows its open sell / buy orders, whether it is online, and a warning when it cannot open windows in the game.
- View: split (sell orders on top, buy orders below), sell only or buy only; filter by location, item name, or only undercut orders.
- Per order: item icon and name, location, character, quantity left / total, your price, the best price of other players at the same place, the difference in ISK and %, status, suggested price and expiry.
- Status: undercut (someone sells cheaper or pays more), same price, ahead, alone (nobody else on this side there), or ? when the market could not be read. Orders of all your characters are ignored as competitors. Buy orders are compared at the same place only; buy orders elsewhere whose range reaches your place are not included.
- Suggestion: one valid EVE price step better than the competitor (at most four significant digits, as the client allows). One click copies the price (plain number, as the Modify Order window takes it) and opens the item's Market Details window in the game for the character who owns the order.
- Lock: EVE allows a price change only 5 minutes after the order was placed or changed; the page shows
how long is left, counted from the order's
issuedtime. - Sorting: click a column header to sort by it, click again to reverse. Without a choice, undercut orders come first. Rows without a value (no competitor, no suggestion) stay at the bottom.
- Summary: sell and buy value left, undercut and open orders for exactly what the tables show; when a filter hides orders, the figure for all orders of the chosen characters is shown below.
- Refresh: asks SeAT to read the chosen characters' orders from ESI now, with SeAT's own jobs.
Data and storage
| Data | Source | Kept |
|---|---|---|
| Your orders | SeAT's table character_orders (SeAT's jobs Market\Character\Orders and History) |
read only |
| Online status, characters | SeAT's tables character_onlines, character_infos |
read only |
| Item, station and structure names | SeAT's SDE (invTypes, staStations) and universe_structures |
read only |
| Order books (10 best orders per side and item) | ESI, fetched by SeAT jobs: /markets/{region}/orders/?type_id= for NPC stations, /markets/structures/{id}/ with a character token |
Laravel cache, exactly as long as ESI's Expires header says (5 minutes) |
| Chosen characters and view | you | SeAT user settings |
| Open window in game | ESI POST /ui/openwindow/marketdetails/, only on your click |
nothing |
The plugin has no tables of its own. The market code (order books, jobs, price steps) is copied from Quick Sell on purpose, so each plugin can be installed on its own.
Structure markets need a character with the esi-markets.structure_markets.v1 scope (part of SeAT's
default scopes) and access to the structure's market; characters with an order there are tried first.
Opening a window needs the scope esi-ui.open_window.v1 (part of SeAT's default login scopes) and,
according to CCP's ESI documentation, a character who is logged in to the game. For a character who is not
logged in nothing happens and ESI reports no error, so the page says when SeAT last saw it offline. A
character without the scope is marked on the page; log in with it again in SeAT to grant it.
ESI caches a character's open orders for up to 20 minutes, so a change you just made in the game shows up in SeAT with that delay.
Install
Market Orders is installed like any other SeAT plugin (see SeAT's community packages guide):
- Add the package to
SEAT_PLUGINSin your SeAT.env, comma-separated with other plugins, for exampleSEAT_PLUGINS=mr-glubschi/seat-quick-sell,mr-glubschi/seat-market-orders. - Restart the SeAT stack. On start, SeAT installs the plugin.
- In SeAT, give the permission View Market Orders (
marketorders.view) to a role, under Settings → Access Management. Administrators have it automatically.
Roadmap
| Version | Content |
|---|---|
| 0.1 | Skeleton: package, menu entry, permission, character overview, test to open the market window in game |
| 0.2 | Order tables with competing prices, status, suggested price, copy and open in one click, refresh |
| 0.2.1 | Summary figures follow the view and filters (characters, side, location, search, undercut), with the total for all orders below |
| 0.2.2 | Sort the tables by clicking a column header (again to reverse); the choice is remembered in the browser |
| 0.3 | Relist fee, market depth, order slots, recent sales, link to Quick Sell |
Development
composer install vendor/bin/phpunit
The tests boot the plugin with Orchestra Testbench without
the rest of SeAT. To try the plugin in a running SeAT, follow SeAT's
developer installation:
clone this repository into the packages folder of your SeAT stack and register it in
packages/override.json:
{
"autoload": { "Glubschi\\Seat\\MarketOrders\\": "packages/mr-glubschi/seat-market-orders/src/" },
"providers": [ "Glubschi\\Seat\\MarketOrders\\MarketOrdersServiceProvider" ]
}
License
GPL-2.0-or-later, like SeAT.