advjs AGENTS.md

Project instructions for ADV.JS, a Vue 3 and TypeScript engine for adventure or visual-novel games that uses Markdown files for dialogue and scenes.

In plain words
What is it for?
Installing dependencies, building, developing, linting, type-checking, running unit or end-to-end tests, and working on the demo or editor.
Why use it?
It gives an agent the project’s structure, package-manager choice, common commands, and ways to run tests or work on specific packages.

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/yunyoujun/advjs/agents-md
Clone the repo
git clone --depth 1 https://github.com/YunYouJun/advjs

Made for: Codex, OpenCode.

Per session 1,184 This file is loaded in full into every session.
When invoked 1,184 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 $0.01184 $0.01184
Opus 5 $0.00592 $0.00592
Sonnet 5 $0.00237 $0.00237
Haiku 4.5 $0.00118 $0.00118

Measured 2d ago against content hash 974ca3176dbc, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

advjs 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 2d 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 · 103 lines

How it starts

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

AGENTS.md

This file provides guidance to Codex (Codex.ai/code) when working with code in this repository.

Project Overview

ADV.JS is a front-end ADV (Adventure/Visual Novel) game engine built with Vue 3, Vite, and TypeScript. It uses a Markdown-based scripting language (.adv.md) parsed into an AST for game dialogue and scenes. Licensed under MPL-2.0.

Common Commands

pnpm install                    # Install dependencies (pnpm only, enforced via preinstall)
pnpm build                      # Build all packages (packages/* only)
pnpm dev                        # Dev mode for all packages + plugins in parallel
pnpm lint                       # ESLint (uses @antfu/eslint-config with UnoCSS + formatters)
pnpm test                       # Run unit tests with Vitest (jsdom environment)
pnpm e2e                        # Run Playwright e2e tests
pnpm e2e:ui                     # Playwright e2e with interactive UI
pnpm typecheck                  # vue-tsc type checking

# Run a single unit test file
pnpm vitest run tests/unit/basic.test.ts

# Dev specific packages
pnpm demo                       # Run demo/starter dev server
pnpm editor                     # Run editor dev server
pnpm play                       # Run playground dev server
pnpm docs                       # Run docs dev server

Build Order

Packages have dependencies that require ordered builds: @advjs/types@advjs/assets / @advjs/parser@advjs/coreadvjs

Use pnpm build:advjs to build the full chain in order.

Monorepo Architecture

Managed with pnpm workspaces. Dependency versions use pnpm catalogs (defined in pnpm-workspace.yaml).

Key Packages (packages/)

  • @advjs/types — Shared TypeScript type declarations for the entire project
  • @advjs/assets — Platform-neutral asset catalog and authoring workflow primitives
  • @advjs/parser — Markdown-to-AST parser using unified/remark ecosystem. Parses .adv.md files into a structured AST for the game engine
  • @advjs/core — Core engine library: game engine runtime, session management, i18n, VRM model support
  • @advjs/agent — Private workspace module for Studio agent contracts, managed transport, task state, capabilities, and proposal review; BYOK remains an explicit dev-only subpath
  • advjs — Main entry package with CLI (adv binary), Vite plugin integration, node/client split architecture, theme resolution
  • @advjs/client — Vue 3 client app: pages, layouts, components, composables, Pixi.js integration
  • @advjs/gui — GUI components (publishable)
  • @advjs/shared — Shared utilities between node and client
  • @advjs/vite-plugin-adv — Vite plugin for ADV.JS
  • @advjs/flow — Visual flow/node editor using Vue Flow

Read the full file on GitHub · 103 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. 2d ago First seen · 103 lines · 1,184 tokens per session scan A 974ca3176dbc

Subscribe to this mod's changes

advjs AGENTS.md is an instructions file published in the GitHub repository YunYouJun/advjs (324 stars, last pushed 13d ago), licensed MPL-2.0. It adds 1,184 tokens to every session, about $0.0059 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-30.