Merge pull request #2 from fangdreth/NewReadMe

New read me

README.md

@@ -1,67 +1,97 @@
-![alt text](https://github.com/fangdreth/MBAACC-Extended-Training-Mode/blob/main/Images/Github%20Image.png?raw=true)
+![alt text](https://github.com/fangdreth/MBAACC-Extended-Training-Mode/blob/NewReadMe/Images/Extended%20Training%20Mode%20v2.0%20Corner.png?raw=true)
 
-### Features
+#
+![alt text](https://github.com/fangdreth/MBAACC-Extended-Training-Mode/blob/NewReadMe/Images/Features.png?raw=true)
 
 + New "EXTENDED SETTINGS" menu
-+ All features are available in-game instead of needing you to look at a separate program
-+ Navigate through the menu with FN1 and FN2
-+ Will re-attach to MBAACC without requiring you to close the mod
-+ ENEMY REVERSAL
-	+ Replaces ENEMY ACTION
-	+ Four slots
-	+ Can set to RANDOM or REPEAT
-	+ Adjustable delay
++ Reversals
+	+ Four slots with five modes
+		+ OFF: no reversals
+		+ NORMAL: perform one of the selected reversals on block or hit
+		+ RANDOM: 50% chance to perform one of the selected reversals on block or hit
+		+ REPEAT: perform the selected reversals repeatedly
+		+ SHIELD: perform one of the selected reversals after shielding
+	+ Has support for nearly every action in the game
 	+ Fixed 1f delay glitch
-	+ Compatible with DUMMY status
-+ Ex Guard
-	+ Can set to RANDOM
-+ Meter and Health Controls
-	+ Manage meter all the way down to the individual 0.1%
-	+ Manage precice health values and percentages
-	+ Old LIFE control changed to only manage whether health recovery is on
+	+ Configurable delay can be added to the reversal to simulate fuzzy defense
++ EX Guard
++ Precise Meter and Health Controls
+	+ Exact health and red health written to the screen
 + Guard Bar QoL
 	+ Instantly regenerate instead of slowly refilling
 	+ New INFINITE option
+	+ Exact guard health and quality written to the screen
 + Position Controls
 	+ Control both players and assist positions
-	+ INVERT positions on screen i.e. switch side of screen
 	+ LOCK positions for custom reset positions
 + Burst After X Hits
++ More accurate meter built during a combo in Training Display
++ Option to reset the Reverse Penalty instantly after a combo or blockstring
 + Character Specific Resources
 	+ Roa visible and hidden charges
 	+ Sion bullets
+	+ F-Maids heart meter
+	+ Ryougi knife refill
 	+ Normal, auto-refill, and infinite options
-+ Take Control of Assist Characters
+	+ Take Control of Assist Characters
+	+ Control Kohaku as C-Maids through resets
 + Frame Data Display
-	+ Frame advantage is always displayed in the top left instead of framerate
-	+ Very in-depth information about the game state
-	+ Gameplay timeline
-	+ Frame advantage
-	+ And a lot of other nerdy bits
+	+ Displayed in the mod window or on the screen
+	+ Startup, Total, and Advantage clearly displayed
+	+ The display in the mod window can be configured to display significantly more detail
 + Save States
-	+ When enabled, F1 and F2 are changed to save and load save states
-
-# How do I get the mod?
-
-- [Download the latest .EXE from this link.](https://github.com/fangdreth/MBAACC-Extended-Training-Mode/releases)  
-
-- The first time you run the .EXE, your anti-virus might warn you it is dangerous.  You can safely dismiss this message.  If you are curious, you see this because the training mod has code which modifies memory directly, which sets off the anti-virus.
+	+ Three separate save slots.
+	+ Import and Export of save states supported
++ RNG
+	+ Pick a custom seed or custom RNG value
+	+ Can refresh the custom RNG every frame or every training mode reset depending on need
++ Character Highlights
+	+ Highlight character Idle, Block, Hit, Armor, and Throw Protection
++ Character Hitboxes
+	+ Different rendering styles for preference
+	+ Color blind-friendly colors or the classic colors both supported
+	+ Options to extend the origin for each character
+	+ Option to draw the ground level
++ Hotkey Controls
++ Etcetera
+	+ Helper text has been added to the new settings to explain their uses
+	+ Replaced the stock FPS counter with one that is more accurate
+	+ The background can be replaced with solid colors
+	+ Shadows can be disabled
+	+ The HUD can be disabled
+
+#
+![alt text](https://github.com/fangdreth/MBAACC-Extended-Training-Mode/blob/NewReadMe/Images/Discord.png?raw=true)
+
+We have a [Discord](https://discord.gg/6QUpZcThg7) where you can report bugs, get help, request features, or just discuss the mod.  If you do not want to join a discord, you can ping or message Fang___ instead.
+
+#
+![alt text](https://github.com/fangdreth/MBAACC-Extended-Training-Mode/blob/NewReadMe/Images/Get.png?raw=true)
+
+- [Download the latest .EXE and .DLL from this link.](https://github.com/fangdreth/MBAACC-Extended-Training-Mode/releases)  
+
+- The first time you run the .EXE, your anti-virus might warn you it is dangerous.  You can safely dismiss this message.  If you are curious why, it says this because the training mod has code which modifies memory directly, which sets off the anti-virus.
 
 - Run the .EXE while you have Melty Blood open.
 
 - It is not necessary to put the executable in the same directory as MBAA.exe.
 
-# Building the mod yourself
+#
+![alt text](https://github.com/fangdreth/MBAACC-Extended-Training-Mode/blob/NewReadMe/Images/build.png?raw=true)
 
-Right now there isn't a CMAKE file, so if you want to build the mod yourself, get the [latest version of Visual Studio](https://visualstudio.microsoft.com/vs/) and be sure to target x86.
+Right now there isn't a CMAKE file, so if you want to build the mod yourself, get the [latest version of Visual Studio](https://visualstudio.microsoft.com/vs/), [DirectX SDK](https://www.microsoft.com/en-us/download/details.aspx?id=6812), and be sure to target x86.
 
-# Save State Controls
+#
+![alt text](https://github.com/fangdreth/MBAACC-Extended-Training-Mode/blob/NewReadMe/Images/faq.png?raw=true)
 
-First, save states must be enabled from the EXTENDED SETTINGS menu.  After that, a save state can be created anywhere (even while paused) by pressing F1 on your controller.  From that point, pressing F2 will restore that save state.  You can clear your save states by either holding up and pressing F1, or going into the EXTENDED SETTINGS menu and selecting CLEAR SAVE STATES.
+### Is it compatible with the Steam release?
+At the moment, no.  You must use the latest version of the [community edition](https://play.meltyblood.club/).
 
-Three save slots available.
+### Is it compatible with Concerto?
+Yes.  Concerto is just an external program for CCCaster, so it will work just fine.
 
-# FAQ
+### I found a bug, how do I report it?
+You can join our Discord linked above, or send a message to Fang___
 
 ### "Looking for MBAA.exe..." when MBAA.exe is already open
 Check Task Manager too see if you have a zombie MBAA.exe process running.  You may have to restart your computer to kill this program.
@@ -72,17 +102,77 @@ This means your VC++ redistributable is missing or needs repaired.  There are st
 ### Some of my settings change on their own
 This is most likely because you are using the HITS UNTIL BURST option.  This setting requires MANUAL for the dummy and INFINITE for the meter, and turning HITS UNTIL BURST on automatically changes these.
 
-### How do I get in touch?
-My handle is Fang\_\_\_ (that's three underscores).  Message me on Discord.  I'm in most major Discords so you'll be able to find me pretty easily.
-
-### Can I suggest features?
-By all means.  Reach out to me on discord.  Don't be afraid your idea is stupid--I'd love to discuss it, and who knows maybe it's already possible with clever settings.
-
-### Can I contribute?
-Sure.  Reach out and we can talk about it.
+### The hitboxes are being glitchy
+More than likely this is because you opened the F4 menu at some point.  This is a known issue and can be easily fixed by switching in/out of fullscreen (alt+enter).
 
 ### Can I make my own version?
-Yes you can, but I would prefer not having too many similar training mode mods floating around.  I have tried to make the code as readable and flexible as possible if you do choose this path, however.
+Yes.
+
+#
+![alt text](https://github.com/fangdreth/MBAACC-Extended-Training-Mode/blob/NewReadMe/Images/changelog.png?raw=true)
+
++ Uses DLL injection now in addition to the old external EXE
+
++ Frame data improved
+  + Exact health, red health, guard bar, and guard quality values on-screen
+  + Color Guide has been created to reference the meaning of the labels
+  + Frame data is now written to the screen a la SF6
+
++ Reworked Save State controls
+  + Press A on a save slot to delete it
+  + Import and Export Save States
+  + Save States support RNG
+  + Hotkey controls
+    + Save by pressing the hotkey, and delete by holding it
+    + Change active Save Slot
+
++ Frame Step
+  + Freeze the game and advance frame-by-frame
+
++ Hitboxes
+  + Different styles of drawing and a color blind mode
+  + Option to extend the characters' origin marker fullscreen
+  + Option to highlight the ground
+
++ Color Overlay
+  + Idle, Blocking, Hit, Armor, and Throw Protection
+  + Red, Yellow, Green, Blue, Purple, and Black
+  + Toggle on and off with a hotkey
+
++ More features to Enemy Reversals
+  + Can be turned off without setting everything to NONE
+  + Reversal out of shield
+  + Reversal with a hotkey
+
++ Custom RNG Controls
+  + Pick a custom Seed or a specific RNG value
+  + Can reset every frame or just set it once when resetting training mode
+
++ Improved Input Display
+  + Shows E presses
+  + Arcade style similar to Strive
+
++ Customization
+  + Configurable hotkeys for many of the training mode functions
+  + Significantly more accurate FPS
+  + Disable the HUD
+  + Disable the background and replace it with a solid color.  Useful for chroma keying
+  + Disable shadows
+
++ Training Display
+  + Improved the accuracy of meter built during a combo
+
++ More character specific controls
+  + FMaids Hearts
+  + Ryougi Knife
+
++ Et cetera
+  + Helper text has been added to everything in the Extended Settings menu
+  + Fixed a few incorrect moves in Reversals
+  + Improved inputs being dropped in the menu performance
+  + Moved several menus around
+  + Frame advantage is not shown with the FPS counter anymore
+  + Removed random tripping
 
 # License