diff options
| author | Alex Pooley (@zuedev) <zuedev@gmail.com> | 2026-06-12 00:21:20 +0100 |
|---|---|---|
| committer | Alex Pooley (@zuedev) <zuedev@gmail.com> | 2026-06-12 00:21:20 +0100 |
| commit | a107216a273463f7848f066f42a5937196f19f3c (patch) | |
| tree | bd7da2bc67a7d5c1c03fce2adc89ddd4f855817d | |
| parent | 2ed624552f7808edb7561072a7922ed4495c6c06 (diff) | |
| download | VRCog-a107216a273463f7848f066f42a5937196f19f3c.tar VRCog-a107216a273463f7848f066f42a5937196f19f3c.tar.gz VRCog-a107216a273463f7848f066f42a5937196f19f3c.tar.bz2 VRCog-a107216a273463f7848f066f42a5937196f19f3c.tar.xz VRCog-a107216a273463f7848f066f42a5937196f19f3c.zip | |
add install instructions, tool docs, requirements, and license note
| -rw-r--r-- | README.md | 49 |
1 files changed, 48 insertions, 1 deletions
@@ -2,4 +2,51 @@ > The missing gear in your VRChat workflow.
-VRCog is a collection of Unity editor utilities built for VRChat creators. Whether you're rigging avatars, polishing worlds, or just tired of repetitive editor busywork, VRCog adds the tools Unity forgot - so you can spend less time fighting the editor and more time creating.
\ No newline at end of file +VRCog is a collection of Unity editor utilities built for VRChat creators. Whether you're rigging avatars, polishing worlds, or just tired of repetitive editor busywork, VRCog adds the tools Unity forgot - so you can spend less time fighting the editor and more time creating.
+
+## Installation
+
+VRCog is distributed as a [VPM](https://vcc.docs.vrchat.com/) package. You need the [VRChat Creator Companion](https://vrchat.com/home/download) to install it.
+
+1. Click **Add to VCC** at [zuedev.github.io/VRCog](https://zuedev.github.io/VRCog), or manually add the listing URL in VCC under **Settings → Packages → Add Repository**:
+ ```
+ https://zuedev.github.io/VRCog
+ ```
+2. Open your project in VCC and enable **VRCog** from the package list.
+3. Unity 2022.3 or later is required.
+
+## Tools
+
+### File Stat Tree
+
+`Tools → VRCog → File Stat Tree`
+
+Audits all assets referenced by a selected hierarchy root and sorts them by on-disk file size, so the biggest contributors are easy to spot at a glance.
+
+- Collects materials, textures, and meshes (including skinned meshes and particle system meshes) from all renderers under the target object
+- Groups sub-assets by source file so each FBX or texture atlas is counted once, not once per sub-asset
+- Shows asset type alongside each entry
+- Results persist across domain reloads and play mode
+
+> **Note:** Sizes reflect on-disk file size, not runtime memory (VRAM). For accurate memory figures, use Unity's [Memory Profiler](https://docs.unity3d.com/Packages/com.unity.memoryprofiler@latest) package.
+
+---
+
+### Poiyomi Finder
+
+`Tools → VRCog → Poiyomi Finder`
+
+Scans a hierarchy for renderers using a shader whose name matches a filter string (default: `poiyomi`). Each matching object is listed once with the name of the matched material and shader.
+
+- **Shader Filter** field — change the search term to find any shader by name
+- **Select** — selects and pings the object in the Hierarchy so it's easy to find in collapsed trees
+- **Select All** — selects all matching objects at once for batch operations
+
+## Requirements
+
+- Unity **2022.3** or later
+- VRChat Creator Companion (for installation via VPM)
+
+## License
+
+VRCog is released into the public domain under the [Unlicense](LICENSE). Do whatever you want with it.
|