Unity Plugin Overview

Jahro's Unity package integrates directly into your development workflow, providing real-time debugging capabilities without disrupting your game. This overview helps you understand the core concepts and find the right documentation for your needs, from getting started to advanced API integration.

Core concepts

Snapshots

Snapshots combine logs and screenshots into shareable links for team collaboration. Use Recording or Streaming modes depending on your workflow needs, then view them in the web console.

Read: Snapshots

Commands

Commands let you execute debug actions and cheats directly in your Unity builds. Add [JahroCommand] to methods or register dynamically via Jahro.RegisterCommand(...). Run in Text mode or Visual mode with autocomplete, parameters, and overload resolution.

Read: Commands & Cheats

Watcher

Watcher provides real-time monitoring of game variables without debug logs. Add [JahroWatch] to fields/properties. For instance members, call Jahro.RegisterObject(this) in OnEnable and UnregisterObject in OnDisable. Use the Watcher UI for optimal variable management.

Read: Watcher

Logs

All Unity logs (debug, warnings, errors) plus command outputs appear in the console with filtering and search capabilities. View logs directly in your game view without leaving the game.

Read: Logs

The UI

Jahro's interface consists of a Launch Button that's draggable, persists position, shows notifications, and can be hidden or disabled.

The Main Window is resizable with multiple modes: Text, Visual, Watcher, Snapshots, Account, and Settings.

The interface is responsive and mobile-friendly, working with touch gestures, supporting fullscreen mode, respecting safe areas, and providing a tight layout for narrow widths.

Read: UI Overview, Text Mode, Visual Mode, Watcher UI

Settings and lifecycle

Configure Enable/Disable, auto-disable for release builds, hotkeys, mobile triple-tap, and assemblies scanning in Tools → Jahro Settings. This ensures Jahro behaves exactly how you need it for your development workflow.

Ensure Jahro stays out of production with auto-disable or JAHRO_DISABLE define, and understand the startup and release flow for proper integration.

Read: Jahro Settings, Disable in Builds & Lifecycle

Runtime API (highlights)

From JahroConsole.Jahro, you can access state properties like Enabled, IsOpen, and IsLaunchButtonEnabled. Control the console with Show/Close methods, manage the launch button with Enable/Disable/Show/Hide methods, and register/unregister objects and commands by name or delegate.

Events like OnConsoleShow and OnConsoleHide let you integrate Jahro into your existing systems.

Read: API Reference (Unity)

Next steps

Start building your debugging workflow by creating your first cheats via [JahroCommand] and favoriting them in Visual mode. Add critical variables with [JahroWatch] and mark them as favorites for quick access. Stream a Snapshot from device testing and share the link with your team for collaborative debugging.

For detailed implementation, check out the API Reference and configure your setup with Jahro Settings.