Introduction

Phantom is a desktop app for playing Animal Jam Classic. It runs the same game client as the official launcher, with extra things around it: several accounts open at once, TypeScript scripts against the running game, and plugins you can install from the store.

PlayInstall Phantom, add your Animal Jam accounts and open a game.Script the gameWrite TypeScript against a game you have open.Build a pluginPanels, pages and commands other players can install.

Your Animal Jam account is your responsibility

Phantom isn't made by, affiliated with or endorsed by Animal Jam or WildWorks. Any third-party tool puts your account at risk, and anything that plays for you puts it at more.

Using the app

Scripts and Playbooks both make the game do things without a plugin: scripts are code, and playbooks are steps you can read before they run.

Where things areTabs, the tools for each game, the dock and the canvas.ScriptsTypeScript run against one game or all of them.PlaybooksAutomation built from steps, with a plan you check before it runs.RecordingsSave a game's recent packets, read them back or play them into a game.Plans and your accountPrices, what stops when a plan ends, and offline use.CommunityShared rooms, the rules, and hiding or reporting someone.

Building a plugin

A plugin is a small web app that runs next to the game in its own frame. It talks to the game through the same SDK scripts use, limited to the permissions the player gave it. Read these in order.

Getting startedMake a plugin with one command, and what each file is for.The dev loopRun your plugin in Phantom and reload it as you work.What a plugin addsPanels, pages, canvas widgets, commands, preferences and storage.PermissionsWhat each permission allows, and how risky it is to ask for.Building UI with VuePhantom's components and composables, with live previews.

Working with the game

Scripts and plugins reach Animal Jam through the SDK. For anything the SDK doesn't cover, you can call into the game client directly.

OverviewGuides for each part of the SDK, from rooms to trading.Custom roomsBuild a room from your own art and send the player into it.Real-time channelsCopies of your plugin on other computers, talking to each other.The game clientAny class, method or field in the running client, private ones too.

Reference

The SDK and packet pages are generated from the code when the site builds. The manifest and CLI pages are written by hand and checked by tests against what Phantom actually does.

The SDKEvery call, with its parameters, types and permission.PacketsThe messages the game and the server send, field by field.The manifestEvery field of the phantom block in a plugin's package.json.The CLIRun, build, check, pack and publish a plugin from a terminal.

We don't encourage AI tools, but if you use one, give it llms.txt first.

Can't find what you need? Ask on phantm.site/support.