|
1 | | -# JahroPackage |
2 | | - |
| 1 | +# Jahro Unity Plugin |
| 2 | + |
| 3 | +**Debug, control, and fine-tune your game directly inside the game view.** |
| 4 | +Jahro provides powerful tools for Unity developers to streamline debugging, testing, and collaboration. |
| 5 | + |
| 6 | +> ⚠️ **Note:** Jahro is currently in **closed alpha**. Public access will be available soon. Stay tuned! |
| 7 | +> |
| 8 | +
|
| 9 | + |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +## Features |
| 14 | + |
| 15 | +- **Available directly inside the game view:** No need to rebuild or leave the editor. |
| 16 | +- **Execute commands and cheats:** Use a visual mode with button clicks or a text mode with autocomplete. |
| 17 | +- **Real-time watch:** Monitor variables or properties in real time during gameplay. |
| 18 | +- **Sync logs and screenshots:** Seamlessly send session logs and snapshots to the web app for analysis or sharing. |
| 19 | + |
| 20 | +--- |
| 21 | + |
| 22 | +## Installation |
| 23 | + |
| 24 | +1. Open **Unity Package Manager**. |
| 25 | +2. Click **Add package from Git URL**. |
| 26 | +3. Paste the following link: https://github.com/jahro-console/unity-package.git |
| 27 | +4. Click **Add** to install the Jahro Unity plugin. |
| 28 | + |
| 29 | +--- |
| 30 | + |
| 31 | +## Getting Your API Key |
| 32 | + |
| 33 | +1. Register an account at **[Jahro Console](https://console.jahro.io)**. |
| 34 | +2. Create a project and navigate to the **API Keys** section. |
| 35 | +3. Copy the generated API key. |
| 36 | +4. In Unity, go to **Tools > Jahro Settings** and paste the API key. |
| 37 | + |
| 38 | +--- |
| 39 | + |
| 40 | +## Getting Started |
| 41 | + |
| 42 | +Jahro offers powerful tools to elevate your game development process: |
| 43 | + |
| 44 | +- **Commands:** Run custom commands or cheats directly inside game view. |
| 45 | +- **Watcher:** Keep track of variables and properties values in real-time. |
| 46 | +- **Logs & Snapshots:** Automatically sync and manage your data in the cloud. |
| 47 | + |
| 48 | +📖 For detailed setup and usage instructions, visit our **[Documentation](https://docs.jahro.io)**. |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +## Useful Links |
| 53 | + |
| 54 | +- **Documentation:** [https://docs.jahro.io](https://docs.jahro.io) |
| 55 | +- **Community Discord:** [Join Here](https://discord.gg/txcHFRDeV4) |
| 56 | +- **Home Website:** [https://jahro.io](https://jahro.io) |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +## License |
| 61 | + |
| 62 | +- 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. |
| 63 | +- ©️ Copyright 2024 Oleksii Bulat. All rights reserved. |
| 64 | +--- |
| 65 | + |
| 66 | +## Feedback |
| 67 | + |
| 68 | +We’re very open to feedback! Let us know how we can improve and help us make Jahro even better. Reach out via: |
| 69 | +- **Discord:** [Join our Community](https://discord.gg/txcHFRDeV4) |
| 70 | +- **GitHub Issues:** [Report an Issue](https://github.com/jahro-console/unity-package/issues) |
| 71 | + |
0 commit comments