Skip to content

docs(readme): drop removed Agents title loading and name current layouts #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Teakowa merged 1 commit into from
Oct 28, 2026
Merged

docs(readme): drop removed Agents title loading and name current layouts #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OCRKit

OCR Api for [Bastion](https://github.com/OWBastion/Bastion)
Screenshot recognition API for [Bastion](https://github.com/OWBastion/Bastion).

## Stack

Expand Down Expand Up @@ -76,9 +76,6 @@ acknowledgement. Only the ID/image hash remain for deduplication. All records, i
undelivered results, expire 24 hours after acceptance. Keep this volume private: it is
transient OCR delivery state, and is not platform business data or training material.

Set `OCRKIT_AGENTS_API_BASE_URL` to the platform origin to load active title labels from
`/v1/agents/titles` at startup. `OCRKIT_AGENTS_API_TIMEOUT_SECONDS` bounds that request.

Successful recognition responses retain the `data`, `warnings`, and optional `debug` fields
and also include traceable contract metadata:

Expand Down Expand Up @@ -119,11 +116,11 @@ decimal places; `cropped` and the related warnings indicate a ratio mismatch aga
configured layout and do not make an approval decision. `blur_score` is a normalized blur
risk from 0 to 1, where higher means blurrier.

Layout v7/v2 regions: `left_panel` (stats; reaches the clear-time row of older HUD revisions), `run_code_panel`, `run_code_right_panel`,
Layout regions (`1280x720-v9` / `1280x800-v4`): `left_panel` (stats; reaches the clear-time row of older HUD revisions), `run_code_panel`, `run_code_right_panel`,
`right_panel` (map, mode, timers, version), `server_load_panel`, `bottom_left_hero` (hero card, the name is its last token),
`achievement_panel` (the stack under the stats block: at most one event, then up to five achievement unlocks;
achievements move up when no event is shown, so the ROI is tall and lines are told apart by content), and
`ai_watermark` (bottom-right generation mark; empty on genuine screenshots). Event/achievement/AI-mark
achievements move up when no event is shown, so the ROI is tall and lines are told apart by content),
`center_banner` (completion banner), and `ai_watermark` (bottom-right generation mark; empty on genuine screenshots). Event/achievement/AI-mark
fields are added to the response separately from the geometry.

The service selects the versioned `1280x720-v9` or `1280x800-v4` ROI layout from the source
Expand Down
Loading