POE2Overlay AGENTS.md

POE2Overlay AGENTS.md is an instructions file for Codex, OpenCode from yuz9610/POE2Overlay. It costs 1,951 tokens per session, scanned A, original, MIT.

Instructions for AI coding agents working on POE2Overlay, a software project. They point agents to the project's architecture, user guide, build format, workflow rules, and other documentation sources.

In plain words
What is it for?
Navigating the repository, choosing where documentation changes belong, understanding build data and user-facing behavior, and following the project's task and review process.
Why use it?
They help agents find the authoritative document for each kind of information before changing code or documentation. This prevents duplicated or conflicting project guidance.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/yuz9610/poe2overlay/agents-md
Clone the repo
git clone --depth 1 https://github.com/yuz9610/POE2Overlay

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for POE2Overlay AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/yuz9610/poe2overlay/agents-md.svg)](https://agentmods.dev/instructions/yuz9610/poe2overlay/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/yuz9610/poe2overlay/agents-md"><img src="https://agentmods.dev/badge/instructions/yuz9610/poe2overlay/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 1,951 This file is loaded in full into every session.
When invoked 1,951 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01951 $0.01951
Opus 5 $0.00975 $0.00975
Sonnet 5 $0.00390 $0.00390
Haiku 4.5 $0.00195 $0.00195

Measured 5d ago against content hash e001ec741317, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-05, from the pricing page.

Security

Grade A, and why

POE2Overlay AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 5d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 98 lines

How it starts

The opening of the file, as written. The whole thing — 98 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AI Agent 指南

人類開發者請改讀 docs/README.mddocs/ARCHITECTURE.md。本頁供 Codex / Cursor 等工具自動載入。
Workflow 人類速查(短命令、跳過確認、恢復 session):docs/AI_AGENT_SETUP.md
Claude / Claude Code 入口:根目錄 CLAUDE.md(co-author: ClaudeAgent)。
Kiro 入口.kiro/steering/(co-author: KiroAgent)。

本 repo 的 文檔目標架構docs/README.md技術總覽docs/ARCHITECTURE.md。開始改碼前請先讀對應文件;本頁為精簡入口,不承載長篇規則。

必讀

  1. docs/ARCHITECTURE.md — 技術棧、目錄、資料流、IPC 表、常見修改入口
  2. docs/ENCODING.md — UTF-8 無 BOM、LF、pwsh 7+;含中文 JSON 勿改編碼
  3. docs/PROJECT_WORKFLOW.mdworkflow 單一真相(gate、狀態轉移、commit、diagnostic log)
  4. docs/AI_AGENT_PROMPTS.md — 六步 prompt 模板(規則以 PROJECT_WORKFLOW 為準)

文檔信息架構(agent 必須遵守)

完整表格見 docs/README.md § 目標信息架構。修改文件時先判斷知識類型,只更新對應單一真相來源(SOT),其他入口只放短摘要與連結。

知識類型 單一真相來源
技術架構、IPC、資料流、模組 docs/ARCHITECTURE.md
玩家操作與可見 UI docs/USER_GUIDE.md
Build JSON schema / 支援範圍 docs/BUILD_JSON.md
由攻略生成 Build JSON 的流程 docs/CREATE_BUILD.md
編碼、LF、BOM、PowerShell 政策 docs/ENCODING.md
idea / sprint / task / accept / commit 流程 docs/PROJECT_WORKFLOW.md
Prompt 模板 docs/AI_AGENT_PROMPTS.md(不得新增獨有流程規則)
Agent 入口維護 docs/AI_AGENT_SETUP.md
當前 idea / sprint 狀態 docs/BRAINSTORM.mddocs/SPRINTS.mddocs/sprints/

新增或修改 docs 時:每個 docs/**/*.md 頂部都要有 文檔目的不負責 定位;避免把同一規則長篇複製到多處。AGENTS.md.cursor/rules/*.mdc 只做 agent 可見摘要。

專案一句話

Tauri 2 桌面:PoE2 Area Overlay(Rust 讀 Client.txt → 區域/BD 卡片;build JSON 只讀)+ 規劃中 PoE2 BD Manager(第二 exe,編輯 data/build/)。全部本機,無 HTTP。

關鍵路徑

用途 路徑
IPC 前端入口 src/api/tauri.ts
應用狀態 src/app/useOverlayData.ts
Tauri 命令 src-tauri/src/lib.rs
日誌監聽 src-tauri/src/watcher.rslog_parser.rs
區域提示 src-tauri/src/area_hints.rsdata/areas.json
BD 資料(Overlay 只讀) docs/BUILD_JSON.mddata/build/
Sprint / task docs/SPRINTS.mddocs/sprints/
型別 src/types.ts

Read the full file on GitHub · 98 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 5d ago First seen · 98 lines · 1,951 tokens per session scan A e001ec741317

Subscribe to this mod's changes

POE2Overlay AGENTS.md is an instructions file published in the GitHub repository yuz9610/POE2Overlay (9 stars, last pushed 3mo ago), licensed MIT. It adds 1,951 tokens to every session, about $0.0098 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other instructions, from other repositories

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens