Skip to content

Closed #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
aleksimunter wants to merge 1 commit into from
Closed

Closed #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions .github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ For Visual Studio, see [Manual install](#manual-install).

Each agent surfaces an installed plugin differently.

**Claude Code** — type `/unity:` and the skills appear in the command list. `/plugin`
**Claude Code** — type `/unity:` and `/unity:using-unity` appears in the command list. `/plugin`
also shows `unity` as installed and enabled.

**Codex** — run `codex plugin list`:
Expand All @@ -81,8 +81,8 @@ PLUGIN STATUS VERSION
unity@unity-agent-plugin installed, enabled 0.1.9-beta
```

**Grok**: type `/` and the skills appear in the slash menu. Grok uses the plain skill
name, and switches to the plugin-qualified form (`/unity:ui-uitk`) when another
**Grok**: type `/` and `using-unity` appears in the slash menu. Grok uses the plain skill
name, and switches to the plugin-qualified form (`/unity:using-unity`) when another
installed skill shares the same name. `grok plugin list` shows `unity`, and
`grok plugin details unity` lists what it provides.

Expand All @@ -99,11 +99,11 @@ Installed plugins:
• unity@unity-agent-plugin (v0.1.9-beta)
```

`copilot skill list` lists the Unity skills under "Plugin skills".
`copilot skill list` lists `using-unity` under "Plugin skills".

### Manual install

If you can't use the marketplace commands, clone the repo and link each skill into your personal skills directory. Run this from the folder you want the clone in:
If you can't use the marketplace commands, clone the repo and link its skill into your personal skills directory. Run this from the folder you want the clone in:

```bash
git clone https://github.com/Unity-Technologies/unity-agent-plugin.git
Expand Down Expand Up @@ -135,8 +135,8 @@ for d in "$PWD"/skills/*; do ln -sfn "$d" ~/.copilot/skills/"$(basename "$d")";
```

Copilot also reads `~/.claude/skills` and `~/.agents/skills`, so skip this if you
already linked the skills for Claude Code or Codex. On Windows, copy each skill folder
into `%USERPROFILE%\.copilot\skills` instead.
already linked the skill for Claude Code or Codex. On Windows, copy the `skills/using-unity`
folder into `%USERPROFILE%\.copilot\skills` instead.

The skills load in every project from your next session onward. To update them, run `git pull` in the clone. Skills installed this way don't appear under a `unity:` prefix, because they aren't installed as a plugin.

Expand All @@ -161,12 +161,19 @@ do something in your Unity project. For example:
>
> "Review my ScriptableRendererFeature for Render Graph problems"

In Claude Code, Grok and Antigravity the skills also appear in the slash menu, so you can pick one
explicitly instead of describing the task.
The plugin installs one skill, `using-unity`, which lists every Unity skill with what it's for.
Your agent reads that list, picks the skill that fits your request, and follows it. In the slash
menu of Claude Code, Grok and Antigravity it appears as `/unity:using-unity`; the individual
skills don't have their own slash commands.

To pick individual skills from the slash menu instead, install them one by one from
[Unity-Technologies/skills](https://github.com/Unity-Technologies/skills) with
`npx skills add Unity-Technologies/skills`. If you install both, your agent can reach each
skill twice.

For what each skill covers and how to prompt it, see
[About Unity's plugin](https://docs.unity.com/en-us/ai/unity-plugin/about-unity-plugin),
or browse the [skills folder](../skills/).
or browse the [skills](../skills/using-unity/references/).

## Works best with the Unity CLI

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Unity's official plugin for coding agents, with curated skills for game developm

The skills give your agent Unity's documented practices for everyday work: starting a project, managing packages,
building UI with UI Toolkit, uGUI or IMGUI, 2D sprites and tilemaps, physics, audio, localization, URP rendering and
post-processing, Shader Graph, multiplayer services, Vivox voice chat, in-app purchases and LevelPlay ads. The agent loads
a skill only when your request needs it.
post-processing, Shader Graph, multiplayer services, Vivox voice chat, in-app purchases and LevelPlay ads. The plugin
installs one skill, `using-unity`, which lists them all; the agent reads only the skill your request needs.

Install steps and usage are in the
[full README](https://github.com/Unity-Technologies/unity-agent-plugin#readme).
Loading