dodoxandClaude Sonnet 5
4c186ac677
- pyproject.toml + puga/cli.py: `pip install -e .` installs a `puga <tool>` command, so no venv path is needed (replaces requirements.txt) - tools/plan_push.py: `pull <uuid>` reads a plan (incl. UI edits) back into a YAML spec; recipe entries may carry an amount so switched-off recipes round trip; fixes a variable that overwrote the plan name in build_payload, with a regression test - README: usage with the puga command, and a section on working on the same plans in the PRUNplanner UI and from Claude (write, edit in UI, read back) - CLAUDE.md updated accordingly Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
138 lines
8.2 KiB
Markdown
138 lines
8.2 KiB
Markdown
<h1 align="center">
|
||
<br>
|
||
<img src='./PuGa.png' width="250px">
|
||
<br><br>
|
||
<b>PuGa</b>
|
||
<br><br>
|
||
</h1>
|
||
|
||
A set of tools and know-how for Claude (Claude Code) to assist in the game [Prosperous Universe](https://prosperousuniverse.com), usable by humans too. You ask questions in plain language; Claude answers by running the tools in this repo against live market data and your own company data, instead of guessing.
|
||
|
||
Name origin:
|
||
Plutonium–gallium alloy (Pu–Ga) is a specialized metallic blend of plutonium and gallium primarily used to stabilize the desirable delta (δ) phase of plutonium at room temperature.
|
||
|
||
## How it is meant to be used
|
||
|
||
Open Claude Code in this folder. `CLAUDE.md` is loaded automatically: it tells Claude which tools exist, which numbers to trust, and how to answer. Claude also reads `empire/PROFILE.md` (who you are, how you want answers) if you have one. Then just ask, e.g. *"what should I build on Sunday?"*, *"is BHP still worth it?"*, *"how long until I can afford it?"*. Claude answers by running the tools against live market data and your own company data, instead of guessing. Every tool is also a normal command (`puga <tool>`), so you can run them yourself.
|
||
|
||
### Plans: you and Claude work on the same plans
|
||
|
||
The PRUNplanner web UI is where you look at a plan and tweak it. Claude works on the very same plans through the PRUNplanner API, so either of you can pick up where the other stopped:
|
||
|
||
1. Claude works out a setup with the tools (`scan`, `chain`, `simulate`) and **writes it as a plan into your PRUNplanner account** (`puga plan`), named `[PuGa] ...`.
|
||
2. You **open it in PRUNplanner**, check the simulation, change buildings, recipes, housing, experts or COGC, and save.
|
||
3. Claude **reads your saved version back** (`puga plan pull <uuid>` gives an editable YAML file, `puga simulate --uuid <uuid>` re-simulates it with your edits) and carries on from there: re-pricing it, comparing variants, or adjusting it.
|
||
|
||
Only plans named `[PuGa] ...` are ever written or deleted; your other plans are only read. Writing is a dry run unless you (or Claude, after you ask) pass `--apply`.
|
||
|
||
Everything the tools print is an **estimate** from public and personal game data. Prices move; re-run before acting.
|
||
|
||
## Features
|
||
|
||
**Data layer**
|
||
- Cached clients for the FIO REST API and the PRUNplanner API (public game data, order books, price history, your own sites, storage, production, ships, cash).
|
||
|
||
**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).
|
||
|
||
**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.
|
||
- Workforce satisfaction and consumption, extraction rates, production per day, housing optimizer.
|
||
|
||
**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.
|
||
- `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).
|
||
- `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/`)
|
||
- Verified game mechanics, the market-saturation design, a decision log and a roadmap (`docs/`). Everything specific to your own empire (profile, state, plans, notes) lives in the gitignored `empire/` folder, so this repo can stay public.
|
||
|
||
## Setup
|
||
|
||
Requires Python 3.12 or newer and git.
|
||
|
||
```sh
|
||
git clone <repo-url> PuGa
|
||
cd PuGa
|
||
|
||
# 1. virtual environment; installs the `puga` command into it
|
||
python3 -m venv .venv
|
||
.venv/bin/pip install -e ".[dev]"
|
||
source .venv/bin/activate # once per shell, so `puga` is on your PATH
|
||
|
||
# 2. keys
|
||
cp .env.example .env
|
||
chmod 600 .env
|
||
$EDITOR .env # fill in the values below
|
||
|
||
# 3. optional: the PRUNplanner source used as reference for game mechanics (gitignored)
|
||
tools/refresh_refs.sh
|
||
|
||
# 4. check it works
|
||
puga test
|
||
puga price BHP --cx AI1
|
||
```
|
||
|
||
### `.env`
|
||
|
||
`.env` is gitignored and never committed. Do not paste keys into chat; edit the file.
|
||
|
||
| Variable | What it is |
|
||
|---|---|
|
||
| `FIO_USERNAME` | your in-game / FIO user name |
|
||
| `FIO_REST_KEY` | your FIO REST key (used for your own sites, storage, production, ships, cash on `rest.fnar.net`) |
|
||
| `FIO_API_KEY` | your FIO API (web) key; separate from the REST key, currently unused |
|
||
| `PRUNPLANNER_API_KEY` | API key from your PRUNplanner account, sent as `Authorization: Api-Key <key>` |
|
||
| `COMPANY_CODE` | your company code (used by `tools/state.py` for the first sync) |
|
||
| `DEFAULT_CX`, `DEFAULT_REGION` | default exchange (`AI1` = Antares) and region |
|
||
|
||
Only the public data works without keys (prices, recipes, planets). Your own data needs the FIO extension for the browser client to have uploaded it recently: run `puga state sync` and check the `as_of` time.
|
||
|
||
## Usage
|
||
|
||
`puga help` lists the tools; `puga <tool> --help` shows the options.
|
||
|
||
```sh
|
||
puga state sync # refresh your company state from FIO
|
||
puga price BHP --cx AI1 # prices, VWAP, volume, fill price for a quantity
|
||
puga scan --cogc METALLURGY --experts METALLURGY=2 --min-n 3 --top 20
|
||
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 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
|
||
puga plan my_plan.yaml # dry run: validated summary of what would be written
|
||
puga plan my_plan.yaml --apply # write it to your account as a [PuGa] plan
|
||
puga simulate --uuid <uuid> # simulate the plan as saved in your account
|
||
```
|
||
|
||
## Layout
|
||
|
||
```
|
||
CLAUDE.md entry point for Claude: rules, tool index, source-of-truth order
|
||
docs/ game and toolkit knowledge: mechanics, market model, decisions, roadmap
|
||
puga/ library: data clients, market, economics, saturation, simulator
|
||
tools/ command line tools
|
||
plans/examples/ generic plan specs (also test fixtures)
|
||
state/ company.example.yaml, the shape of your synced state
|
||
tests/ pytest suite
|
||
empire/ (gitignored) YOUR empire: PROFILE.md, state/company.yaml, plans/, docs/ (notes, build plans)
|
||
data/ (gitignored) fetched data cache
|
||
ref/ (gitignored) PRUNplanner source, read-only reference
|
||
```
|
||
|
||
### The `empire/` folder
|
||
|
||
Game knowledge and generic methods go in `docs/`; anything about your own bases, cash, decisions or preferences goes in `empire/`, which is gitignored. `tools/state.py sync` creates `empire/state/company.yaml` (on first use set `COMPANY_CODE` in `.env`). Add `empire/PROFILE.md` yourself: your name, company, how you want answers, agreements with Claude.
|
||
|
||
Not affiliated with Prosperous Universe, FIO or PRUNplanner.
|