Phantomdocs
Download

llms.txt ​

We don't encourage using AI to write plugins, but a lot of people do anyway, so here's a file that gives your tool what it needs to know about Phantom.

https://docs.phantm.site/llms.txt

It's one plain text file covering the await rule, the package shape, permissions, what a plugin can wait for, the entry file, the components, Flash access and the usual mistakes. After that comes an index: every SDK area with its call count and page, every packet category, and every page of these docs with a line on what's in it. It names each area and links its page rather than including all 3291 signatures, so it stays short enough to read in full.

The lists and counts in it are filled in from the SDK, the permission table, the manifest schema and @phantomclient/plugin/vue each time the docs build, so they match the current release.

Use it ​

Give it to the assistant before asking for a plugin:

Read https://docs.phantm.site/llms.txt, then write me a Phantom plugin that ...

If your tool can't fetch a URL, paste the file in. For a tool that reads your repository, save it at the root of the plugin as AGENTS.md, CLAUDE.md or whatever your tool reads.

Common mistakes it covers ​

  • Reading a value instead of calling it. A script reads phantom.aj.room.current as a property, but a plugin has to await the call. Written as a property in a plugin it still type-checks, because .name exists on every function, and quietly gives you the string "current" instead of the room's name. See Getting started.
  • Old permissions. permissions.sdk and "flash": true are gone. Ask for "game": "read" or "act", and "packets": "read" or "send", with no command lists. A manifest with the old ones is refused with the line to write instead. See Permissions.
  • Reading the game in setup too early. setup runs long before the game has loaded, so a setup that reads the HUD finds nothing. Declare what the game must have reached.
  • Hooking Flash for something the SDK has. The SDK covers 53 areas of the game. Check it before reaching for phantom.flash. When Flash really is the answer, see Reading the client.