NoaCG Broadcast Graphics and Playout

io.github.NoaCGv0.7.1更新于 Oct 2, 2026

Make broadcast graphics for NoaCG Studio and play them out live on CasparCG, OBS, vMix or OGraf.

概览

AI 生成的概览

让助手搭建、校验、截图、打包并保存 NoaCG 播出图形,并可输出到 CasparCG、OBS、vMix 或 OGraf。

功能
只暴露一个 MCP 工具 noacg,其 command 参数选择动词,如 types、scaffold、validate、inspect、screenshot、docs 或 save,其余参数为该动词的标志。它可以从图形类型或声明的字段生成图形包,运行静态检查加实时运行时测试,并可选生成下播、上播和压力截图,同时报告由图形契约推导出的操作界面。它可以把多个图形打包为一个含图层和可选播出单的包,并把校验通过的图形保存到你的 NoaCG 素材库。技能参考文本也以 noacg://docs/ 资源形式提供。
适用场景
当你希望编码助手为 NoaCG Studio 制作或迭代播出图形,并在上播前检查时使用。它适合需要按图形类型搭建、带截图校验,或把多个图形与提示打包的工作流。它不用于驱动实时播出硬件,那由 MCP 之外的 bridge 和 caspar 命令处理。
运行要求
以 stdio 方式在本地运行的进程,通过 npx -y @noacg/cli mcp 启动,因此需要 Node.js 和网络访问。使用 NoaCG 部署,由 NOACG_URL 指定,默认 NOACG_AGENT_KEY 中提供受限代理密钥。校验和截图需要 Chromium 浏览器,可通过 NOACG_BROWSER 指定,否则使用系统 Chrome/Edge。可选 NOACG_CREDENTIALS_DIR 指定密钥存放目录。
安装前请注意
保存需要通过浏览器授权流程获取的受限代理密钥;该密钥只能在你的素材库中创建图形,可在设置中或用 logout 撤销。NOACG_AGENT_KEY 是供 CI 使用的机密,会覆盖已存储的密钥。save 和 pack --save 会把图形写入你的 NoaCG 素材库或 Home,执行前请确认。bridge 和 caspar 命令会驱动实时播出硬件,未作为 MCP 工具开放。

安装

在 SourceWeft 中

  1. 打开 控制台中的 NoaCG Broadcast Graphics and Playout,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

@noacg/cli

The NoaCG CLI - the agent door into NoaCG Studio. Make broadcast graphics for NoaCG from a coding agent, or from your own terminal: scaffold, validate, inspect, screenshot, package, save - against any NoaCG deployment. The full account is the repo's docs/AGENT_CLI.md.

The package is @noacg/cli; the command it installs is noacg. So npm i -g @noacg/cli gives you noacg validate …, and every command below is spelled the way you will type it.

One tool, three entrances. The MCP server is not a second thing to choose between. noacg mcp runs this same package as an MCP server, and the Claude Code / Codex plugin carries the noacg-graphic skill, which drives this same package from the terminal. Pick the entrance your agent uses -

EntranceForInstall
the pluginClaude Code, Codextwo commands, below - it brings the skill and a command, and runs nothing until a graphic is being made; the optional noacg-mcp plugin adds the always-on MCP server
the MCP serverany MCP clientnpx -y @noacg/cli mcp over stdio
the terminalan agent that runs shell commands, and younpm i -g @noacg/cli

Whichever you pick, the noacg-graphic skill is the same text: what a NoaCG graphic must expose, and the loop to get there. It is the contract, not design guidance.

Connecting NoaCG Playout to a CasparCG server is a different tool, NoaCG Bridge, downloaded from noacg.studio/downloads (the newest Bridge release on the repository's Releases page). It is not about authoring and needs nothing from this package.

Paste this to your agent

The short way in. The agent installs the entrance that matches it, checks the setup, and then asks what to make. It runs a couple of install commands you have to approve.

Set up NoaCG Studio so you can build broadcast graphics for me, then ask me what to make.
1. Install the entrance that matches you. Claude Code:     claude plugin marketplace add NoaCG/NoaCG-Studio     claude plugin install noacg@noacg-studio   Codex:     codex plugin marketplace add NoaCG/NoaCG-Studio     codex plugin add noacg@noacg-studio   Any other agent that speaks MCP: register a stdio server, command "npx", arguments   "-y @noacg/cli mcp". I will approve these commands as you run them.
2. Do not wait for the install. A plugin only loads in your next session, so use   "npx -y @noacg/cli <command>" for everything today, starting with   "npx -y @noacg/cli docs contract" to read what a NoaCG graphic must expose.
3. Verify: "npx -y @noacg/cli doctor" prints the deployment, the browser it will drive and   the bridge version it found. If it does not, tell me what failed and stop.
4. Then tell me in one or two lines that NoaCG is ready, and ask me to describe the graphic   I want.
The loop after that: scaffold or author, "npx -y @noacg/cli validate <dir> --screenshots./shots", fix what it reports, then "npx -y @noacg/cli save <dir>". Saving needs"npx -y @noacg/cli login" once, which opens a browser for me to approve.

The commands it runs are below, for anyone who would rather run them by hand.

Install

npx @noacg/cli doctor                 # no install: runs the published buildnpm i -g @noacg/cli                   # or install it once

Claude Code: the noacg plugin ships the noacg-graphic skill and a /noacg:graphic command, with nothing to install first; the skill runs this CLI from the terminal. The optional noacg-mcp plugin adds the always-on MCP server (cli/plugin-mcp/README.md says what it costs). In a Claude Code session (2.1.275 or later), one command adds the marketplace, asks you to confirm it, and installs:

/plugin install noacg --marketplace NoaCG/NoaCG-Studio

From a terminal or a setup script, the same install is two commands:

claude plugin marketplace add NoaCG/NoaCG-Studioclaude plugin install noacg@noacg-studio

For the MCP server on its own: claude mcp add noacg -- npx -y @noacg/cli mcp.

A plugin installed from this marketplace does not update itself until you say so. Claude Code turns auto-update on only for Anthropic's own marketplaces, so the skill text stays the version you installed. Turn it on once in /plugin, Marketplaces, noacg-studio, Enable auto-update, and new versions arrive at the start of a session. Or update by hand: claude plugin marketplace update noacg-studio && claude plugin update noacg@noacg-studio. noacg doctor names the installed version whenever it is behind the CLI you are running.

Codex: the same plugin, from the same repository. codex plugin add installs the skill, so there is nothing to copy by hand; codex plugin add noacg-mcp@noacg-studio adds the optional always-on server the same way.

codex plugin marketplace add NoaCG/NoaCG-Studiocodex plugin add noacg@noacg-studio

The same goes for Codex, in its own spelling: codex plugin marketplace upgrade noacg-studio && codex plugin add noacg@noacg-studio.

On a Codex without codex plugin, do it the long way instead: copy skill/noacg-graphic/ from this package (or cli/plugin/skills/noacg-graphic/ in the repo) to ~/.codex/skills/noacg-graphic/, then codex mcp add noacg -- npx -y @noacg/cli mcp.

Any MCP client: run npx -y @noacg/cli mcp as a stdio server - command npx, args -y @noacg/cli mcp.

Use

npx @noacg/cli typesnpx @noacg/cli scaffold --type scoreboard --design neutral --name "Football scoreboard" --out ./football-scoreboard#  ...design it: edit football_scoreboard.html, css/template.css, js/template.js ...#  (the html is named after the GRAPHIC, not the folder: the name's spaces become underscores)npx @noacg/cli validate ./football-scoreboard --screenshots ./shotsnpx @noacg/cli inspect ./football-scoreboardnpx @noacg/cli login                  # once per machine: a scoped key that can only create graphics in your librarynpx @noacg/cli save ./football-scoreboard
CommandWhat it does
doctorWhich browser and which NoaCG deployment (NOACG_URL) this tool will use, the bridge version it found, and whether a key is held - plus a line for an installed plugin whose skill is behind this CLI, and one for a CLI behind npm's latest. Both silent when there is nothing to update.
typesThe graphic types the deployment knows: fields, operator events, designs, neutral scaffold.
scaffold --type <id> [--design <id>|neutral] [--name N] [--set key=value]... --out <dir>A complete, valid package from a type: a catalog chassis or the NEUTRAL scaffold (fields, machine, controls and runtime on a plain spine).
scaffold --fields "Label:kind[=value],..." [--name N] --out <dir>A typeless graphic with exactly the fields you declare.
validate <dir|zip> [--no-bench] [--no-house-contract] [--screenshots <dir>]The static gate + the live runtime bench, every finding as a teaching line, readiness rows, optional off/on-air/stress frames - and the package's generated half regenerated from the sources. Third-party OGraf packages: manifest conformance + a host-driven lifecycle check.
inspect <dir|zip>The operator surface NoaCG derives from the graphic's own contract (inputs, buttons, steps).
screenshot <dir|zip> --state off|onair|stress --out <png>One transparent frame.
pack <dir|zip>... --name N [--save] [--out <file.noacgpack.json>] [--rundown <cues.json>] [--layer n]...Several graphics as ONE package - layers plus an optional rundown of cues. --save validates them and sends the package to your NoaCG Home, where it waits on Home → Productions with an Install button that creates the production; --out writes it as a file for the Import a package card.
docs [topic]The skill's reference texts.
mcpThe same verbs as an MCP server over stdio.
login [--name N] [--no-browser] [--key <noacg_ak_…>]Get a scoped agent key for this machine: opens the NoaCG consent page, receives a one-time code on a loopback listener, redeems it. The key can only create graphics in your library; revoke it in Settings → Account → Agent access or with logout. NOACG_AGENT_KEY for CI.
logout [--local] / whoamiRevoke + forget this machine's key / show which key is held and whether it is still valid.
save <dir|zip> [--name N] [--folder F] [--no-bench]Validate (gate + bench), refuse on errors, then put the graphic in your NoaCG library and print its #/graphic/<id> link. Save = the library, never a production.
bridge [--port 8899] [--origin URL]… [--no-open] [--quiet]NoaCG Bridge: hold the AMCP socket a browser cannot, on a loopback-only HTTP surface the NoaCG page speaks the playout protocol to. It opens a link that pairs your browser with one click; binds 127.0.0.1 and refuses anything else; refuses origins that are not your NoaCG. Leave it running. caspar agent is its old name and still runs it.
caspar status|send|play|stop [--server HOST] [--amcp-port 5250]The same AMCP with no browser at all: check a server, send one command, or put a production's output URL on a channel (play --url <output URL> --channel 1 --layer 20).

Add --json to any command for one JSON object on stdout. Exit codes: 0 clean, 1 findings or refused, 2 usage/IO error. Environment: NOACG_URL (default https://noacg.studio; a dev server or self-host works), NOACG_BROWSER (a Chromium executable; otherwise the system Chrome/Edge or a Playwright-installed Chromium is used), NOACG_AGENT_KEY (a key for CI - beats the stored one), NOACG_CREDENTIALS_DIR (the folder login keeps its key in, for more than one login on one account; default the per-user config directory).

The package on disk

<slug>/  SOURCES - edit these                  GENERATED - never edit; `noacg validate` rebuilds them    <slug>.html                            <slug>.ograf.json   the OGraf v1 manifest (+ v_noacg)    css/template.css                       graphic.mjs         the OGraf Web Component    js/template.js                         FIELDS.md  README.md  controlpanel.html    js/gsap.min.js  images/  fonts/

One folder is a valid EBU OGraf v1 Graphic, the SPX/CasparCG package and the workspace you edit. Zip it and it imports through the studio's Import door; drop it in an OGraf renderer and it plays. Those two are what the folder satisfies IN PLACE; the graphic itself is plain HTML, CSS and JS, and NoaCG exports it to an OBS/vMix overlay, H2R or LiveOS from the same sources. In through NoaCG, out to anything.

MCP

The same verbs, spoken over stdio - npx -y @noacg/cli mcp. One tool, noacg, with the terminal's grammar: command is the verb (types, scaffold, validate, inspect, screenshot, docs, save - the last after noacg login) and the other arguments are that verb's flags, so { "command": "validate", "path": "./my-graphic", "screenshots": true } returns the frames as images. The skill's references are also resources (noacg://docs/<topic>). The noacg-graphic skill ships under skill/.

One tool rather than seven because an MCP client puts every tool's schema into the model's context in every session where the server is configured, whether or not that session is about graphics. This shape is about 590 tokens against about 1,160 for the seven-tool one it replaced. The teaching is in the skill, which loads only when a graphic is being made.

bridge and caspar are deliberately not MCP tools: they drive live playout hardware, which is an operator's decision rather than an authoring agent's.

Develop

npm installnpm run build                                # generates the plugin's skill copy, then tscNOACG_URL=http://localhost:5174 npm test     # against a NoaCG dev server's /bridgenpm run check:skill                          # every shipped copy of the skill matches cli/skill/

Licence

Apache-2.0 - deliberately different from NoaCG Studio itself, which is AGPL-3.0-only. This tool is the door into NoaCG for coding agents, so it is licensed to be installed anywhere without a policy review: a permissive licence, an explicit patent grant, no copyleft reaching anything you build with it. The AGPL on the studio protects the hosted application; it was never meant to gate the client that talks to it.

Graphics you create are yours. Nothing in either licence attaches to the templates this tool scaffolds or to what you export and put on air.

One third-party note, since a scaffolded package carries it: the animation runtime bundled into a graphic (js/gsap.min.js) is GreenSock's GSAP, under its own standard licence, not ours. It is not part of this npm package - it arrives inside the graphic your deployment generates.

来源:cli/README.md,提交 d5fcf6f

工具

0
工具元数据尚未被收录。

版本历史

1
  1. v0.7.1最新Oct 2, 2026