Documentation Home
This guide covers getting started with PinK, opening projects, working with the Agent, and building for supported platforms. Choose the section that matches your current task.
New to PinK?
Follow these steps to get oriented:
- Read What is PinK? to understand how it relates to COCOS, VS Code, and AI Chat.
- See Download and install PinK for the version that matches your platform.
- Explore the empty workspace in First launch and checks.
- Create a project or open an existing COCOS project.
- Follow Your first AI edit: PinK Demo to see the cycle of analysis, editing, review, running, and building.
Have an existing COCOS project?
You can skip the Demo. Open the project root that contains package.json and assets, wait for assets and scripts to initialize, then go to the section for your current task.
| Your goal | Start here |
|---|---|
| Check the project root and initialization | Open an existing COCOS project |
| Understand projects and workspaces | Projects and workspaces |
| Find assets, hierarchy, scenes, and the Inspector | Editor interface |
| Give Chat context about your project | Provide effective context |
Find a topic by task
| Your goal | Start here |
|---|---|
| Analyze, edit, and troubleshoot with Chat | AI-assisted development |
| Import, preview, and use images | Asset workflow |
| Edit scenes, nodes, and animations | Scenes and animations |
| Read and edit game scripts | Scripting |
| Run a game locally | Run locally |
| Debug on a physical device | Device debugging |
| X-Application | X-Application |
| X-Device | X-Device |
| Build a Unity project for the SUD platform | Build a Unity project for SUD in PinK |
| Install or develop extensions | Extensions |
| Find settings, shortcuts, and troubleshooting help | Reference and support |
Scope of this guide
- For COCOS nodes, components, lifecycle events, and engine APIs, use the official documentation for your project's engine version.
- Platform accounts, certificates, signing, review, and store submission are outside the scope of these build tutorials.
- This guide does not speculate about unpublished accounts, pricing, AI models, or data policies.
- The extension chapters cover the standard VS Code API and public PinK features, not internal APIs.
If you are unsure where to start, read What is PinK?.