illusionmods/koikatsumoddingtools

1. This repository is a Unity 5.6.2 editor project, not a game runtime by itself. Its purpose is to author Koikatsu mod assets and package them into the formats the game expects, mainly asset bundles and zipmods.

2. The architecture is split into three main boundaries: editor-time tooling under Assets/Editor and Tools, reusable mod/runtime components under Assets/Scripts and Assets/AmplifyColor, and content templates/examples under Assets/Examples. The examples show the expected file layout for real mods.

3. The build pipeline is centered on Unity asset import and export. Authors place textures, meshes, prefabs, manifests, and list files inside the Assets/Mods area or base an item on one of the example folders, then use the Unity AssetBundle Browser to build bundles and zipmods. The repo is structured so only content under Mods is treated as custom output, keeping examples separate.

4. Assets/Editor contains the repo’s main automation layer. It includes asset-bundle/zipmod utilities, manifest and list-file editors, texture postprocessing, FBX postprocessing, and custom inspectors for the mod component types. These scripts are responsible for turning raw Unity assets into Koikatsu-compatible package contents.

5. Import postprocessors are important to the workflow. The repository automatically adjusts imported meshes and textures: FBX assets can have excess bones removed and layers reassigned, while normal maps are converted to the red-transparent style expected by the target game ecosystem. This is one of the key “pre-export” data transformations in the project.

6. Tools/SB3UGS is an external packaging and replacement tool bundled with the repo. It is used after asset bundles are built to swap placeholder shaders back to game shaders and to support the zipmod workflow. That makes SB3UGS part of the release pipeline even though it is not Unity code.

7. The shader architecture is layered. Assets/Shaders contains the project’s custom and placeholder shaders, including many Koikatsu-specific shader variants, while Assets/ShaderForge and Assets/AmplifyColor provide editor tooling and reusable shader assets. The README makes clear that placeholder shaders are used in edit mode and later replaced for final builds.

8. The runtime-facing mod components live in Assets/Scripts. These include character-facing components for clothes, accessories, custom hair, foreground items, particles, and item logic, plus map/scene-related components such as gates, H-points, map visibility, lighting, reflection, and mini-map support. These scripts define the data that the editor tools serialize into mod content.

9. Character and facial systems are a distinct subsystem. Scripts such as FaceBlendShape, EyeLookController, EyeLookCalc, FBSBlinkControl, and the various FBSCtrl* classes handle eye movement, blinking, eyebrows, mouth, and other face-driven behaviors. These are separate from packaging and are focused on in-game appearance/animation behavior.

10. And scene support is another major subsystem. The Assets/Scripts/Map folder includes map metadata, lighting, background parameters, H-point data, gate grouping, reflection, sun shafts, and gizmo visualization. The Assets/Examples/Map Example folder mirrors this with prefabs, lighting data, reflection probes, and map CSVs, showing the intended content model.

11. VR support is included as a self-contained group under Assets/Scripts/VR. It contains VRPoint plus a set of VRTK interaction scripts, indicating the project can author content that participates in VR interaction and snap/attach behavior. This is a separate interaction boundary from standard character or studio items.

12. Preview and visualization assets under Assets/Preview, Assets/Gizmos, and Assets/Common/H Point Selector support authoring rather than runtime delivery. They provide preview scenes, camera/light prefabs, gizmo meshes, and H-point visual markers so creators can inspect content in-editor before packaging.

13. The examples are the clearest architectural documentation in the repo. There are separate example modules for body paint, accessories, accessory hair, clothes, head types, studio items, studio filters, maps, shader editing, and asset overrides. Each example contains its own manifest, list files, textures, meshes, materials, prefabs, and readme, showing the canonical artifact graph for each mod type.

14. A notable embedded dependency is Assets/Editor/YamlDotNet, which brings a full YAML serialization library into the editor tooling. This suggests some editor-side config or manifest-related workflows rely on structured serialization rather than hand-authored text alone.