advjs: Instructions file for Codex

AGENTS.md

advjs AGENTS.md is an instructions file for Codex, OpenCode from YunYouJun/advjs. It costs 1,783 tokens per session, scanned A, original, MPL-2.0.

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

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md; mentions Codex.

This is YunYouJun/advjs's own configuration. It tells Codex and OpenCode how to work on advjs itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything advjs configures →

Reuse

Borrowing it

Nothing to install: this file belongs to YunYouJun/advjs. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/YunYouJun/advjs/dev/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/YunYouJun/advjs

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 advjs AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/yunyoujun/advjs/agents-md/github.svg)](https://agentmods.dev/instructions/yunyoujun/advjs/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/yunyoujun/advjs/agents-md"><img src="https://agentmods.dev/badge/instructions/yunyoujun/advjs/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for advjs AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/yunyoujun/advjs/agents-md"><img src="https://agentmods.dev/badge/instructions/yunyoujun/advjs/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,783 This file is loaded in full into every session.
When invoked 1,783 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.01783 $0.01783
Opus 5.5 $0.00713 $0.00713
Sonnet 5.5 $0.00357 $0.00357
Haiku 4.5 $0.00178 $0.00178

Measured 12d ago against content hash d82d58fe6f2b, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 12d 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 · 125 lines

How it starts

The opening of the file, as written. The whole thing — 125 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/runtime/core-runtime-entry.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/core → advjs

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 · 125 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. 12d ago Changed · +3 tokens per session d82d58fe6f2b
  2. 13d ago Changed · +6 lines · +163 tokens per session bd1850b4e337
  3. 15d ago Changed · +2 lines · +54 tokens per session 563168e5d053
  4. 16d ago Changed · +14 lines · +379 tokens per session 88c2dbe9a616
  5. 1mo 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 (328 stars, last pushed today), licensed MPL-2.0. It adds 1,783 tokens to every session, about $0.0071 per session on Opus 5.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.

Related

Other instructions, from other repositories

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 · 9,649 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,384 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens