Sire VLC Scripts - Horse Breeding Script

This breeding script is designed exclusively for sirevlc horses and will not function with any other horses script.

The Breeding Script introduces a realistic genetics-based breeding system where you can allow or restrict access to breeding, with optional player and job lock options.

Players can start breeding by selecting one owned adult stallion and one adult mare, the foal’s gender is then revealed and you can name it. The foal's coat is calculated using our Breeding Engine that identifies possible coat outcomes depending on the parent's genetics.

The foals traits such as model, scale, breed, category, stats, value, personality, and weather sensitivity are inherited randomly from both parents (or averaged if configured).

The mare then enters pregnancy and the foal progresses through five phases, from gestation to adulthood, with configurable phase durations and an optional aging system takeover at maturity.

Foals become visible and manageable after birth, can be sold from Phase 1, trained and ridden from Phase 3, and are moved to the Owned Horses menu at adulthood. Offspring are classified as purebred when both parents share the same breed, or mixed when they do not, with all progress, parent data, and cooldowns accessible through the breeding management menu.

BREEDING

Features

★ Each stable can be configured to allow or deny access to the breeding system menu.

★ The breeding system menu can be player-locked and/or job-locked.

★ The breeding menu contains three options:

Create – Start the breeding process.

Manage – View and manage ongoing breedings and foals.

Check Cooldown – See remaining cooldowns for unborn foals.

Breeding Process Overview

★ Select Parents: Choose one adult stallion and one adult mare from your owned horses.

★ Payment & Naming: A cost check is performed, then the foal can be named. The foal’s gender is revealed at this stage.

★ Coat Calculation: The foal’s coat is determined using the breeding calculation engine based on the parents’ data. The system uses the BREEDING_COLOR and BREEDING_RESULT parameters from the sirevlc_horses breed configuration, searches for matching results, and randomly selects and applies the coat and tint values.

★ Inherited Elements: Traits inherited from one parent include model, scale, breed name, category number, stats (or averaged stats if enabled), selling price, personality, and weather sensitivity.

★ Pregnancy & Phases: The mare becomes pregnant and the foal enters the breeding phases. Default duration is 30 minutes per phase (configurable). If the aging system is enabled, it takes over at adulthood.

★ Restrictions: Pregnant mares cannot be sold. If a mare dies of old age during pregnancy, the foal is lost. Foals can be sold starting at Phase 1. Breeding cooldown begins after a successful breeding and lasts until adulthood.

★ Foal Display: Once born, the foal appears in the Manage menu.

★ Breed Classification: Foals are purebred if both parents share the same breed, or mixed if they do not.

Manage Menu

In the Manage section, you can view the foal’s parents, their information, and, once born, all foal details. There are five breeding phases:

★ [0] Phase 0 – Gestation Period: The mare is visibly pregnant and can still be used and healed at the stable. If she dies of old age during this phase, both mare and foal are lost. The mare cannot be sold while pregnant. A notification is sent when the foal is born.

★ [1] Phase 1 – Weanling: The foal is visible with its parents, can be called outside, cared for, and will follow the player.

★ [2] Phase 2 – Yearling: Larger than Phase 1, but still not rideable.

★ [3] Phase 3 – Youngster: Large enough to begin training and can be ridden, but not fully grown.

★ [4] Phase 4 – Adult: Fully grown and moved to the Owned Horses menu. If the aging system is enabled, it takes over at this stage.

Cooldown Check

★ Displays the remaining cooldown time for each unborn foal.

EXPLAINING OUR GENOTYPE SYSTEM

➨ We went for a realistic system, meaning that just like in real life, genes work kind of like onions. There are "layers" to them if you will.

1. To simplify the explanation to the max:

As in real life, horses have a base color (red - black - bay) as a first "layer" and to that other genes can get added on, creating multiple layers.

Example: A Buckskin horse has a base coat color of "Bay" + one "Cream" gene which dilutes certain parts of the coat and that gives you a Buckskin.

So the genotype is "Bay + Cream" basically.

➨ That makes up your base coat.

To that, you then can have pattern coats (genes that "add on" elements, for example the Tobiano gene that gives you white markings usually starting from the shoulder down !)

So the genotype of this particular imaginary horse would be "Bay + Cream" (base) + "Tobiano" (pattern) = Buckskin Tobiano which is considered a pattern coat in our engine.

➨ That makes up your final coat genotype (base + pattern) = Buckskin Tobiano (b_cr_to).

HOW GENETICS WORK

➨ Just like in real life, when you cross two different genotypes, you can end up with a random selective mix of all of the possible out-comes from the genes that are involved.

Example: If I cross a

Buckskin mare (Bay base + Cream - so solid coat no pattern)

with a

Smoky Cream Tobiano Stallion (Black base + Cream + Cream + Tobiano - so pattern coat)

Our foal will have:

A base color of either red, bay or black foal (since Bay genes in our system are the most versatile as they are carriers of all three coat possibilities)

A base color of either red, bay or black with a single cream dilute (Palomino, Buckskin or Smoky Black) OR a double dilute (Cremello, Perlino or Smoky Cream) !

and

you have a 50% chance of getting either a simple Solid coat or a Tobiano pattern coat since one of the parents has a Tobiano pattern.

As you can see, the genes of both parents are taken into account. All possible variables were researched and written by hand to ensure you have as many results as possible depending on the gene mixes !

You will be able to find a full list of all base coats and their genotypes + all of our pattern coats and their genotypes in GENOTYPES AND COATS.txt file in sirevlc_breeding.

▬▬▬▬▬▬▬▬▬

CUSTOM COATS BEING USED BY THE BREEDING ENGINE:

When you make a new coat and want it to be in the breeding system, there are two ways to choose from:

➨ [1] Create your coat in the customizaton menu, choose an existing genotype you think suits the coat you made directly in the gentoype selection menu, and add the horse and it's genotype into sirevlc_horses/CONFIG/BREEDS.lua by creating a new line in the chosen breed category !

This horse will be usable by our CONFIG Breeding Engine.

➨ [2] Create your coat in the customizaton menu, choose an existing genotype directly in the gentoype selection menu. Once the horse is purchased it automatically enters into the Player Database (is this feature is enabled in the config)

This horse will be usable by our PLAYER DATABASE Breeding Engine.

▬▬▬▬▬▬▬▬▬

⚠ LIMITATIONS

Our breeding system is inspired by real equine genetics, but due to in-game restrictions, it is not 100% representative of real-life genetic outcomes.

Not all real-world genetic combinations could be added because the game has fixed coat patterns and fixed color palettes.

Only a selection of existing coats and patterns could be implemented.

Some coats may not perfectly match their real-life counterparts.

▬▬▬▬▬▬▬▬▬

WHAT COLORS/PATTERNS CARRY OTHER COLORS ?

There is no exact guide to what gives what. However for individual searches:

The red gene carries only red
The black gene carries black and red
And the bay carries bay, black and red

Other color genes (such as cream, silver, grey etc) add on to these base genes, and then pattern genes are added on to that. So to answer this question, to find out what colors carry over, it all comes down to the base gene.

You have to look at your genotype to see the possibilities. In our breeding script, the PHENOTYPE (all of the horse's observable characteristics) are almost always the same as the GENOTYPE (set of genes that it carries).

For exemple:

B_Z_TO (bay + silver + tobiano) BAY

The most important gene here is the bay because that determines if you will get either a black, bay or red base coat foal.

then add on SILVER

This is a secondary gene that is added onto your base color, it will modify said base color (for example the silver gene lightens the base color and turns hair cream/white).

You get a certain amount of chance of the Silver gene porting over here IF the foal is black or bay. Silver doesn't show up on red coats, that's why in the full list of all of our possible genotypes you will only see BL_Z or B_Z since as said above, our breeding script's genotypes follows the phenotypes.

then add on TOBIANO

This is the pattern gene, no color involved. You get a 50/50 chance of getting a tobiano if the other parent isn't a carrier of this gene.

So to answer this question, if you want to know what possible foal colors you can get (note that there ARE a few exceptions) just look at the genotype and break it down ! Your foal will be a combination of both parents so possibilities expand the more genes are involved.

A Black stallion (BL) and Bay mare (B) will have much less foal possibilities than a Gold Cream Champagne Leopard stallion (R_CR_CH_LP) and a Flaxen Chestnut Splashed White mare (R_FLX_SW) !

COMING SOON