Merge pull request #3 from vulpya/fixes

Miku: improved Tainted Miku (especially in Vanilla Rep+) and several other stuff.

Author: vulpya

BUGS.md

@@ -7,3 +7,7 @@
 - [ ] Fix multiple Tainted Miku copying all notes from Player 1 when continuing a run
 - [ ] Fix Tainted Miku notes not being stored or applied correctly when continuing a run after reopening the game
 - [x] Fix active note being rendered in cutscenes like the Boss VS Screen or during Room transitions
+- [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.

README.md

@@ -22,10 +22,12 @@ Use her **Microphone** to inspire your audience!
 Due to losing her voice, she starts with only Glitch Notes.
 
 Enemies may drop **Lost Notes** when slain.
-Each **Note** grants a **different effect**.
+Each **Lost Note** grants a **different effect**.
 
 Use the **Broken Microphone** to switch melodies.
 
+With **Birthright** she loses even more control of her broken voice, firing multiple Lost Notes at onces.
+
 ## Mod Compatibility
 
 ### External Item Descriptions Support
@@ -37,11 +39,10 @@ For missing or wrong descriptions, please open a new Issue.
 ## Roadmap
 
 - Finish Tainted Miku.
-- Add Tainted Miku Birthright effect.
+- Sound Effects.
 - More Miku-themed items.
 - Improved sprites and animations.
 - Better visual effects.
-- Expanded mechanics and balance improvements.
 
 ## Disclaimer
 

TODO.md

@@ -8,20 +8,29 @@
 - [x] Add Tainted Miku Note System & HUD
 - [x] Add 'Passive Active Item' to switch between notes.
 - [x] Add Synergies to Tainted Miku. (e.g. Brimstone, Epic Fetus)
+- [ ] Add MCM Compat.
+- [ ] Setup Tests.
 
 ## TODO: Miku
 
-- [ ] Balance Stats & charming chances + birthright fan chances.
+- [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.
 - [ ] Add item synergies.
-  - [ ] Hopefully add Miku Leek synergy with Mom's Knife or Spirit Sword
-- [ ] Maybe add charm blacklist, instead of just skipping over all bosses.
-- [ ] Maybe add charmable Angels.
+  - [ ] Maybe add Miku Leek synergy with Mom's Knife and/or Spirit Sword
+- [ ] Add charm blacklist, instead of just skipping over all bosses.
+- [x] Maybe add charmable Angels.
+  - [x] Angels can now be charmed with the 'Microphone' active item.
 
 ## TODO: Tainted Miku
 
 - [ ] Balance Stats and note drop rates.
 - [ ] Add more unique notes and balance them correctly.
-- [ ] Add item synergies tied to special and unique note types.
+- [x] Add item synergies tied to special and unique note types.
+  - [x] Add Brimstone Synergy
+  - [x] Add Dr. Fetus Synergy
   - [ ] TODO: Synergy ideas.
-- [ ] Add Birthright for Tainted Miku.
+- [x] Fix fire rate multiplier issues with several items.
+  - [x] Fix Monstro's Lung.
+- [x] Add Birthright for Tainted Miku.
 - [ ] Add Tainted Miku Icons & Controls.

eslint.config.mjs

@@ -17,6 +17,7 @@ export default defineConfig(
   {
     rules: {
       "no-shadow": "off",
+      "complete/require-unannotated-const-assertions": "off",
       "@typescript-eslint/no-shadow": "off",
       "@typescript-eslint/no-unnecessary-type-parameters": "off",
     },

mod/content/items.xml

@@ -1,8 +1,8 @@
 <items gfxroot="gfx/items/" version="1">
   <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="TODO" quality="4" />
-  <passive gfx="dr_fetus_note.png" name="Dr. Fetus Note" description="TODO" quality="4" />
+  <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" />
   <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" />
   <null name="Miku Idol" cache="collectibles" />

mod/content/players.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" />
+  <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" />
 </players>

mod/metadata.xml

@@ -25,10 +25,11 @@ I get a lot of comments like the games not launching or the mod breaks the game.
 • Use her active item, the [b]Microphone[/b], to inspire your audience!
 
 [b]Tainted Miku (Work In Progress)[/b]
+• [NEW] Unique birthright effect.
 • Having lost her voice, she starts the run firing highly unstable [b]Glitch Notes[/b].
 • Slain enemies drop [b]Lost Notes[/b] onto the floor.
 • Collecting different Lost Notes grants various dynamic gameplay effects.
-• Use the [b]Broken Microphone[/b] to rapidly switch melodies.
+• Use the [b]Broken Microphone[/b] to switch between melodies.
 
 ----------------------------------------------------------------------
 [h2]Mod Compatibility[/h2]
@@ -58,6 +59,6 @@ This is a non-commercial, fan-made mod created as a personal project for fun. Al
 • [url=https://steamcommunity.com/profiles/76561198102520074]ale[/url] — For creating the amazing Miku/Vocaloid sprites!
 • [url=https://steamcommunity.com/id/thearexz]Arexz[/url] — For helping with custom sprite editing and refinement.
   </description>
-  <version>0.3.1</version>
+  <version>0.4.0</version>
   <visibility />
 </metadata>