Merge pull request #4 from vulpya/fixes

Miku: rework Tainted Miku's note system, synergies & effects

Author: vulpya

BUGS.md

@@ -10,4 +10,5 @@
 - [x] When using 'Monstros Lung' as Tainted Miku your tear rate will sky rocket to 120. Reported by DoomSlammer
 - [x] Using a Chaos Card as either version of Hatsune Miku instead throws a default musical note projectile (colorful/rainbow for regular, gray-scale/monochrome for tainted) that doesn't instantly kill entities. Reported by RDW
 - [ ] Subtle visual glitch on the first frame of a Glitch Note without a variant.
-- [ ] Fix Spirit Sword and Mom's Knife not working with Tainted Miku's note system switch.
+- [x] Fix Spirit Sword and Mom's Knife not working with Tainted Miku's note system switch.
+- [x] Fix Tainted Miku being able to pick up shop and angel/devil deal items for free if they had a synergy.

README.md

@@ -1,48 +1,62 @@
 # Hatsune Miku (+Tainted)
 
-[![Build](https://github.com/vulpya/isaac-miku/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/vulpya/isaac-miku/actions/workflows/build.yml) ![Isaac](https://img.shields.io/badge/Game-The%20Binding%20of%20Isaac-darkred) ![Character Mod](https://img.shields.io/badge/Type-Character%20Mod-blue) ![Miku](https://img.shields.io/badge/Vocaloid-Hatsune%20Miku-39C5BB)
+[![Build](https://github.com/vulpya/isaac-miku/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/vulpya/isaac-miku/actions/workflows/build.yml)
 
-A standalone character mod for The Binding of Isaac featuring Hatsune Miku and her tainted counterpart.
+A character mod for **The Binding of Isaac: Repentance** featuring Hatsune Miku and her Tainted counterpart.
 
-## Features
+## Miku
 
-### Miku
+Miku attacks by singing, firing musical **Notes** at her enemies.
 
-Attacks with her Voice in form of Note Tears.
-Notes may charm enemies.
+### Charming
 
-With **Birthright**, charmed enemies may become Fans.
+Miku's notes have a chance to **charm enemies**, causing them to fight alongside her temporarily.
 
-Use her **Microphone** to inspire your audience!
+With **Birthright**, charmed enemies can become permanent **Fans**, joining Miku as allies and fighting alongside her.
 
-### Tainted Miku
+### Microphone
 
-**Tainted Miku is Work in Progress and not really balanced / fletched out!**
+Miku starts with her **Microphone**, which can be used to inspire her audience and support her unique playstyle.
 
-Due to losing her voice, she starts with only Glitch Notes.
+## Tainted Miku
 
-Enemies may drop **Lost Notes** when slain.
-Each **Lost Note** grants a **different effect**.
+> **Work in progress**
 
-Use the **Broken Microphone** to switch melodies.
+Tainted Miku's voice has been broken, leaving her unable to produce ordinary Notes. Instead, she attacks with **Bloody Notes**.
 
-With **Birthright** she loses even more control of her broken voice, firing multiple Lost Notes at onces.
+### Lost Notes
+
+Enemies can drop one of **8 unique Lost Notes**.
+
+Each **Lost Note** changes the properties of Miku's tears, giving her a different way to fight. Collecting **Lost Notes** temporarily repairs her broken voice and builds her moveset throughout the basement.
+
+### Special Synergy Notes
+
+Certain items are transformed into **Special Synergy Notes**, granting unique effects based on the item they replace.
+
+### Birthright
+
+With **Birthright**, Tainted Miku further distorts her fractured melody, causing multiple **Lost Note**
+effects to trigger with each shot.
 
 ## Mod Compatibility
 
 ### External Item Descriptions Support
 
 This mod includes support for External Item Descriptions.
 
-For missing or wrong descriptions, please open a new Issue.
+For missing or incorrect descriptions, please open a new Issue.
+
+### Mod Config Menu Support
+
+This mod includes support for Mod Config Menu.
+
+MCM options include:
 
-## Roadmap
+- **Show Note Counter** — Show or hide the counter of the selected Note above Tainted Miku.
+- **Note Drop Chance** — Configure the drop chance of Lost Notes from 0% to 100%.
 
-- Finish Tainted Miku.
-- Sound Effects.
-- More Miku-themed items.
-- Improved sprites and animations.
-- Better visual effects.
+For MCM-related issues, please open a new Issue.
 
 ## Disclaimer
 

TODO.md

@@ -14,8 +14,7 @@
 ## TODO: Miku
 
 - [x] Balance Stats & charming chances + birthright fan chances.
-- [ ] Maybe add more default notes.
-  - [ ] Idea: On Enemy hit gets effect which leads the enemy to drop creep.
+- [x] Maybe add more default notes.
 - [ ] Add item synergies.
   - [ ] Maybe add Miku Leek synergy with Mom's Knife and/or Spirit Sword
 - [ ] Add charm blacklist, instead of just skipping over all bosses.
@@ -24,12 +23,13 @@
 
 ## TODO: Tainted Miku
 
-- [ ] Balance Stats and note drop rates.
-- [ ] Add more unique notes and balance them correctly.
+- [x] Balance Stats and note drop rates.
+- [x] Add more unique notes and balance them correctly.
 - [x] Add item synergies tied to special and unique note types.
   - [x] Add Brimstone Synergy
   - [x] Add Dr. Fetus Synergy
-  - [ ] TODO: Synergy ideas.
+  - [x] Add Eraser Synergy
+  - [ ] Add more... (need ideas ;\_;)
 - [x] Fix fire rate multiplier issues with several items.
   - [x] Fix Monstro's Lung.
 - [x] Add Birthright for Tainted Miku.

cspell.config.jsonc

@@ -30,12 +30,14 @@
     "mod/resources/rooms/**",
   ],
   "words": [
+    "Vulpya",
     "Arexz",
     "Charmable",
     "Fearable",
     "Hatsune",
     "Miku",
     "mikub",
     "Vocaloid",
+    "moveset",
   ],
 }

mod/content/costumes2.xml

@@ -1,4 +1,6 @@
 <costumes anm2root="gfx/characters/">
   <costume id="1000" anm2path="virtual_idol.anm2" type="passive" priority="0" />
+  <costume id="1001" anm2path="pink_hair.anm2" type="passive" priority="101" />
   <costume anm2path="Character_MikuHead.anm2" type="none" priority="100" />
+  <costume anm2path="Character_MikuHead_b.anm2" type="none" priority="100" />
 </costumes>

mod/content/entities2.xml

@@ -3,7 +3,10 @@
   <entity anm2path="tears/musical_note.anm2" baseHP="0" boss="0" champion="0" collisionDamage="0" collisionMass="8" collisionRadius="7" friction="1" id="2" name="Musical Note" numGridCollisionPoints="8" shadowSize="8" stageHP="0" variant="8000">
     <gibs amount="0" blood="0" bone="0" eye="0" gut="0" large="0" />
   </entity>
-  <entity anm2path="tears/glitch_note.anm2" baseHP="0" boss="0" champion="0" collisionDamage="0" collisionMass="8" collisionRadius="7" friction="1" id="2" name="Glitch Note" numGridCollisionPoints="8" shadowSize="8" stageHP="0" variant="8001">
+  <entity anm2path="tears/blood_note.anm2" baseHP="0" boss="0" champion="0" collisionDamage="0" collisionMass="8" collisionRadius="7" friction="1" id="2" name="Blood Note" numGridCollisionPoints="8" shadowSize="8" stageHP="0" variant="8001">
+    <gibs amount="0" blood="0" bone="0" eye="0" gut="0" large="0" />
+  </entity>
+  <entity anm2path="tears/lost_note.anm2" baseHP="0" boss="0" champion="0" collisionDamage="0" collisionMass="8" collisionRadius="7" friction="1" id="2" name="Lost Note" numGridCollisionPoints="8" shadowSize="8" stageHP="0" variant="8002">
     <gibs amount="0" blood="0" bone="0" eye="0" gut="0" large="0" />
   </entity>
   <!-- PICKUPS -->

mod/content/gfx/charactermenualt.png

@@ -2,8 +2,9 @@
   <passive id="1000" gfx="virtual_idol.png" name="Virtual Idol" description="Idol Charm" quality="3" />
   <passive gfx="virtual_idol.png" name="Encore!" description="Another One!" quality="3" />
   <passive gfx="brimstone_note.png" name="Brimstone Note" description="Replacement Item for Brimstone" quality="4" />
-  <passive gfx="dr_fetus_note.png" name="Dr. Fetus Note" description="Replacement Item for Dr. Fetus" quality="4" />
+  <passive gfx="dr_fetus_note.png" name="Bomb Note" description="Replacement Item for Dr. Fetus" quality="4" />
+  <passive id="1001" gfx="rubber_note.png" name="Rubber Note" description="Replacement Item for Eraser" quality="4" />
   <active gfx="microphone.png" name="Microphone" description="Sing your heart out" quality="4" maxcharges="8" chargetype="normal" />
-  <active gfx="microphone.png" name="Broken Voice" description="Switch between silence and voices" quality="4" maxcharges="60" chargetype="timed" />
+  <active gfx="microphone.png" name="Broken Voice" description="Switch between emptiness and voices" quality="4" maxcharges="60" chargetype="timed" />
   <null name="Miku Idol" cache="collectibles" />
 </items>

mod/content/items.xml

@@ -1,4 +1,4 @@
 <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" birthright="Lucky idol" />
-  <player name="Miku" skin="Character_Miku_b.png" nameimage="PlayerName_Miku.png" hp="4" armor="2" keys="1" portrait="PlayerPortrait_Miku.png" skinColor="-1" bSkinParent="Miku" costume="104" costumeSuffix="mikub" birthright="Broken Encore" />
+  <player name="Miku" skin="Character_Miku.png" nameimage="PlayerName_Miku.png" hp="6" portrait="PlayerPortrait_Miku.png" skinColor="-1" costumeSuffix="miku" birthright="Lucky idol" />
+  <player name="Miku" skin="Character_Miku_b.png" nameimage="PlayerName_Miku.png" hp="2" armor="4" keys="1" portrait="PlayerPortrait_Miku_b.png" skinColor="-1" bSkinParent="Miku" costume="104" costumeSuffix="mikub" birthright="Broken Encore" />
 </players>

mod/content/players.xml

@@ -8,9 +8,12 @@
 
 A standalone character mod for The Binding of Isaac featuring Hatsune Miku and her tainted counterpart!
 
-[h1]TAINTED MIKU FIXED FOR VANILLA[/h1]
+[h1]VERSION 0.4 OUT NOW![/h1]
 
-Now when playing Vanilla Rep+, Tainted Miku's Lost Notes drops should work as intended!
+I fixed many bugs with Tainted Miku, especially in Vanilla Rep+, but Miku also got some small addition.
+With the Microphone, you can now permanently charm Angels (hopefully without breaking the key pieces.. ;_;)
+
+And I added a small Birthright Effect for Tainted Miku until I got more time and ideas for a really special and interesting effect.
 
 [h1]INFO[/h1]
 I get a lot of comments like the games not launching or the mod breaks the game. Make sure you have all DLCs!
@@ -22,7 +25,7 @@ I get a lot of comments like the games not launching or the mod breaks the game.
 • Attacks with her voice with tears that resemble notes.
 • Each hit has a chance to [b]Charm[/b] enemies.
 • [b]Birthright Effect:[/b] Charmed enemies have a chance to permanently become your loyal [b]Fans[/b]! (until they die)
-• Use her active item, the [b]Microphone[/b], to inspire your audience!
+• Use her active item, the [b]Microphone[/b], to inspire your audience! (Some say you can even charm angels with it)
 
 [b]Tainted Miku (Work In Progress)[/b]
 • [NEW] Unique birthright effect.
@@ -41,6 +44,7 @@ I get a lot of comments like the games not launching or the mod breaks the game.
 [h2]Planned[/h2]
 
 • Finish and balance Tainted Miku's core gameplay loop.
+• Custom Sound Effects.
 • Implement a unique Birthright effect for Tainted Miku.
 • Design and add more Miku-themed items to the item pools.
 • Upgrade custom sprites, animations, and special visual effects.