Merge pull request #1 from vulpya/miku

Refactor Miku, item system, and callback architecture

- Fix Miku charm chance calculation and add Birthright effect (Luck scaling)
- Introduce generic item system and implement Microphone active item
- Decouple NoteTear from Miku and generalize character/item architecture
- Replace direct callback registration with decorator-based system

Author: vulpya

README.md

@@ -8,8 +8,9 @@ A mod adding Hatsune Miku and more Vocaloid-inspired content to The Binding of I
 
 ### Hatsune Miku
 
-Miku uses her musical tears to charm enemies, letting her music sway even the fiercest foes.
-There is even a small chance an enemy becomes a fan!
+Miku uses music to charm enemies. Some may even become fans!.
+Her tears have a small chance to charm enemies.
+There is also a very small chance to charm an enemy permanently.
 
 ## Disclaimer
 

TODO.md

@@ -0,0 +1,11 @@
+# TODOs
+
+- [x] Add Birthright Miku effect
+- [x] Add EID compatibility
+- [x] Add passive item for Miku tear effect
+- [x] Add null item to Miku to avoid duplicate code
+- [ ] Add benefits if Miku obtains Virtual Idol
+
+## BUGS
+
+- [x] Fix Miku Icon transparency

cspell.config.jsonc

@@ -29,5 +29,5 @@
     "mod/content/rooms/**",
     "mod/resources/rooms/**",
   ],
-  "words": ["Hatsune", "Miku", "Vocaloid", "Arexz"],
+  "words": ["Arexz", "Charmable", "Hatsune", "Miku", "Vocaloid"],
 }

mod/content/costumes2.xml

@@ -1,3 +1,3 @@
-<costumes anm2root="gfx/characters/">
+<costumes anm2root="gfx/characters/costumes/">
   <costume anm2path="Character_MikuHead.anm2" type="none" priority="100" />
 </costumes>

mod/content/gfx/coop menu.png

@@ -0,0 +1,5 @@
+<ItemPools>
+  <Pool Name="treasure">
+    <Item Name="Virtual Idol" Weight="1" DecreaseBy="1" RemoveOn="0.1" />
+  </Pool>
+</ItemPools>

mod/content/itempools.xml

@@ -0,0 +1,5 @@
+<items gfxroot="gfx/items/" version="1">
+  <passive id="1" gfx="virtual_idol.png" name="Virtual Idol" description="Idol Charm" quality="3" />
+  <active gfx="microphone.png" name="Microphone" description="Sing your heart out" quality="4" maxcharges="8" chargetype="normal" />
+  <null id="1" name="Miku Virtual Idol" cache="collectibles" />
+</items>

mod/content/items.xml

@@ -1,3 +1,3 @@
 <players root="gfx/characters/costumes/" portraitroot="gfx/ui/stage/" nameimageroot="gfx/ui/boss/">
-  <player name="Miku" skin="Character_Miku.png" nameimage="PlayerName_Miku.png" hp="6" portrait="PlayerPortrait_Miku.png" skinColor="-1" costume="104" costumeSuffix="miku" />
+  <player name="Miku" skin="Character_Miku.png" nameimage="PlayerName_Miku.png" hp="6" portrait="PlayerPortrait_Miku.png" skinColor="-1" costume="104" costumeSuffix="miku" birthright="Lucky idol" />
 </players>

mod/content/players.xml

@@ -1,8 +1,8 @@
 <AnimatedActor>
-	<Info CreatedBy="Vulpya" CreatedOn="3/6/2026 4:52:53 PM" Version="149" Fps="30"/>
+	<Info CreatedBy="Vulpya" CreatedOn="3/21/2026 8:32:35 PM" Version="150" Fps="30"/>
 	<Content>
 		<Spritesheets>
-			<Spritesheet Path="costumes\Character_MikuHead.png" Id="0"/>
+			<Spritesheet Path="Character_MikuHead.png" Id="0"/>
 		</Spritesheets>
 		<Layers>
 			<Layer Name="head0" Id="0" SpritesheetId="0"/>