[MOD] UserXpMod - Remap keyboard, skip intros, change the "use door" key and more!

[MoArtis]

River City Girls UserXpMod

Steam version
https://github.com/MoArtis/RCGMod/releases/download/1.3/RCG-UserXpMod_STEAM_1.3.zip

Good Old Games version
https://github.com/MoArtis/RCGMod/releases/download/1.3/RCG-UserXpMod_GOG_1.3.zip

Epic Games Store version
https://github.com/MoArtis/RCGMod/releases/download/1.3/RCG-UserXpMod_EGS_1.3.zip

Report bugs and make suggestion
https://github.com/MoArtis/RCGMod/issues

** What is it **

UserXpMod is a "quality of life" mod that allows to tweak multiple small things to fix some issues and improve the user experience on PC.

https://steamcommunity.com/sharedfiles/filedetails/?id=1869778075
https://steamcommunity.com/sharedfiles/filedetails/?id=1869818270
https://steamcommunity.com/sharedfiles/filedetails/?id=1869777768

Video of the new main menu flow: https://streamable.com/f4s5i

** What is new **

• Compatible with the official patch 1.1
  
• Keep the currently held weapon when entering a boss room. (Off by default)
  
• Make the interaction with doors and bus stops instantaneous. (Off by default)
  
• Add the two missing moves' input display in the dojo.
  
• Add two new features to the training mode (No AI on enemies and players invincibility).
  
• Use the JSON localization file to write your own translation.
  
• Translated progression details (Only in Spanish and French for now - You can add you own in the mod's data file).
  
• Various bug fixes on existing features.

** What is it used for **

[Menus]

• Skip any splash screen, video, dialog with just pressing Start or Escape once.
  
• Start the game from the main menu. (Off by default)
  
• Display progression details in the save selection menu. (Off by default)
  
• Skip the tutorial in New Game Plus.
  
• Skip the "Press Start" menu.
  
• "Loiter" option highlighted by default after selecting a file.
  
• "Next" option highlighted by default in the file settings menu.
  
• Preselect a favorite character in the character selection screen. (Off by default)
  
• Useables' consumption status displayed for each character.
  
• Useables' stat gain displayed in shops.
  
• Display moves' inputs in Dojos.
  
• [NEW] Use the JSON localization file to write your own translation.

[Settings]

• Remap the "interact" action used to pick object on the floor or use doors.
  
• Remapping the “interact” action will change the button prompt accordingly.
  
• [NEW] Make the interaction with doors and bus stops instantaneous. (Off by default)
  
• Remap the keyboard from the mod’s config file.
  
• Force the game to use XInput to potentially fix the controller related bugs. (Off by default)
  
• Display the PS4 controller’s button prompts instead of the Xbox ones. (Off by default)
  
• Configure the vSync settings.
  
• Use Unity’s frame limiter ("TargetFramerate") or a custom one. (Off by default)
  
• Swap the phone navigation buttons / keys. (Off by default)

[Game mechanics/Feedbacks]

• Unlock the secret characters on every save once they are unlocked on at least one save.
  
• Display the amount of damage on hit like other River City games.
  
• Customize the color and the size of the Damage and XP gain feedbacks.
  
• Make Recruits stay and fight for you when summoned. (Off by default) - Code by Muken
  
• Share rewards between players. (Off by default) - Code by Muken
  
• Customize the Attack and Combo system. (Off by default) - Code by Muken
  
• [NEW] Keep the currently held weapon when entering a boss room. (Off by default)

[Bug fixes]

• [DEPRECATED] Fix a bug that prevented the Book items to work properly when using a character other than Misako.
  
• Fix a bug that prevented the phone interface to display a maxed-out Stamina stat.

[Combo Training Mode]

• Press F1 to make enemies invincible.
  
• Press F2 to force common enemies to spawn as their Nightmare variations.
  
• Press F3 to prevent common enemies from attacking the players.
  
• [NEW] Press F4 to deactivate enemies' AI.
  
• [NEW] Press F5 to make the players invincible.

[FUN]

• Change the size of the enemies. (Off by default)

** DOWNLOAD LINKS **

Github: https://github.com/MoArtis/RCGMod/releases


** How to install **

Extract the entire content of the archive where River City Girls is installed. The install folder on Steam is usually "Steam\steamapps\common\River City Girls".

It should replace the "Assembly-CSharp.dll" file located in "River City Girls\RiverCityGirls_Data\Managed".


** How to use **

Next to the "RiverCityGirls.exe" file, you should have a "ModData.json" file. Open it with any text editor.

Following the order of the file, this is what you can modify:

• "allowQuickSkip": Can be set to true or false. if true, allows to skip any video, dialog and the whole intro by pressing Start or Escape once.
  
  
• "startFromMainMenu": Can be set to true or false. If true, always start the game from the main menu.
  
  
• "skipStartMenu": Can be set to true or false. If true, always skip the "Press Start" menu (A.K.A. Title screen).
  
  
• "interactActionId": Can be set to any "action id" like "block" or "recruit" (full list just below). It will replace the button use for interacting with doors or grab objects on the floor. The game is using the "QuickAttack" by default which can be annoying when fighting next to a door or a weapon.
  
  
• "instantInteraction": Can be set to true or false. If true, it will make interaction with doors and bus stop instantaneous. Like in the version 1.0 of the game.
  
  
• "playerOneInputConfigs" & "playerTwoInputConfigs": Each line can be set to a keyboard keycode (full list just below). Remap each action to a new keyboard key.
  
  
• "forceXInput": Can be set to true or false. If true, it might fix some controller related bugs like controlling the two players with only one controller or the controller's inputs being not detected at all.
  
  
• "usePS4buttonPrompts": Can be set to true or false. If true, it will replace the Xbox controller’s input prompts by the PS4 controller’s ones.
  
  
• "displayProgressionInfo": Can be set to true or false. If true, it will display a detailed breakdown of the currently selected save in the save selection menu.
  
  
• "swapPhoneNavigationButtons" Can be set to true or false. If true, it will swap the "Recruit" and "Block" buttons on the controllers (LT/LB and RT/RB).
  
  
• "vSyncCount": Can be set to 0, 1, 2, 3 or 4. 0 will deactivate the vertical sync and decouple the game’s framerate to the monitor refresh rate. Doing so will usually cause “screen tearing” but will allow to use frame limiters (see below). 1, the game default, will sync the framerate with the monitor’s refresh rate. Using 144hz monitor will make the game target a framerate of 144. As the number is the ratio between the monitor refresh rate and the framerate, 2 will make the game target a framerate of 72 (for the same 144hz monitor). Most user needs to keep that value to 1.
  
  
• "targetFramerate": Can be set to -1 or any positive integer. This setting is ignored if the vSync is activated (vSync sets 1,2,3 or 4). If set to -1, the game will run as fast as possible (This will kill your battery very fast). Anything above 0 will use Unity’s built-in frame limiter to limit the framerate to the indicated value. Expect screen tearing when the camera is moving around in game.
  
  
• "useCustomFramelimiter": Can be set to true or false. If true, the game will use a custom Frame limiter to do the same thing as described just before in the "targetFramerate" section. It might give better results than the built-in one. Don’t forget to set the targetFramerate before using this.
  
  
• "displayDamageOnHit": Can be set to true or false. If true, the amount of damage will be displayed when the enemies or the player characters are hit. An exclamation mark will be added to the damage indicator when the “Bomb Bra” effect (One hit KO) is being applied.
  
  
• "xpGetTextColor": Can be set to any real number between 0 and 1 for the Red, blue, green and alpha channels of the desired color. It corresponds to the desired color of the xp gain feedback displayed when an enemy is defeated. The alpha value (“a”) is ignored but setting it to 0 will pick the game’s default feedback text color.
  
  
• "xpGetTextFontSize": Can be set to any positive integer. It defines the font size of the xp gain feedback. The game’s default is 80. Setting it to 0 or less will pick the default value.
  
  
• "hitDmgTextColor": Can be set to any real number between 0 and 1 for the Red, blue, green and alpha channels of the desired color. The same usage as "xpGetTextColor" but for the Hit damage feedback.
  
  
• "hitDmgTextFontSizeMin": Can be set to any positive integer. As the size of the Hit damage feedback is actually dynamic, a minimum and a maximum size can be set. For the players, the size depends on the amount of base damage compared to all the other move of the player’s character. For the enemies, the size is determined from the portion of health lost from their attacks.
  
  
• "hitDmgTextFontSizeMax": Can be set to any positive integer. See "hitDmgTextFontSizeMin".
  
  
• "moreInfosInUseableShops": Can be set to true or false. If true, the shop selling foods or other useable will make it clear if a character already used an item. It will also display the items' stat gains.
  
  
• "loiterSelectedByDefault": Can be set to true or false. If true, the "loiter" option will be selected by default after selecting a file. Making it unlikely to start a new game plus by mistake and reset the story progress.
  
  
• "startSelectedByDefault": Can be set to true or false. If true, the "Next" option in the selected by default in the file settings menu.
  
  
• "noTutorialInNewGamePlus": Can be set to true or false. If true, remove the tutorial in New Game Plus.
  
  
• "characterByDefault": Can be set to Misako, Kyoko, Kunio, Riki or left empty (""). If set to a character name, the character selection screen will try to select that character by default for the two players. If value is set to locked character, left empty or invalid, the default behavior will be used.
  
  
• "unlockSecretCharactersOnceForAllSave": Can be set to true or false. If true, unlocking the secret playable characters only need to be done once in order to make them available for any save.
  
  
• "fixBooksBug": Can be set to true or false. If true, fix a bug that prevented the Book items to work properly when using a character other than Misako.
  
  
• "fixMaxStaminaBug": Can be set to true or false. If true, fix a bug that prevented the phone interface to display a maxed-out Stamina stat.
  
  
• "activateTrainingMode": Can be set to true or false. If true, allows to use the F1 to F5 keys to switch on and off different features related to "combo training".
  
  
• "enemiesScalingRatio": Can be set to any real number between 0.1 and 20. Will change the size of the enemies. :D
  
  
• "gameplayModifications": This section contains flags that change aspects of gameplay
  
  
• "activeRecruits": Can be set to true or false. If true, change the recruit system entirely. Recruits will now actively participate to the fight until they are taken down by the enemies or until the player left the current room. Summoning a recruit costs a heart, as well as letting a recruit get KO'ed. Press the recruit button again to dismiss before they are KOed.
  
  
• "quickComboOverride": Can be set to true or false. If true, after purchasing extensions to the quick combo, you can still do the finisher early by holding up while pressing quick attack.
  
  
• "backAttackCombo": Can be set to true or false. If true, in all combos where you can combo into a heavy attack, you can also combo into a back attack by holding back while pressing heavy attack.
  
  
• "backAttackAutoParry": Can be set to true or false. If true, all back attacks have an auto-parry property against all non-boss attacks coming from the back.
  
  
• "heavyAttackGuardBreak": Can be set to true or false. If true, forward + heavy attacks will break the guard of non-boss enemies.
  
  
• "sharedRewards": Can be set to true or false. If true, all XP and money from fighting enemies will be shared between players in coop mode.
  
  
• "monkMode": Can be set to true or false. This is a challenge mode where you play in poverty. No money will be earned (though you will start with all techniques unlocked, and burgers are free during the Godai burger quest). Enemies will have a 20% health bonus, act 1 and 2 enemies will be slightly tougher, all bosses will have double health, and Sabuko will have a nice end-boss surprise for you. In return, all characters will start with both Kyoko's and Misako's starting equipment. You may want to put on those gym shorts, since you don't have a lot of other ways to get health back :)
  
  
• "alwaysKeepWeapons": Can be set to true or false. If true, the player characters will keep their currently held weapon when entering a boss room.
  
  
• "useJsonLocalizationData": Can be set to true or false. If true, the game will use the localization file located in "RiverCityGirls_Data\StreamingAssets\LocalizationData" instead of its internal data.
  
  
• "localizationKeys": A list of localization keys only used by the mod. Can also be used to replace any existing key used by the game.

** How to uninstall **

If you want or need to restore the original files, you should be able to do that on Steam by using the "Verify integrity of the game files" option.

In your steam's library, Right click on the game name, properties, local files. The option should be there.


Enjoy! 🥳

[MoArtis]

Please, do not hesitate to ask if something is not working. 😉 I'm also open to suggestion to improve the mod.

Also the new key binding that comes with the mod might seem strange, so make sure to modify the "ModData.json" file before using this mod.

[Raven]

Seems promising, I'll check it out thanks.

[Johnny Bagarre]

YOU ARE THE BEST MATE ! I had a problem where my xbox one controller work on every game except this one and thanks to your mod and the xinput set to true I can finally play it with a controller ! THANK YOU !

[MoArtis]

Wow! Good to know and really happy to hear that! 😁 Thanks a lot for using the mod!

[Shiggus Diggus]

I have an issue with changing the interact button: When near something interactable the light attack button does not work, it refuses to attack. I haven't changed it from the recruit button, so it's really odd, not sure if I'm the only one experiencing this.

[zuntatafan]

@MoArtis - change the block after the if !nearInteractable from quick = false to the default quick behavior defined in the first block, to fix the "light attack lockout while hovering over interactables" bug. I'm not at home right now so all the variable names are probably wrong.

[MoArtis]

@Bad Dax Never Die: Arf I didn't test that function well enough apparently.
@ehekatlcat Thanks for the heads up!
I will upload a new version in the next few hours.

[I Saw A Bear]

Thanks 1 million for this. One thing i did notice (not sure if you can do much on your end) was when weapons are dropped at your feet the light attack button is non-functional until you pick it up of move away from it.

[zuntatafan]

Yeah he's fixing it soon. It's literally one line of code to fix.

[MoArtis]

I'm testing it right now.

Funny thing, the best solution seems to strip these if/else conditions from the code. I don't see a situation where using a quick attack above an interactable object is causing problem. The game seems to handle the priorities perfectly fine without it.

It should be especially fine when using another action id anyway. Let’s test that!

[MoArtis]

Here is the new version: https://github.com/MoArtis/RCGMod/releases/download/1.01/RCG-UserXpMod_1.01.zip

But I feel this solution is also not ideal. 🤔 Depending on how the interaction action is "rebinded" it can leads to strange behavior when you pick weapons (like using your recruit and picking up the weapon at the same). I guess I can add a big switch statement to handle all the possible action id (block, recruit...) priority issues.

[MoArtis]

Alright I updated the release package and all the potential input conflicts with the interact action should be fixed.

Assigning the interact action to block was a special case though. But I made sure it is not preventing you to block when dropping a weapon.

If someone is testing the mod, make sure to redownload the latest one again and let me know if everything is working correctly. Thanks!

[Certified Fentanyl Dealer]

Someone let me know if this fixes the "one controller as two" bug. If it weren't for that, I'd be playing this game.

[Red]

Are you still forced to drop a weapon 90% of the time if you set the interact button to the block button whenever you want to transition to other areas like in the very first version of the mod?

[MoArtis]

@Mr. Slinky
I'm actually looking for someone with that bug. Can you try yourself? That would be super useful. You just need to set the last parameter ("forceXInput" IIRC) to True in the config file.

@Red
Yup this was fixed. You should also be able to block while walking over a weapon. I also recommend seeing it to 'recruit'. It works pretty well. 😀