RJW Cumpilation & Menstruation Compatibility Patch
A compatibility mod for the RimWorld mods "Cumpilation" and "RJW
Menstruation", which are sub-mods of RimJobWorld. This patch aims to
ensure smooth interaction between these mods and considers compatibility
with the wider RJW ecosystem.
Features
- Resolves direct conflicts between Cumpilation and RJW Menstruation.
-
Integrates relevant mechanics where overlap occurs (e.g., fluid
interactions, mood effects).
-
Adjusts definitions and patches to ensure both mods function as
intended when loaded together.
Installation
-
Ensure you have the required mods installed:
- RimJobWorld (RJW)
- RJW Menstruation
- Cumpilation
-
Subscribe to this mod on the Steam Workshop OR download the release
and place it in your RimWorld
Mods
folder.
- Activate the mod in the RimWorld mod list.
-
Recommended Load Order:
- Core
- Royalty (if applicable)
- Ideology (if applicable)
- Biotech (if applicable)
- Anomaly (if applicable)
- RimJobWorld (RJW)
- RJW Menstruation
- Cumpilation
-
RJW Cumpilation & Menstruation Compatibility Patch
(This Mod)
- Other mods
Compatibility
-
Required: RimJobWorld, RJW Menstruation, Cumpilation.
-
Designed For: RimWorld versions 1.4, 1.5 (Specify
supported versions).
-
Known Incompatibilities: None currently known. Please
report any issues.
Design Ideas & Considerations
-
Configuration Options: Implement Mod Settings options
to allow users granular control. This could include toggling specific
integration features (e.g., fluid interactions, mood stacking) or
adjusting balance parameters.
-
Fluid System Integration: Ensure Cumpilation's fluid
generation, detection, and cleaning systems correctly account for and
interact with menstrual blood from RJW Menstruation without
duplication or conflict. Explore potential cross-mod fluid effects
(e.g., specific Cumpilation fluids influencing cycles, or
vice-versa), being mindful of balance and scope.
-
Hediff & Mood Interactions: Review and harmonize
Hediffs (health conditions) and mood effects from both mods. Ensure
effects stack logically or implement specific interaction rules to
prevent unintended consequences (e.g., excessive mood debuffs).
Consider if Hediffs from one mod should influence the triggers or
severity of effects from the other.
-
Hygiene & Cleaning Integration: Verify that cleaning
mechanics (from Cumpilation or other hygiene mods) properly handle
fluids generated by both mods. Potentially add specific patch support
for popular hygiene mods.
-
Trait & Gene Compatibility: Ensure compatibility with
relevant traits or Biotech genes introduced or affected by either mod.
Address how combined genetic or trait effects should manifest.
-
Mechanic Balancing: Continuously evaluate the
combined effects of patched mechanics. Ensure they remain balanced
within the core RimWorld gameplay and RJW's systems, avoiding
unintended buffs, nerfs, or exploits.
-
Expanded RJW Ecosystem Compatibility: Proactively
investigate and address potential interactions or conflicts with other
popular RJW sub-mods (e.g., Fertility, Sexperience, Hygiene).
Consider expanding the patch scope if significant overlaps are found.
-
Patching Strategy: Prioritize XML XPath patching for
robustness and maintainability. Utilize
PatchOperationFindMod
rigorously to ensure patches only
apply when necessary mods are active. Consider conditional patching
logic based on the presence of other related mods.
-
Performance: Maintain focus on performance. Keep XML
patches targeted and efficient. If C# becomes necessary, profile
carefully to avoid performance degradation.
-
User Experience & Documentation: Ensure patched
interactions feel intuitive and seamless. Improve in-game tooltips or
descriptions where mechanics are integrated, clarifying the combined
effects for the user.
-
Code Structure (If C# becomes necessary): If C# code
is required for future features, adhere to best practices: maintain
clear separation of concerns, use Harmony patching effectively and
safely, and include comments explaining complex logic.
Future Plans
- Address any reported compatibility issues promptly.
-
Investigate potential integrations with other relevant RJW add-ons
based on user feedback.
- Refine existing patches for better balance or smoother interaction.
- Expand Mod Settings options based on user requests.
Contributing
Contributions are welcome! Please feel free to fork the repository, make
changes, and submit a pull request. You can also report issues or
suggest features via the GitHub issue tracker.
License
[Specify License - e.g., MIT, Creative Commons]