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.

This web page serves as the companion documentation and helper tool.

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.
This interactive web-based helper tool for documentation and troubleshooting:
- FAQ Search/Filter
- Interactive Load Order Example
- (Planned) Configuration Simulator
- (Planned) Logic Flow Visualizer
- (Planned) Troubleshooting Wizard

Installation

Ensure RimWorld, Harmony, Cumpilation, and RJW Menstruation are installed and enabled.
Download the latest release of this compatibility patch from [Link to Release/Workshop Page - TBD].
Place the mod folder in your RimWorld Mods directory or subscribe via the Steam Workshop.
Activate the mod in the RimWorld mod list.
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 (Technical Details)

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, potentially 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.
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 on Defs.
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 section for details on how you might customize these interactions (when available).

Configuration

Currently, this mod works automatically in the background with no required configuration. Default settings aim for logical and balanced integration.

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

Toggling specific integration features (e.g., "Sync Fertility Windows", "Fluid Affects Cycle").
Adjusting multipliers or thresholds for certain interactions (e.g., "Fertility Boost Multiplier from Cum during Fertile Window").
Selecting integration presets (e.g., "Recommended", "Minimal").
Enabling detailed debug logging for troubleshooting.

Check the Mod Settings menu after updates to see if configuration options have been added. This web page will also be updated to reflect available settings.

Configuration Simulator (Planned)

This section will allow you to select hypothetical mod settings and see explanations of the resulting gameplay effects.

Troubleshooting & FAQ

Search FAQ:

Q: I'm getting errors after installing this mod. What should I do?

A: The most common cause is an incorrect load order. Please double-check that this compatibility patch loads after Harmony, Core, RJW, Cumpilation, and RJW Menstruation. See the Installation section for the correct order. If the load order is correct, check RimWorld's debug log (enable Development Mode in Options) for specific error messages. Report the issue on the mod page ([Link to Issues/Workshop - TBD]) with your log file (e.g., using HugsLib's log sharing feature).

Q: Does this mod add new gameplay features or content?

A: No, this is purely a compatibility patch. It modifies existing mechanics from Cumpilation and RJW Menstruation to ensure they work together correctly. It does not introduce new items, Hediffs, events, or major gameplay systems itself.

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

A: Incorrect load order can lead to various problems: errors during startup or gameplay (check the debug log!), features not working as expected (e.g., fertility calculations being wrong, conflicts not being resolved), or the patch simply having no effect at all. The correct load order is essential.

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

A: Compatibility depends on what the other mod changes. This patch primarily targets methods and Hediffs related to fertility, pregnancy, and specific fluid/cycle mechanics within Cumpilation and RJW Menstruation. Mods that heavily modify these same systems might conflict. It's generally compatible with mods that don't touch these specific areas. See the Compatibility section for more details. If you suspect a conflict, please report it with details.

Q: How do I find and share my debug log?

A: First, enable "Development Mode" in RimWorld's Options menu. If errors occur, a log window might pop up, or you can open it with the ` key (tilde/backtick, usually left of '1'). For sharing, the best way is to use the HugsLib mod, which adds a green "Share Logs" button in the log window. Click it and share the provided link. Alternatively, you can find the Player.log file manually in your RimWorld configuration folder (location varies by OS - search online for "RimWorld Player.log location [your OS]").

Q: Will this mod affect performance?

A: The mod uses Harmony patching, which is generally efficient. Patches are applied at startup. While any mod adds some overhead, this patch is designed to be lightweight and should have minimal impact on performance during gameplay. Performance-intensive calculations are avoided where possible. If performance issues arise, check for conflicts with other mods first.

Compatibility

This mod is designed to work alongside Cumpilation and RJW Menstruation. It patches specific interactions between them.

Race Mods: Generally compatible, but races with highly unusual reproductive systems might have untested interactions. Patches aim to be race-agnostic where possible.
Biotech:** Interactions with genes affecting fertility, pregnancy, and related mechanics are considered, but complex gene combinations might lead to edge cases.

Other RJW Addons: Compatibility varies. Addons modifying pregnancy, fertility, or Hediffs patched by this mod (e.g., Hediff_Cum, Hediff_MenstruationCycle) might conflict. Load order might be important.

Mods Affecting Health/Hediffs: Generally compatible unless they directly modify the same fertility/pregnancy logic or Hediffs targeted by this patch.

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

Mod Compatibility Matrix (Planned)

This section will eventually list known compatibility statuses with specific popular mods.

Known Issues

Currently, there are no major known issues. Please report any bugs you encounter via the issue tracker or mod page.

Changelog

v1.0.0 (Initial Release) - YYYY-MM-DD

Initial release providing basic compatibility patches.

Synchronized fertility windows between RJW Menstruation cycles and Cumpilation effects.

Resolved initial Hediff conflicts related to pregnancy chance.

Created initial documentation web page with FAQ and load order guide.

Contributing

Contributions are welcome! This includes reporting bugs, suggesting features, providing feedback, 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.

Steps to reproduce the issue.

Your mod list (especially relevant mods like RJW addons, race mods, health mods).

Your RimWorld debug log (see FAQ on how to share).