Add meadow gamemode support and rewrite description

Author: xamionex

PlayerHooks.cs

@@ -6,6 +6,8 @@
 using MoreSlugcats;
 using System.Collections.Generic;
 using System.Linq;
+using HarmonyLib;
+using RainMeadow;
 using RWCustom;
 using UnityEngine.Serialization;
 
@@ -55,6 +57,12 @@ private void PlayerHooks()
 
         // Allows grabbing other players
         IL.Player.Grabability += Player_AppendPupCheckGrabability;
+
+        HarmonyInstance = new Harmony(PluginInfo.PluginGUID);
+        if (rainMeadowEnabled)
+        {
+            HarmonyInstance.PatchAll(typeof(MeadowPlayerControllerPatches));
+        }
     }
 
     private void Player_MovementUpdate(On.Player.orig_MovementUpdate orig, Player self, bool eu)

PluginInfo.cs

@@ -1,5 +1,5 @@
 internal static class PluginInfo {
 public const string PluginGUID = "amione.Pupifier";
 public const string PluginName = "Pupifier";
-public const string PluginVersion = "2.0.5";
+public const string PluginVersion = "2.0.6";
 }

Pupifier.cs

@@ -2,6 +2,7 @@
 using System.Security.Permissions;
 using BepInEx;
 using System.Reflection;
+using HarmonyLib;
 using UnityEngine;
 using UnityEngine.Serialization;
 
@@ -18,6 +19,7 @@ namespace Pupifier
     public partial class Pupifier : BaseUnityPlugin
     {
         public static Pupifier Instance;
+        public static Harmony HarmonyInstance;
         public static PupifierOptions Options;
         public static PlayerData PlayerData;
         [FormerlySerializedAs("RainMeadowEnabled")] public bool rainMeadowEnabled;

Pupifier.csproj

@@ -3,33 +3,46 @@
     <TargetFramework>net48</TargetFramework>
     <AssemblyName>amione.Pupifier</AssemblyName>
     <Product>Pupifier</Product>
-    <ProductDescription>Lets you become a slugpup in Rain World with a push of a button (dynamic in-game transform), with meadow support. This mod was made specifically for meadow but works for non-meadow as well
-
-Known issues
-
-- Meadow issues (not related to my mod): 
-grabbing players and breaking if you go thru a pipe, piggybacking desync
-- Meadow Gamemode: Not working; henpemaz has coded it so that pups are not allowed in the meadow gamemode
-      
-Features
-
-- Transform into a slugpup dynamically, also works in Meadow
-- Change your stats based on slugpup relativity
-- Works with modded slugcats as well
-
-Credits
-
+    <ProductDescription>[h2]Lets you become a slugpup in Rain World with a push of a button[/h2]
+This mod was made specifically for meadow but works for non-meadow as well
+
+[hr][/hr]
+[h3]Known issues[/h3]
+[list]
+  [*]Meadow issues (not related to my mod): grabbing players and breaking if you go thru a pipe, piggybacking desync (toggle grabbability in settings)
+  [*]Meadow Gamemode: Not working; henpemaz has coded it so that pups are not allowed in the meadow gamemode, enable locally in toggles settings
+[/list]
+
+[hr][/hr]
+[h3]Features[/h3]
+[list]
+[*] Transform into a slugpup dynamically, with a hotkey, even when in-game
+[*] Change your stats based on slugpup relativity
+[*] Supports controller input as a hotkey to change
+[*] Supports Rain Meadow
+[*] Supports Modded Slugcats
+[/list]
+
+[hr][/hr]
+[h3]Q&amp;A[/h3]
+[list] 
+  [*] Does this mod change gameplay? Yes, and a ton, you will behave almost like a slugpup, with some changes, for example, it's all relative so if you pick rivulet you will be faster than a normal slugpup
+  [*] Is it only cosmetic? No, you could try to make it, I haven't tested much but there is a toggle in the stats settings to turn off changing stats, that way you will still be small but no stats will be changed
+  [*] What is configurable? Every stat you have as a player, along with holding double spears as spearmaster or holding 2 items no matter what or not letting people grab you
+[/list]
+
+[hr][/hr]
+[h3]Credits[/h3]
 - amione - Creator
 - youbitchoc - For helping in development
 - henpemaz - For Rain Meadow
 - Maxi Mol - For Mouse Drag code
 - LDani, simichan1227 - For testing the s**t out of my mod (It was kinda encouraging)
 
-Report Issues on github please! https://github.com/xamionex/Pupifier/issues/new
-Steam doesn't give me notifications for comments on my own mods for some reason,
-so I might not see your comment because I need to literally go to the mod page to see it, and I'm not doing that every day.
+[hr][/hr]
+[h3]Report Issues on github please! https://github.com/xamionex/Pupifier/issues/new[/h3]
     </ProductDescription>
-    <ModVersion>2.0.5</ModVersion>
+    <ModVersion>2.0.6</ModVersion>
     <Version>2.0.8</Version>
     <LangVersion>10.0</LangVersion>
     <Nullable>enable</Nullable>

Pupifier/modinfo.json

@@ -1,34 +1,47 @@
 {
     "id": "amione.Pupifier",
     "name": "Pupifier",
-    "version": "2.0.5",
+    "version": "2.0.6",
     "target_game_version": "v1.9.15",
     "authors": "amione - Creator, youbitchoc - For helping in development, henpemaz - For Rain Meadow, Maxi Mol - For Mouse Drag code, LDani, simichan1227 - For testing the s**t out of my mod (It was kinda encouraging)",
-    "description": "Lets you become a slugpup in Rain World with a push of a button (dynamic in-game transform), with meadow support. This mod was made specifically for meadow but works for non-meadow as well
+    "description": "[h2]Lets you become a slugpup in Rain World with a push of a button[/h2]
+This mod was made specifically for meadow but works for non-meadow as well
 
-Known issues
+[hr][/hr]
+[h3]Known issues[/h3]
+[list]
+  [*]Meadow issues (not related to my mod): grabbing players and breaking if you go thru a pipe, piggybacking desync (toggle grabbability in settings)
+  [*]Meadow Gamemode: Not working; henpemaz has coded it so that pups are not allowed in the meadow gamemode, enable locally in toggles settings
+[/list]
 
-- Meadow issues (not related to my mod): 
-grabbing players and breaking if you go thru a pipe, piggybacking desync
-- Meadow Gamemode: Not working; henpemaz has coded it so that pups are not allowed in the meadow gamemode
-      
-Features
+[hr][/hr]
+[h3]Features[/h3]
+[list]
+[*] Transform into a slugpup dynamically, with a hotkey, even when in-game
+[*] Change your stats based on slugpup relativity
+[*] Supports controller input as a hotkey to change
+[*] Supports Rain Meadow
+[*] Supports Modded Slugcats
+[/list]
 
-- Transform into a slugpup dynamically, also works in Meadow
-- Change your stats based on slugpup relativity
-- Works with modded slugcats as well
-
-Credits
+[hr][/hr]
+[h3]Q&A[/h3]
+[list] 
+  [*] Does this mod change gameplay? Yes, and a ton, you will behave almost like a slugpup, with some changes, for example, it's all relative so if you pick rivulet you will be faster than a normal slugpup
+  [*] Is it only cosmetic? No, you could try to make it, I haven't tested much but there is a toggle in the stats settings to turn off changing stats, that way you will still be small but no stats will be changed
+  [*] What is configurable? Every stat you have as a player, along with holding double spears as spearmaster or holding 2 items no matter what or not letting people grab you
+[/list]
 
+[hr][/hr]
+[h3]Credits[/h3]
 - amione - Creator
 - youbitchoc - For helping in development
 - henpemaz - For Rain Meadow
 - Maxi Mol - For Mouse Drag code
 - LDani, simichan1227 - For testing the s**t out of my mod (It was kinda encouraging)
 
-Report Issues on github please! https://github.com/xamionex/Pupifier/issues/new
-Steam doesn't give me notifications for comments on my own mods for some reason,
-so I might not see your comment because I need to literally go to the mod page to see it, and I'm not doing that every day.
+[hr][/hr]
+[h3]Report Issues on github please! https://github.com/xamionex/Pupifier/issues/new[/h3]
     ",
     "requirements": ["moreslugcats"],
     "requirements_names": [],

PupifierOptions.cs

@@ -33,6 +33,7 @@ public partial class PupifierOptions : OptionInterface
             public readonly Configurable<bool> ManualPupChange;
             public readonly Configurable<bool> LoggingPupEnabled;
             public readonly Configurable<bool> LoggingStatusEnabled;
+            public readonly Configurable<bool> EnableInMeadowGamemode;
 
             public PupifierOptions()
             {
@@ -59,6 +60,7 @@ public PupifierOptions()
                 // Toggles tab
                 LoggingPupEnabled = config.Bind(nameof(LoggingPupEnabled), true, new ConfigurableInfo("If enabled, console will log pup changes", null, "", "Enable logging for pup change"));
                 LoggingStatusEnabled = config.Bind(nameof(LoggingStatusEnabled), false, new ConfigurableInfo("If enabled, console will log stats upon changes", null, "", "Enable logging for stats when changing"));
+                EnableInMeadowGamemode = config.Bind(nameof(EnableInMeadowGamemode), false, new ConfigurableInfo("If enabled, you will locally be a pup in the meadow gamemode, since you are blocked in the meadow gamemode from being a pup, it will only show locally, and for anyone else that has the mod", null, "", "Enable in MeadowGamemode (read desc)"));
                 DisableBeingGrabbed = config.Bind(nameof(DisableBeingGrabbed), false, new ConfigurableInfo("If enabled, you can't be grabbed", null, "", "Disable being Grabbed"));
                 UseBothHands = config.Bind(nameof(UseBothHands), false, new ConfigurableInfo("If enabled, you can use both hands as a pup", null, "", "Enable using both hands"));
                 SpearmasterTwoHanded = config.Bind(nameof(SpearmasterTwoHanded), true, new ConfigurableInfo("If enabled, you can use both hands for spears as spearmaster", null, "", "Spearmaster can hold 2 spears"));
@@ -138,6 +140,7 @@ public override void Initialize()
                     sepr = 30f;
                     AddCheckbox(LoggingPupEnabled, new Vector2(x, y -= sepr), softGray, softGray, softGray);
                     AddCheckbox(LoggingStatusEnabled, new Vector2(x, y -= sepr), softGray, softGray, softGray);
+                    AddCheckbox(EnableInMeadowGamemode, new Vector2(x, y -= sepr), softYellow, softYellow, softYellow);
                     AddCheckbox(DisableBeingGrabbed, new Vector2(x, y -= sepr), softYellow, softYellow, softYellow);
                     AddCheckbox(UseBothHands, new Vector2(x, y -= sepr), softYellow, softYellow, softYellow);
                     AddCheckbox(SpearmasterTwoHanded, new Vector2(x, y -= sepr), softYellow, softYellow, softYellow);

RainMeadowCompatibility.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using HarmonyLib;
 using RainMeadow;
 
 #pragma warning disable CS8625 // Cannot convert null literal to non-nullable reference type.
@@ -9,6 +10,18 @@
 
 namespace Pupifier
 {
+    [HarmonyPatch(typeof(MeadowPlayerController))]
+    public static class MeadowPlayerControllerPatches
+    {
+        [HarmonyPatch("Player_Update")]
+        [HarmonyPostfix]
+        private static void Postfix_Player_Update(Player self, bool eu)
+        {
+            if (!Pupifier.Options.EnableInMeadowGamemode.Value) return;
+            self.playerState.isPup = Pupifier.Instance.slugpupEnabled;
+        }
+    }
+
     public class PlayerData : OnlineResource.ResourceData
     {
         public List<OnlinePlayer> Ungrabbables = new();
@@ -64,6 +77,7 @@ public static bool GamemodeIsMeadow()
         {
             if (GameIsMeadow())
             {
+                if (Options.EnableInMeadowGamemode.Value) return false;
                 return OnlineManager.lobby.gameMode is MeadowGameMode;
             }
             return false;

readme.md

@@ -1,43 +1,30 @@
 # Pupifier
-
-Lets you become a slugpup in Rain World with a push of a button (dynamic in-game transform), with meadow support. This mod was made specifically for meadow but works for non-meadow as well
+Lets you become a slugpup in Rain World with a push of a button (dynamic in-game transform), with meadow support.
+This mod was made specifically for meadow but works for non-meadow as well
 
 ## Known issues
 
-- Meadow issues are not related to my mod (grabbing players and breaking if you go thru a pipe, piggybacking desync)
-- Report any issues please!
+- Meadow issues (not related to my mod): grabbing players and breaking if you go thru a pipe, piggybacking desync
+    - If you don't want these to happen there is a toggle in the remix menu to disable people from grabbing you
+- Meadow Gamemode: Not working; henpemaz has coded it so that pups are not allowed in the meadow gamemode, enable locally in toggles settings
 
 ## Features
 
-- Transform into a slugpup (Works in Rain Meadow)
-- Change your stats based on slugpup relativity
-- Works with modded slugcats as well
-
-## Installation
-
-1. Download the latest release of Pupifier.
-2. Extract the contents of the zip file into your game directory.
-3. Ensure that the required mods (`Rain Meadow` and `More Slugcats`) are installed.
-4. Launch the game and enjoy your new slugpup adventure!
-
-## Requirements
+- Transform into a slugpup dynamically, with a hotkey, even when in-game, also works in Meadow
+- Change your stats based on slugpup relativity, works with modded slugcats
+- Supports controller input as a hotkey to change
 
-- Game version: v1.9.15
-- Required Mods: moreslugcats
+## Q&A
+- Does this mod change gameplay? Yes, and a ton, you will behave almost like a slugpup, with some changes, for example, it's all relative so if you pick rivulet you will be faster than a normal slugpup
+- Is it only cosmetic? No, you could try to make it, I haven't tested much but there is a toggle in the stats settings to turn off changing stats, that way you will still be small but no stats will be changed
+- What is configurable? Every stat you have as a player, along with holding double spears as spearmaster or holding 2 items no matter what or not letting people grab you
 
 ## Credits
 
-- **amione** - Creator
-- **youbitchoc** - For helping in development
-- **henpemaz** - For Rain Meadow
-- **Maxi Mol** - For Mouse Drag code
-- **LDani**, **simichan1227** - For testing the s**t out of my mod (It was kinda encouraging)
-
-## License
-
-This mod is provided as-is, without any express or implied warranties. Use at your own risk.
-
-## Support
+- amione - Creator
+- youbitchoc - For helping in development
+- henpemaz - For Rain Meadow
+- Maxi Mol - For Mouse Drag code
+- LDani, simichan1227 - For testing the s**t out of my mod (It was kinda encouraging)
 
-If you encounter any issues or have questions, feel free to reach out or contribute to the development of the mod.
-Enjoy your time as a slugpup in Rain Meadow!
+### Report Issues on github please! https://github.com/xamionex/Pupifier/issues/new