albion/README.md
Заид Омар Медхат 9c4a2a8ed3 Phase 7: passive game sniffer + README
tshark-based capture (no native modules) of the player's own UDP 5056
traffic decoded with photon-packet-parser; market orders detected by
JSON shape (patch-proof) and stored as firsthand prices; event-code
debug log to identify destiny-board codes; Sniffer page + README.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-23 03:32:22 +05:00

46 lines
2.8 KiB
Markdown

# Albion Economy Assistant
A local web app that tells you what to craft, refine, enchant, haul, and watch in Albion Online — using live market prices, the game's own recipe data, and **your** character's destiny board progress.
## Run it
```
npm install
npm run gamedata # first time only: download items/recipes (~40 MB)
npm run dev # starts API (port 4310) + UI
```
Open **http://localhost:5173**.
## First-time setup
1. **Settings page** — pick your Albion server (Europe is default). If `albion-online-data.com` is blocked in your country, turn on your VPN before downloading prices (or set a proxy URL if your VPN is browser-only). Set your game folder (e.g. `E:\albion`) for the travel planner.
2. **Market Data page** — click *Download prices* for your tier range. Prices show age badges (green = fresh); you can manually override any price, and manual prices always win over API data.
3. **Character page** — create a profile, set premium, and enter your destiny board levels per crafting category (mastery / spec / other specs). Every calculation uses the active profile.
4. **Travel Planner page** — click *Import world map* (reads zone connections from your game's files, read-only).
## Pages
- **Opportunities** — ranks every craft/refine/enchant by profit for a chosen city: return rates (city bonuses + focus), station fees from item values, taxes, and recursive buy-vs-craft decisions for inputs. Sort by profit, ROI, or silver-per-focus.
- **Travel Planner** — routes between any two zones, *safe zones only* or *all zones* (shows red/black zone count), plus a haul advisor that ranks what's worth carrying between two cities for your carry weight.
- **Market Watch** — price alert rules (drops below / rises above / buy orders above) checked on an interval.
- **Game Sniffer** — optional: passively reads your own game traffic (requires [Wireshark](https://www.wireshark.org) with Npcap). While capturing, every marketplace you open in game feeds firsthand prices into the app. Passive read-only capture, the same SBI-tolerated technique as the Albion Data Project client.
- **Item Browser / Game Data** — recipe explorer; re-download game data after patches.
## After a game patch
- *Game Data* page → re-download game data.
- *Travel Planner* → re-import the world map.
- If balance values changed (return rates, taxes, city bonuses), edit them via `PUT /api/economy/config` — all game constants are config, not code.
## Data sources
- Recipes/items/zones: [ao-data/ao-bin-dumps](https://github.com/ao-data/ao-bin-dumps) + your local game files (read-only)
- Market prices: [Albion Online Data Project](https://www.albion-online-data.com) + optional local sniffer + manual overrides
- Character data: entered manually (no official API exists); sniffer-assisted auto-fill planned
## Tests
```
npm test
```