RimWorld Mod Compatibility: Cumpilation & RJW Menstruation

Overview

This mod aims to provide a smooth experience for players using both the "Cumpilation" and "RJW Menstruation" mods by resolving potential conflicts and integrating their features where appropriate. It acts as a bridge, ensuring mechanics like fertility, pregnancy, and bodily fluids interact logically and consistently based on configurable settings.

This web page serves as the companion documentation and helper tool, offering detailed explanations, configuration guides, and troubleshooting assistance.

Features

• Resolves known conflicts between Cumpilation and RJW Menstruation mechanics.
• Ensures consistent handling of fertility, pregnancy, and related bodily functions affected by both mods.
• Harmonizes relevant Hediffs (e.g., fertility cycles, fluid effects) and game logic.
• Optional configuration settings via the Mod Settings menu to customize integration behavior (e.g., fertility sync, fluid interactions).
• This interactive web-based helper tool for documentation and troubleshooting:
  • FAQ Search/Filter
  • Interactive Load Order Example
  • Logic Flow Visualizer (using Mermaid.js)
  • (Planned) Configuration Simulator
  • (Planned) Troubleshooting Wizard
  • (Planned) Live Log Analyzer
  • (Planned) Dynamic Compatibility Matrix

Installation

1. Ensure RimWorld, Harmony, Cumpilation, and RJW Menstruation are installed and enabled.
2. Download the latest release of this compatibility patch from [Link to Release/Workshop Page - TBD].
3. Place the mod folder in your RimWorld Mods directory or subscribe via the Steam Workshop.
4. Activate the mod in the RimWorld mod list.
5. Load Order: This is crucial! Ensure this patch loads after Harmony, Core, RJW, Cumpilation, and RJW Menstruation.

   Example Load Order (Hover over key mods):

   1. Harmony
   2. Core
   3. Royalty (if applicable)
   4. Ideology (if applicable)
   5. Biotech (if applicable)
   6. ... (Other Core/DLC Patches)
   7. RJW
   8. Cumpilation
   9. RJW Menstruation
   10. [This Mod] Cumpilation & RJW Menstruation Compatibility
   11. ... (Other mods)

How it Works

This patch uses the Harmony library to modify the behavior of Cumpilation and RJW Menstruation at runtime without altering their original code directly. This non-destructive patching approach maximizes compatibility and reduces the chance of conflicts with mod updates. Key areas of integration include:

• Fertility Synchronization: Patches ensure that fertility calculations consider the pawn's menstrual cycle status (fertile window, infertile phases from RJW Menstruation) alongside fertility modifiers from Cumpilation (e.g., effects of cum). Rules are established for how these factors combine or take precedence, configurable via Mod Settings.
• Pregnancy Consistency: Adjustments are made to pregnancy chance calculations. Factors like timing within the menstrual cycle, Cumpilation fluid effects (potency, volume), pawn traits/genes, and existing Hediffs are considered cohesively to prevent conflicting outcomes or double-counting modifiers. A unified check can be enabled.
• Hediff Harmonization: The patch manages how Hediffs from both mods interact. This might involve preventing redundant Hediffs, ensuring Cumpilation fluids don't inappropriately interfere with cycle progression (or defining specific interactions if intended and configured), and vice-versa. Compatibility-specific data might be stored using ModExtension or custom HediffComps.
• Event Handling: Relevant events from both mods (e.g., orgasm events, cycle phase changes) might be monitored or patched to trigger appropriate cross-mod effects or updates based on configuration.

The goal is seamless integration, making the two mods feel like they were designed to work together regarding these specific mechanics. Refer to the Configuration and Technical Details sections for more information.

graph TD
    A[Fertility Check Triggered] --> B{Is Pawn Ovulating? (RJW Menstruation)};
    B -- No --> F[Result: Infertile];
    B -- Yes --> C{Base Fertility + Genes/Traits};
    C --> D{Apply Cumpilation Fluid Effects? (Setting)};
    D -- Yes --> E[Apply Fluid Modifiers];
    D -- No --> G[Calculate Final Fertility Chance];
    E --> G;
    G --> H[Result: Final Fertility %];
            

Configuration

This mod includes optional settings accessible via RimWorld's main menu -> Options -> Mod Settings -> "Cumpilation & RJW Menstruation Compatibility". Default settings aim for logical and balanced integration, but you can customize the behavior.

Available options typically include:

• Enable Fertility Synchronization: (Default: On) Makes Cumpilation fertility effects respect RJW Menstruation's fertile/infertile windows.
• Fluid Affects Cycle: (Default: Off/Minimal) Allows configuration for Cumpilation fluid exposure to potentially influence the menstrual cycle (e.g., delay, severity). Requires careful balancing.
• Cycle Affects Fluid Effects: (Default: On) Allows the current phase of the menstrual cycle to modify the impact or absorption of Cumpilation fluids.
• Use Unified Pregnancy Check: (Default: On) Consolidates pregnancy chance calculations to prevent conflicts and ensure consistent application of modifiers from both mods.
• Fertility Boost Multiplier: (Slider/Input) Adjusts the impact of Cumpilation fluids on fertility during the fertile window.
• Enable Debug Logging: (Checkbox) Outputs detailed logs to the RimWorld debug console for troubleshooting.
• Configuration Presets: (Buttons) Load recommended settings or save/load custom configurations.

Always check the Mod Settings menu in-game for the most up-to-date options and their descriptions (tooltips). This web page provides a general guide.

Troubleshooting & FAQ

Compatibility

This mod is designed specifically to bridge Cumpilation and RJW Menstruation. Compatibility with other mods depends on their interactions with these core systems.

• Required Dependencies: Harmony, Core, RJW, Cumpilation, RJW Menstruation.
• Race Mods: Generally compatible. Patches aim to be race-agnostic, but races with highly unique reproductive mechanics (non-mammalian cycles, unusual fluid interactions) might have untested edge cases. Report issues.
• Biotech DLC: Supported. Interactions with genes affecting fertility, pregnancy, cycles, and fluid production are considered. Pollution and mechanitor implants should not directly conflict.
• Other RJW Addons:
  • RJW Children/Pregnancy: Should generally be compatible, as this patch focuses on fertility checks and cycle interaction, not the pregnancy Hediff itself once initiated (unless conflicts arise). Load order might matter.
  • SafeJobWorld: Likely compatible, as it focuses on job assignments.
  • Other addons modifying fertility/pregnancy Hediffs: Potential for conflict. Load this patch after other RJW addons unless specified otherwise.
• Mods Affecting Health/Hediffs: Generally compatible unless they directly modify the same fertility/pregnancy logic or Hediffs targeted by this patch (e.g., Hediff_MenstruationCycle, Hediff_Cum interactions).
• Performance Mods (e.g., RimThreaded): Compatibility is not guaranteed, especially with mods that heavily patch sensitive game logic like Hediffs and pawn state updates. Use with caution and report any threading issues.

If you encounter issues with a specific mod, please report it with details about the mod, load order, settings, and the observed behavior.

Known Issues

Please report any bugs or unexpected behavior you encounter via the issue tracker or mod page.

• Currently no major known issues.

Technical Details (For Modders & Advanced Users)

This section outlines the internal design and implementation approach.

Design Philosophy

The primary goal of this patch is seamless integration and user choice.

• Compatibility First: Aim to make Cumpilation and RJW Menstruation work together logically without fundamentally changing the core experience of either mod, unless necessary to resolve a direct conflict.
• Non-Destructive: Use Harmony patching to avoid modifying the original mod assemblies directly, improving compatibility with updates.
• Configurability: Provide clear options in Mod Settings to allow users to tailor the integration to their preferences, from minimal conflict resolution to deeper mechanical links. Default settings should represent a sensible baseline.
• Clarity: Ensure that the interactions, settings, and potential outcomes are clearly documented (via this web tool and in-game tooltips).
• Performance Conscious: Implement patches efficiently, avoiding unnecessary calculations in frequently called code paths (like `Tick`).
• Maintainability: Structure the code logically to facilitate updates and debugging as the core mods evolve.

The patch should feel like a natural extension, resolving inconsistencies rather than adding entirely new, complex systems.

Changelog

Contributing

Contributions are welcome! This includes reporting bugs, suggesting features, providing feedback, improving documentation, or submitting code changes (pull requests). Please check the mod's source repository ([Link to Repository - TBD]) for contribution guidelines (CONTRIBUTING.md) if available.

When reporting issues, please provide as much detail as possible:

• Clear description of the problem and expected behavior.
• Steps to reproduce the issue consistently.
• Your mod list (especially relevant mods like RJW addons, race mods, health mods). Use HugsLib for easy sharing.
• Your RimWorld debug log (see FAQ on how to share). Ensure this mod's debug logging is enabled if relevant.
• The settings you are using for this compatibility patch.