About this mod
This is a LUA (script) mod that tweaks some of the game's breeding mechanics to be less random. It comes with a config file where players can adjust the extent of the changes and turn off/on optional features.
- Requirements
- Permissions and credits
- Changelogs
- Donations
a lua script mod by stahl-tier
Disclaimer: Please always remember that mods can cause your game to crash or your savefiles to be corrupted. Mods may stop working after a game update. LUA scripts generally contain failsafes and error handling to prevent crashes if possible, but it's your own responsibility to make backups of your save files in case something goes wrong. Please don't report problems with mods in the game's regular bug reports channel.
UPDATE (March 9th): I fixed the bay spam problem, please download the newest version of the mod. Croam-Roans are not yet added, but will be with the next update (along with some QoL additions).
What does this mod do?
If you've ever tried to breed a horse that has a particular coat and a particular pattern and luck decided to not be in your favor, you may have run into a frustrating problem: Whenever the game decides what the coat and pattern of a foal will be, it picks those randomly from a "pool" of coats and patterns based on the "category" of the parents' coats and patterns.
Another possible frustration arises if you try to breed a flaxen horse to a silver horse and end up with a foal that has neither. Or perhaps you were breeding for that beautiful buttermilk buckskin horse with the same tobiano pattern as both its parents, but the game instead gives you perlinos, normal buckskins, and basically every single other variant of the tobiano pattern instead of the one you wanted.
Also, your horses trust you as far as they can throw you and so they refuse to even breed at all for five days in a row...?
Does this sound like things that have happened to you while playing and has your experience been anything but cozy because of it?
Fear not, this mod will solve all of these problems.
Just with this one mod, you will now be able to control the amount of bad luck when breeding or even completely take luck out of the equation. Check out these sweet....
...Features!
- The game will now be forced to give the foal the exact same coat as either the mom or the dad 80% of the time. (value can be adjusted)
- The same goes for patterns! The game now has to pick the exact same pattern variant as one of the parents 80% of the time.
- If one parent has a flaxen mane and the other parent has a silver mane, the foal will now have a 70% chance to inherit either flaxen or silver depending on its coat, instead of a 75% chance to inherit neither! (value can be adjusted and the feature can be turned off altogether)
- If you turn on the optional DoubleCreamFix feature, the game will be picking the cream-based coats much less randomly, meaning that your chances of getting a double cream dilute coat (aka Perlino, Cremello, Smokey Cream) will be much higher if both parents are at least single dilute cream (aka Buckskin, Palomino, Smokey Black). Additionally, if the foal's coat is not the exact same as its parents', it will instead only pick a double or single dilute variation according to its base color. (values can be adjusted and feature is turned off by default but can be turned on)
- NEW IN v1.5: You can now directly set the chance of a "combined" coat (tovero, pinaloosa) happening when you breed the appropriate parents together.
- NEW IN v1.5: As an optional feature, when breeding tovero/pintaloosa and tobiano/tovero/pintaloosa horses together, the chance of the foal having tobiano will be increased to reflect the higher "amount" of tobiano blood in the parents.
- NEW IN v1.5: With the split feature, your pintaloosa and tovero horses can now have tobiano/overo/appaloosa foals and you can set the chance for this to happen directly in the config.
- Lastly, you now have the option to set the % of the breeding success directly. The horses' trust stat (and other possible hidden values?) will no longer affect this. If you set it 100%, the mare will get pregnant in the first night no matter what. If you'd rather roleplay having a genetically impaired herd, you could also set it to 20% or something instead, I guess. Point is, you're in control now. (optional, feature is disabled by default)
- NEW IN v.1.6: The mod now handles the new Dun-Cream coats as well. There's new entries in the config file that let you decide if you want dun-cream coats to possibly split back up into dun or cream on the foal and set the chance for this to happen via a percentage. There's also an experimental toggle for the DoubleCream Fix feature to consider these coats as single cream dilutes (may not work 100% of the time, I didn't have enough time to thoroughly test this rather complex part of the code's mod)
In order to adjust the values and to turn on/off the various features of this mod, it comes with a config file that you can simply edit to your liking.
How To Install
- Download and install UE4SS if you haven't already. When you try to download the BreedingTweaks mod, Nexusmods will show you a popup with a link to the UE4SS mirror page where you can download it and find instructions on how to set it up correctly. Only proceed with installing BreedingTweaks once you have confirmed that UE4SS is correctly installed for your game.
- Download BreedingTweaks. It comes in a zip archive. Extract all the files inside the archive to a place in your computer where you can access them easily, so that you have the folder called BreedingTweaks.
- Ensure the folder has the following contents: a text file called "enabled.txt", another called "help.txt", a folder called "Scripts", and inside the Scripts folder, there are two files called "main.lua" and "config.lua". Don't delete or rename any of these or the mod will no longer work correctly.
- While you're there, feel free to open the file config.lua with a plain text editor or code editor like Windows' default Editor app. Don't use a word processor program like Microsoft Word or Google Docs for this, as it will add formatting to the file that makes the mod stop working. The config file contains information about what the values inside mean and how to change them according to your personal preferences. If you made any changes, save this file with the .lua file extension and the exact same file name. It MUST be config.lua, not config.txt or config.lua.txt or anything else. Look up how to enable showing file extensions on Windows if you see the file being called only "config" without the .lua part.
- Now go to your Steam library, right-click on Ranch of Rivershine, and click "Browse local files". A window will open where you see the game's executable and a folder called TheRanchOfRivershine.
- Open the folder TheRanchOfRivershine, then open the folder called Binaries, then the one called Win64. This should be familiar to you since you navigated to the same location when you installed UE4SS.
- You should now see yet another executable of the game, a bunch of other files from UE4SS, and a folder called "Mods". If you don't see that folder, UE4SS wasn't installed properly. Please fix it before proceeding.
- The mod goes into the Mods folder, where there should already be a handful of other folders (UE4SS comes with some default mods).
- You can now start the game. The mod should work now, but if you want to be extra sure, press Ctrl+O, this will bring up the UE4SS console where you can see all the debug messages and output. It should show a message there somewhere that confirms that BreedingTweaks was loaded.
Known Issues & Notes
The way the mod works is that every so often, it checks for horses that are exactly 1 day old and not born yet. Foals are created in the game's data during the night where the mare becomes pregnant. The mod checks the fertility pasture's data for the unborn foal's parents and changes the foal's data accordingly to the mod settings. Sometimes, timing issues when the game loads into your savefile can cause the mod to trip up and stop working. This doesn't crash the game, but will prevent the mod's effects from being applied. Sometimes, the game "forgets" the parents of the foal and then the mod cannot read their data, obviously. I don't know why this happens, it may be a bug. Again, nothing catastrophic happens in that case, the mod will simply output a message about it in the console and move on, but it means that foal in particular will not be affected by the mod.
So basically, this mod can sometimes stop working or run into problems if the game does strange things, but it shouldn't cause any crashes or bad side effects. If the mod encounters these problems, the breeding will simply work normally as if the mod wasn't present.
Restarting the game on the morning where you get the notification that a mare is pregnant means that the mod will attempt to change the foal again. This isn't a problem or bug honestly, but it means that if you restart the game on that same in-game day multiple times, the foal will be reset to its "original" coat and then re-adjusted by the mod every time. It may lead to different results if there's any random chances below 100% involved. So I guess you could treat it as a "re-roll" trick.