← All docs

Quick Start

This guide assumes you have already installed Claunity and the desktop app is running. Let's send your first message and execute your first scene action.

Your first message

Open the Claunity panel (Window → Claunity) and make sure you're on the VIBE tab. Type anything into the chat input and press Ctrl+Enter (or click the send button).

Try this as your first message:

What scripts are in this project and what do they do?

Claunity automatically indexes all .cs files in your Assets/ folder and includes them in every request. The AI will list your scripts and explain what each one does — based on your actual code, not a generic answer.

Your first scene action

Claunity can directly modify your Unity scene. Try asking it to create something: 

Create a cube called "Platform" at position (0, -1, 0) and make it look like ground

The AI will respond with an action preview card showing exactly what it's about to do:

ACTIONS TO EXECUTE

· add_primitive → Plane, name: "Platform"

· move_gameobject → position: (0, -1, 0)

· scale_gameobject → scale: (5, 1, 5)

· create_material → "GroundMat", color: #4a7c59

Apply
Cancel

Click Apply and watch the changes happen in your scene instantly. Every action is registered in Unity's Undo system — press Ctrl+Z to reverse it.

Your first script

Ask Claunity to write a script for you:

Write a simple PlayerController script with WASD movement and space to jump. Attach it to a GameObject called "Player".

Claunity will:

  1. Write the complete PlayerController.cs file
  2. Save it to Assets/Scripts/
  3. Trigger a recompile
  4. Attach the script to the Player GameObject
  5. Report back when everything is done

No Player in your scene?

Just say so. Claunity will create a Player capsule first, then write and attach the script. It handles the whole sequence automatically.

Keyboard shortcuts

Shortcut Action
Ctrl + Enter Send message
Enter New line in input
Ctrl + Z Undo last AI scene action
Esc Cancel current action preview

Tips for better results

Be specific

The more context you give, the better the result. Instead of "add a camera", say "add a third-person camera that follows the Player with a slight lag and a distance of 5 units".

Use @ to reference files

Type @ in the chat to open a file picker. Select a script and it's added directly to the context of your message — Claunity reads it before responding. 

@EnemyAI can you refactor the patrol logic to use a state machine?

Ask before you execute

For large changes, ask Claunity to explain the plan first: 

How would you implement a save/load system for this project? Don't write code yet, just explain the approach.

Once you're happy with the plan, say "Go ahead" and it executes everything.

Use Quick Actions for common tasks

The QUICK panel (accessible from the Vibe tab toolbar) has one-click buttons for the most common tasks — look at the scene, fix console errors, review code, and more.

What's next?

You're ready to use Claunity. Explore the modes to see what each one is best for:

← Previous Installation Next → Chat Mode