RimWorld Mod Compatibility: Cumpilation & RJW Menstruation

A compatibility mod ensuring features from "Cumpilation" and "RJW Menstruation" work together seamlessly. This page provides documentation and troubleshooting help.

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.

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.
  • (Planned) Optional configuration settings via the Mod Settings menu to customize integration behavior.

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] (Link 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:

    Harmony
    Core
    Royalty (if applicable)
    Ideology (if applicable)
    Biotech (if applicable)
    ... (Other Core/DLC Patches)
    RJW
    Cumpilation
    RJW Menstruation
    [This Mod] Cumpilation & RJW Menstruation Compatibility
    ... (Other mods)

How it Works

This patch uses Harmony to modify the behavior of Cumpilation and RJW Menstruation at runtime without altering their original code directly. This approach maximizes compatibility. Key areas of integration include:

  • Fertility Cycles: Patches ensure that fertility calculations consider the pawn's menstrual cycle status (from RJW Menstruation) alongside factors from Cumpilation.
  • Pregnancy Chance: Adjustments are made so that pregnancy chances reflect the combined logic, such as the timing within a cycle and the presence/effects of cum (from Cumpilation).
  • Hediff Interaction: The patch manages how Hediffs from both mods interact. For example, it might prevent duplicate effects or ensure that fluid Hediffs from Cumpilation have appropriate interactions (or lack thereof) with the menstrual cycle Hediff from RJW Menstruation.
  • Fluid Logic: Ensures consistency in how fluids are handled where both mods might have overlapping concerns.

The goal is seamless integration, making the two mods feel like they were designed to work together regarding these specific mechanics.

Configuration

Currently, this mod works automatically in the background with no required configuration.

Planned Features: Future versions may include optional settings accessible via RimWorld's main menu -> Options -> Mod Settings. Potential options might allow:

  • Toggling specific integration features on/off.
  • Adjusting multipliers or thresholds for certain interactions.
  • Enabling detailed debug logging for troubleshooting.

Check the Mod Settings menu after updates to see if configuration options have been added.

Troubleshooting & FAQ

  • Q: I'm getting errors after installing this mod.

    A: The most common cause is incorrect load order. Double-check that this patch loads after Harmony, Core, RJW, Cumpilation, and RJW Menstruation. See the Installation section for an example. If the load order is correct, check for conflicts with other mods or report the issue with logs.

  • Q: Does this mod add new content?

    A: No, this is purely a compatibility patch. It modifies existing mechanics from Cumpilation and RJW Menstruation to work together but doesn't introduce new items, events, or major features itself.

  • Q: What happens if I don't use the correct load order?

    A: Incorrect load order can lead to errors (often visible in the debug log), unexpected gameplay behavior (like fertility not working as expected), or the patch simply not having any effect. Always ensure this mod loads *after* both Cumpilation and RJW Menstruation.

  • Q: Is this compatible with [Other Mod Name]?

    A: Compatibility with other mods depends on what they modify. This patch primarily targets methods related to fertility, pregnancy, and specific Hediffs from Cumpilation and RJW Menstruation. Mods that heavily alter these same systems might conflict. If you suspect a conflict, please report it.

  • Q: Where can I find the debug log?

    A: RimWorld's debug log can be enabled in the game's Options menu (Development Mode). Errors related to mods often appear there, especially on startup or when specific events occur. You can find the log file itself in your RimWorld configuration folder (location varies by OS).

Contributing

Contributions (bug reports, suggestions, code) are welcome! Please refer to CONTRIBUTING.md (if available) for guidelines or check the mod's source repository (e.g., on GitHub). Reporting issues with clear steps to reproduce and including logs is highly appreciated.