Skip to content

FahadAkash/UniViwer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🎯 UniViewer - Script UML & Folder Analysis for Unity

UniViewer Logo

UniViewer is a powerful Unity Editor extension that helps you analyze and visualize your C# scripts in a UML-like structure. With intuitive folder selection, script dependency mapping, and a sleek UI for browsing your project’s class hierarchies, UniViewer makes understanding your codebase easier than ever.


🚀 Features

  • 📂 Drag & Drop Folder Selection
    Easily select folders to scan your scripts with an attractive, user-friendly interface.
  • 📝 UML Viewer
    Visualize classes, methods, fields, properties, and dependencies in a clear, interactive layout.
  • 📁 Folder Tree View
    Organize and browse scripts based on their directory structure.
  • 🔍 Zoom & Search
    Quickly locate specific scripts or classes using built-in search and zoom controls.
  • 📦 Unity Package Manager Integration
    Install UniViewer directly from GitHub via the Package Manager.
  • ⚡ UnityPackage Provided
    You can also install using the provided .unitypackage file for quick setup.

📦 Installation

📌 Via Unity Package Manager

  1. Open your Unity Project.

  2. Open the Package Manager(Window → Package Manager).

  3. Click the "+" button in the upper left corner and select "Add package from git URL...".

  4. Paste the following URL into the prompt and click Add: https://github.com/FahadAkash/UniViewer.git

  5. UniViewer will be added to your project as a package.


📌 Via UnityPackage (Manual Installation)

  1. Download the latest .unitypackage release from the Releases page.
  2. Open Unity and go to Assets → Import Package → Custom Package...
  3. Select the downloaded .unitypackage file and click Import.

🎮 Usage

1️⃣ Open the Folder Selector Window

  • Navigate to Window → Folder Selector in Unity Editor.
  • Drag and drop folders that contain your C# scripts.
  • Click Process Scripts to analyze the selected scripts.

2️⃣ Explore the UML Viewer

  • The UML Viewer window will open after processing.
  • Expand and collapse classes to inspect their methods, fields, and dependencies.
  • Use Zoom & Search to quickly locate specific scripts.

3️⃣ View the Folder Structure

  • Switch to the Folder Tree tab to see how scripts are organized.
  • Easily locate scripts based on their directory paths.

🖥️ Screenshots

📌 Folder Selector

Folder Selector

📌 UML Viewer

UML Viewer

📌 Folder Tree View

Folder Tree


🤝 Contributing

We welcome contributions! 🎉

To contribute to UniViewer, follow these steps:

  1. Fork the repository.
  2. Create a new branch:
git checkout -b feature/your-feature-name

3 . Make your changes and commit:

git commit -m "Added a cool new feature"

4 . Push to your branch:

git push origin feature/your-feature-name

5 . Submit a Pull Request!

📜 License
This project is licensed under the MIT License.
Feel free to use, modify, and distribute.

📬 Contact GitHub: FahadAkash

Email: [email protected]

Website: fahadakash.com

Discord Community: Join Here

Made with ❤️ by [Fahad Akash] Happy Coding! 🚀