README: document the tools missing from Features/Usage
sell, chain --consumers, planet, route, whatif, buy, runway and network existed in the codebase but were never added to the README - anyone reading it would have missed most of what the toolkit does. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
@@ -25,6 +25,7 @@ Everything the tools print is an **estimate** from public and personal game data
|
||||
**Market tools**
|
||||
- `price`: bid, ask, 7/30-day VWAP, daily volume, supply and demand at every exchange; fill price for a quantity.
|
||||
- `book`: order-book ladder with cumulative depth (market-maker orders handled).
|
||||
- `sell`: where to post an ask, expected hours to clear, and a tranche split (aggressive undercut capped at a volume percentile, patient priced under the next competitor tier).
|
||||
|
||||
**Economics engine** (`puga/econ.py`, ported from the PRUNplanner source, which is treated as the source of truth and checked against its own tests and live FIO values)
|
||||
- Building efficiency: COGC, HQ, experts, faction bonus, fertility, building condition.
|
||||
@@ -33,12 +34,18 @@ Everything the tools print is an **estimate** from public and personal game data
|
||||
**Finding opportunities**
|
||||
- `scan`: ranks every recipe with a depth-aware market model, so it does not recommend recipes whose whole market fits one or two buildings. Fully staffed and understaffed variants, freight cost, HQ/COGC/experts, `--min-n` filter for real markets, a `--planet` mode (extraction, fertility, COGC of a specific planet) and a demolish-later cost.
|
||||
- `persistence` and `history`: how long has a margin lasted? Re-prices any opportunity over the exchange history (30/90/180 days), with payback and expected net gain over 7 and 14 days.
|
||||
- `chain`: make-versus-buy cost tree with sourcing depth of every input.
|
||||
- `chain`: make-versus-buy cost tree with sourcing depth of every input; `--consumers` flips it to find deeper downstream products worth chaining into.
|
||||
- `planet`: ranks planets for a raw resource by extraction factor, with founding cost from real environment-extras materials and jump distance from an existing base (via `route`).
|
||||
- `route`: jump-distance between two planets/systems, built from FIO's own star-system graph (not a PRUNplanner feature).
|
||||
- `arb` (planned) and the legacy `prun_scan` / `prun_cxarb` (kept as a baseline, they overstate thin markets).
|
||||
|
||||
**Your own position**
|
||||
- `state`: syncs `empire/state/company.yaml` from FIO: cash, permits, buildings, real production efficiency, storage and ships.
|
||||
- `simulate`: a Python replica of the PRUNplanner simulator (workforce, efficiency, material I/O, profit), verified against screenshots of it. Reads a local plan or a saved plan from your account, and reports the real new capex (planned minus already built).
|
||||
- `whatif`: marginal ROI of adding to a base you already run (whole-plan diff, not the overstated plan-level ROI); flags any workforce tier the addition newly overloads.
|
||||
- `buy`: cash-aware shopping list for a plan - construction gap versus your built buildings, plus N days of net operating stock, checked against cash and a reserve.
|
||||
- `runway`: days of runway per material before a base stalls, from real net consumption, base storage, and any ship already inbound.
|
||||
- `network`: models a multi-base supply chain (e.g. mine a material at one base, ship it, process it at another) - nets producer surplus against consumer need, charges real freight only on what's moved.
|
||||
- `plan` (plan_push): reads plans from your PRUNplanner account into small YAML files and writes them back (create, update, delete), so you and Claude can edit the same plan, you in the UI and Claude in code. Dry run by default; only plans named `[PuGa] ...` can be written or deleted.
|
||||
|
||||
**Knowledge for Claude** (`CLAUDE.md`, `docs/`)
|
||||
@@ -97,6 +104,10 @@ puga scan --planet ZV-307d --min-n 3 # a specific planet
|
||||
puga scan --min-n 3 --json rows.json && puga persistence rows.json
|
||||
puga chain KV --qty 13 # make-vs-buy and input sourcing
|
||||
puga simulate plans/examples/hwp_buildout.yaml --basis vwap30
|
||||
puga whatif my_base.yaml --add CHP:1 # marginal ROI of adding to a base you already run
|
||||
puga buy my_base.yaml --days 1.5 # shopping list, construction gap + N days of stock
|
||||
puga runway my_base.yaml # days left per material before the base stalls
|
||||
puga planet FEO --min-factor 0.5 --from ZV-759c # rank planets for a resource, with jump distance
|
||||
|
||||
puga plan list # plans in your PRUNplanner account
|
||||
puga plan pull <uuid> -o my_plan.yaml # read a plan (including your UI edits) into a YAML file
|
||||
|
||||
Reference in New Issue
Block a user