|
1 | 1 | # Jahro Unity Plugin |
2 | 2 |
|
3 | | -**Debug, control, and fine-tune your game directly inside the game view.** |
4 | | -Jahro provides powerful tools for Unity Game Creators for debugging, testing, and collaboration. |
| 3 | +**One-click snapshots: logs + screenshot from your Unity game.**<br/> |
| 4 | +From any device → instantly shareable web link.<br/> |
| 5 | +No cables. No Logcat or xcode<br/> |
5 | 6 |
|
6 | 7 |  |
7 | 8 |
|
8 | 9 | --- |
9 | 10 |
|
10 | 11 | | [Website](https://jahro.io) | |
11 | 12 | [Web Console](https://console.jahro.io) | |
12 | | -[Documentation](https://docs.jahro.io) | |
13 | | -[Getting Started](https://docs.jahro.io/start-here/installation) | |
| 13 | +[Documentation](https://go.jahro.io/docs) | |
| 14 | +[Getting Started](https://go.jahro.io/installation) | |
14 | 15 | [Discord](https://discord.gg/txcHFRDeV4) | |
15 | 16 | [UnityForum](https://discussions.unity.com/t/free-debugging-tool-jahro-logs-sync-cheat-console-variables-monitoring-in-game-view/1623617) | |
16 | 17 |
|
17 | 18 | --- |
18 | 19 |
|
19 | | -## Features |
| 20 | +## Core Features |
20 | 21 |
|
21 | | -- **Run Commands/Cheats Console:** <br/> |
22 | | - Execute static/non-static methods inside your game on a target device. |
| 22 | +### **Snapshots** <br/> |
23 | 23 |
|
24 | | -  |
| 24 | +Capture full device logs + screenshots with one click. <br/> |
| 25 | +Share link with your team instantly. |
25 | 26 |
|
26 | | -- **Logs Infrastructure:** <br/> |
27 | | - Collaborate on logs and screenshots with your team for better debugging and session analysis. |
| 27 | + |
| 28 | +<br/> |
28 | 29 |
|
29 | | -  |
| 30 | +### **Commands/Cheats** <br/> |
30 | 31 |
|
31 | | -- **Watch over Variables:** <br/> |
32 | | - Track any variable in your game with the Watcher. From simple primitives to complex objects and game states. |
| 32 | +Expose C# methods with **[JahroCommand]** and run them in-game.<br/> |
| 33 | +Skip levels, grant items, trigger events — without rebuilds. |
33 | 34 |
|
34 | | -  |
| 35 | + |
| 36 | +<br/> |
35 | 37 |
|
36 | | -- **Logs In Game View:** <br/> |
37 | | - See logs directly inside the game. |
| 38 | +### **Watcher** <br/> |
38 | 39 |
|
39 | | -  |
| 40 | +Track any variable in your game with the Watcher. <br/> |
| 41 | +From simple primitives to complex objects and game states. |
40 | 42 |
|
41 | | -- **Mobile and UX Friendly:** <br/> |
42 | | - Jahro designed for mobile games with especial attention to UX. |
| 43 | + |
| 44 | +<br/> |
43 | 45 |
|
44 | 46 | --- |
45 | 47 |
|
46 | 48 | ## Installation |
47 | 49 |
|
48 | | -1. Open **Unity Package Manager**. |
49 | | -2. Click **Add package from Git URL**. |
50 | | -3. Paste the following link: https://github.com/jahro-console/unity-package.git |
51 | | -4. Click **Add** to install the Jahro Unity plugin. |
52 | | -5. Grab your API key from **[Jahro Console](https://console.jahro.io/auth/signup)**. |
| 50 | +1. Open **Unity Package Manager** |
| 51 | +2. Click **Add package from Git URL** |
| 52 | +3. **Paste**: https://github.com/jahro-console/unity-package.git |
| 53 | +4. Click **Add** to install |
| 54 | +5. Get your API key from **[Jahro](https://jahro.io)** |
53 | 55 |
|
54 | 56 | --- |
55 | 57 |
|
56 | 58 | ## Getting Your API Key |
57 | 59 |
|
58 | | -1. Register a free account at **[Jahro Console](https://console.jahro.io/auth/signup)**. |
59 | | -2. Create a project and navigate to the **API Keys** section. |
60 | | -3. Copy the generated API key. |
61 | | -4. In Unity, go to **Tools > Jahro Settings** and paste the API key. |
| 60 | +1. Register a free account at **[Jahro](https://jahro.io)** |
| 61 | +2. Create a project and go to **API Keys** |
| 62 | +3. Copy the key and paste it in **Tools > Jahro Settings** |
62 | 63 |
|
63 | 64 | --- |
64 | 65 |
|
65 | 66 | ## Docs Section |
66 | 67 |
|
67 | | -Read the docs to learn how to use Jahro in your Unity project. |
| 68 | +Learn how to use Jahro in your Unity project: |
68 | 69 |
|
69 | | -- **[Commands](https://docs.jahro.io/start-here/commands)** |
70 | | -- **[Logs](https://docs.jahro.io/start-here/logs)** |
71 | | -- **[Watcher](https://docs.jahro.io/start-here/watcher)** |
72 | | -- **[Snapshots: Logs & Screenshots](https://docs.jahro.io/start-here/snapshots)** |
| 70 | +- **[Snapshots](https://go.jahro.io/snapshots)** |
| 71 | +- **[Commands](https://go.jahro.io/commands)** |
| 72 | +- **[Watcher](https://go.jahro.io/watcher)** |
| 73 | +- **[Logs](https://go.jahro.io/logs)** |
73 | 74 |
|
74 | 75 | --- |
75 | 76 |
|
76 | 77 | ## Useful Links |
77 | 78 |
|
78 | | -- **Documentation:** [Read Docs](https://docs.jahro.io) |
| 79 | +- **Documentation:** [Read Docs](https://go.jahro.io/docs) |
| 80 | +- **Roadmap:** [Roadmap](https://jahro.io/roadmap) |
79 | 81 | - **Community Discord:** [Join Here](https://discord.gg/txcHFRDeV4) |
80 | 82 | - **Home Website:** [https://jahro.io](https://jahro.io) |
81 | 83 | - **Report an Issue:** [GitHub Issues](https://github.com/jahro-console/unity-package/issues) |
82 | | - |
83 | | ---- |
84 | | - |
85 | | -## How to Support Jahro |
86 | | - |
87 | | -We just started and working hard to make Jahro the best debugging tool for Unity. |
88 | | -You could help us with feedback, feature requests, or sharing to your friends. |
89 | | - |
90 | | ---- |
91 | | - |
92 | | -## Feedback |
93 | | - |
94 | | -We’re very open to feedback! Let us know how we can improve and help us make Jahro even better. Reach out via: |
95 | | - |
96 | | -- **Feedback:** [Feedback Form](https://tally.so/r/wLaVRO) |
97 | | -- **Discord:** [Join our Community](https://discord.gg/txcHFRDeV4) |
98 | | -- **GitHub Issues:** [Report an Issue](https://github.com/jahro-console/unity-package/issues) |
99 | 84 | |
100 | 85 |
|
101 | 86 | --- |
102 | 87 |
|
103 | 88 | ## License |
104 | 89 |
|
105 | | -- This plugin is distributed under a **[custom license](https://github.com/jahro-console/unity-package/blob/main/LICENSE.md)**. Please review the license before using the plugin. |
106 | | -- ©️ Copyright 2025 Oleksii Bulat. All rights reserved. |
| 90 | +This plugin is distributed under a **[custom license](https://github.com/jahro-console/unity-package/blob/main/LICENSE.md)** <br/> |
| 91 | +© 2025 Oleksii Bulat. All rights reserved. |
0 commit comments