aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 27280a4e1c7959ee6f5d59bdd12ca60f6bb0fc59 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# VRCog ⚙️

> 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.

## 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.