jahro-watcher

Files (1)

• SKILL.md

SKILL.md (first lines)

# Jahro Watcher

Help users monitor game variables in real-time using Jahro's `[JahroWatch]` attribute system.

## Workflow

1. **Analyze** the user's code — identify fields/properties worth monitoring
2. **Generate** correct `[JahroWatch]` attributes
3. **Add registration** if needed (instance members require `RegisterObject`)
4. **VERIFY** — "Enter Play Mode, open the Watcher tab, confirm values update"

## Analyzing Code for Watcher Candidates

When the user shares a class, identify members worth monitoring:

**Good candidates:**
- Game state fields: health, score, level, currency, inventory counts
- Physics values: velocity, position, rotation (especially via properties wrapping Rigidbody)
- Performance metrics: FPS, memory, draw calls
- Enum state fields: game state, player state, AI state
- Key counters: enemy count, player count, item count

**Skip these:**
- Constants and readonly compile-time values
- Private implementation details that change every frame with no debugging value
- References to other objects (Transform, GameObject) — watch their properties instead
- Collections and dictionaries (arrays are supported, but dictionaries are not)

**Suggest replacing Debug.Log polling:**
If the user has `Debug.Log($"Health: {health}")` in `Update()`, recommend `[JahroWatch]` instead — it eliminates log spam and provides a clean real-time dashboard.

## Attribute Syntax

```csharp
[JahroWatch("Display Name", "GroupName", "Description for detail modal")]
```

Constructor: `[JahroWatch(string name, string group, string description)]`

All parameters are optional. Defaults: name = member name (leading `_` stripped), group = "Default", description = "".

### Complete example

```csharp
using JahroConsole;
using UnityEngine;

public class PlayerController : MonoBehaviour
{
    [JahroWatch("Health", "Player", "Current hit points")]
    public float health = 100f;

    [JahroWatch("Stamina", "Player", "Current stamina")]
    public float stamina = 50f;

    [JahroWatch("Position", "Player", "World position")]
    public Vector3 Position => transform.position;

    [JahroWatch("Velocity", "Player", "Movement velocity")]
    public Vector3 Velocity => GetComponent<Rigidbody>().velocity;

    [JahroWatch("Is Grounded", "Player", "Touching ground")]
    public bool isGrounded;

    void OnEnable()  => Jahro.RegisterObject(this);
    void OnDisable() => Jahro.UnregisterObject(this);
}
```

## Registration

### Instance members — require RegisterObject

```csharp
void OnEnable()  => Jahro.RegisterObject(this);
void OnDisable() => Jahro.UnregisterObject(this);
```

This same call also registers `[JahroCommand]` attributes on the class. If the class already has `RegisterObject` for commands, do not add a second call — one call handles both.

Read `references/common-patterns.md` for the canonical lifecycle pattern.

### Static members — no registration needed

Static fields and properties with `[JahroWatch]` are discovered via assembly scanning:

```csharp
public static class GameStats
{
    [JahroWatch("Total Score", "Game")]
    public static int Score;

    [JahroWatch("Session Time", "Game")]
    public static float SessionTime => Time.realtimeSinceStartup;
}
```

### Adding watchers to a class that already has commands

If the class already has `[JahroCommand]` attributes and `RegisterObject`, just add `[JahroWatch]` attributes — no registration changes:

```csharp
public class GameManager : MonoBehaviour
{
    // Existing command
    [JahroCommand("reset-game", "Game", "Reset game")]
    public void ResetGame() { /* ... */ }

    // New watchers — just add attributes
    [JahroWatch("Player Count", "Game")]
    public int playerCount;

    [JahroWatch("Game Time", "Game")]
    public float gameTime;

    // Already present — no changes needed
    void OnEnable()  => Jahro.RegisterObject(this);
    void OnDisable() => Jahro.UnregisterObject(this);
}

From jahro-console/unity-agent-skills, MIT.

More from jahro-console/unity-agent-skills