Picture examples for FormID merge fix

Mutagen-Modding · May 20, 2024 · 90c6cb5 · 90c6cb5
1 parent d6546d3
commit 90c6cb5
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/docs/images/formid-conflict-tree-fixed.png b/docs/images/formid-conflict-tree-fixed.png
diff --git a/docs/images/formid-conflict-tree.png b/docs/images/formid-conflict-tree.png
diff --git a/docs/merge-conflicts.md b/docs/merge-conflicts.md
@@ -22,5 +22,16 @@ Spriggit comes with tooling to detect and fix these FormID collisions.  It is re
 
 [:octicons-arrow-right-24: CLI Command](cli.md#formid-collision-fixing)
 
+This tool fixes the FormID collisions by modifying one of the records involved in the collision to have a new FormID, and also rerouting any reference to it within the mod to point to that new record.
+
+Here is an example of some work being done in parallel, where one side added an Npc, and the other a Weapon, both of which would have claimed the same FormID:
+
+![FormID Collision](images/formid-conflict-tree.png)
+
+After running the tool, an extra commit adjusting one of the records has been added and merged in to de-collide the records:
+
+![Fixed FormID Collision](images/formid-conflict-tree-fixed.png)
+
 !!! bug "Two Collisions Maximum"
-    The logic that Spriggit contains to handle FormID conflicts can only handle two records with a single FormID.  As such, collisions need to be handled immediately after each Git merge.
+    The logic that Spriggit contains to handle FormID conflicts can only handle two records with a single FormID.  As such, collisions need to be handled immediately after each Git merge.
+