[Legacy] Equus: Wild Horses

Gait System

With version 1.1.0 we've added a custom gait system that more closely matches how real horses move compared to the vanilla mount system.

Horse gaits are as follows:

• Walkback
• Idle
• Walk
• Trot
• Canter
• Gallop

 

They are progressive in that you must move through each gait to get to the next, cycling gait up is done via the Sprint Key (see controls section for more details). Cycling down can be done with the S key or by releasing the forward key when using the snaffle bit.

Walk / Walkback / Idle
Trot
Canter
Gallop

 

Stamina System

All horses have stamina, at this time the amount of stamina is fixed and consistent but we may evaluate extending the genelib utilization for stamina based attributes at some point.

Max Stamina is currently set to 100, galloping and swimming both drain stamina. Stamina is regenerated when not in either of those situations, but a regen penalty is applied if the horse is mounted or injured (below 70% health).

All aspects of the stamina system are configurable in the ModConfig (equus.json) including, max stamina, fatigue costs, regen rates, and regen penalties.

When a horse's stamina is below 50% there is a chance that the horse will stop galloping that is quadratically proportional (chance increases more dramatically as the stamina decreases) to the stamina percentage below 50%.

(i.e. At 50% stamina, 0% chance; at 0% stamina, 100% chance)

If the horse stops galloping it will reduce to a canter if remaining stamina is greater than 10%, or to a trot if below 10%.

If stamina fully drains while swimming, nothing will occur (don't worry about drowning) but it signficantly reduces your ability to gallop upon exiting the water.

HUD Items

With the addition of the Gait System and Stamina Behavior for Horses you'll find that when mounted there are two additional HUD items visible.

 

Gait Indicator: This icon is a dynamic image that changes with your horse's gait to help give a visual indicator of your current gait.

Stamina Bar: The stamina bar shows your horse's current stamina level, if the stamina level drops below 30% the bar will flash

The placement for the gait indicator and stamina bar are fully configurable from the mod config file. 

StaminaBarLocation can be any of the following:

• "AboveHealth"
• "AboveHunger"
• "AboveTemporal"

 

StaminaBarOffsets are then applied as x/y values from that location.

Please be aware other mods may share this location and offsets may need to be applied when working with mods such as Hydrate or Diedrate or Rustbound Magic.

 

Default Locations:

Controls

Snaffle Bit:

W: Hold to move forward, release to stop

A/D: Left/Right

S: Press without releasing W to decrease gait -OR- from idle walk back

Sprint Key (Default Ctrl): Increase gait, when galloping this key will also swap back and forth between canter and gallop

 

Curb Bit:

W: Press to move forward

A/D: Left/Right

S: Decrease gait -OR- from idle walk back

Sprint Key (Default Ctrl): Increase gait, when galloping this key will also swap back and forth between canter and gallop

Config

The config file is automatically generated at runtime in VintagestoryData/ModConfig/equus.json. 

Default Config File Below:

{
    "EnableStamina": true,
    "GlobalMaxStaminaMultiplier": 1.0,
    "GlobalStaminaRegenMultiplier": 1.0,
    "GlobalSwimStaminaCostMultiplier": 1.0,
    "GlobalSprintStaminaCostMultiplier": 1.0,
    "HideStaminaOnFull": false,
    "StaminaBarLocation": "AboveHealth",
    "StaminaBarWidthMultiplier": 1.0,
    "StaminaBarXOffset": 0.0,
    "StaminaBarYOffset": 0.0,
    "ShowHudIcon": true,
    "IconOffsetX": -400.0,
    "IconOffsetY": -99.0,
    "IconSize": 42.0,
    "DebugMode": false
}​

Spawn Conditions

"climate": {
    "minTemp": -10,
    "maxTemp": 40,
    "minRain": 0.1,
    "maxRain": 0.8,
    "minForest": 0.0,
    "maxForest": 0.6,
    "maxShrubs": 0.9				
}

Biomes Mod Locations

Central paleartic, atlantic paleartic, eastern paleartic, pacific neartic, atlantic neartic

FAQ (1.20)

Q: Are they tamable?
A: I'm waiting on the elk taming mechanic for this, so currently they're ridable from the get go. As with most creatures domestication does make them more tame.

Q: I'm getting a json patch error on load related to the bedroll?

Patch 2 (target: game:blocktypes/wood/bed.json) in equus:patches/attachment-patch.json failed because supplied path /attributesByType/bed-hay-*/attachableToEntity/attachedShape is invalid: The json path /attributesByType/bed-hay-*/attachableToEntity/attachedShape was not found. Could traverse until /attributesByType/bed-hay-*/attachableToEntity, but then 'attachedShape' does not exist. Full json at this path: {
"categoryCode": "bedroll"
}
A: This error is expected and ok to ignore, we are working on finding a workaround for this.

Q: The horse keeps moving when using the curb bit even after I let off the controls!
A: This is the intended behavior of the curb bit for both vanilla elk and horses, think of it like autorun :)

FAQ (1.21)

Q: Are they tamable?
A: Yes! they use the saddlebreak mechanic the vanilla elk now uses, except any horse can be tamed (instead of only "partially tamed" ones like the elk)

Q: My dragon/horse/unicorn/elk disappeared what do I do?
A: 
Copying from (this message) with adjustments:

Browse to VintagestoryData/Logs and check the client-audit.log file (not server-audit), looking for something like this:
[Audit] tRead closed held bag inventory mountedbaginv-6-882040812 on entity 882040812/Tamed Elk (male)
I use Ctrl+F to search for "tamed".
If it's empty, check the Archive subfolder too: VintagestoryData/Logs/Archive

If you find the elk's entity ID, ask an admin of the server to teleport that entity to you, like so:
/tp e[id=882040812] tRead
If not, see step below.

If the logs yield no entity ID, ask a server admin if they're willing to check the server logs.

Server logs:
Browse to VintagestoryData/Logs and check the server-audit.log file, looking for something like this:
[Audit] tRead dismounts/disembarks from a tameddeer-elk-male-adult at 536375, 131, 511375
I use Ctrl+F to search for "tamed".

Teleport to that location. Note that coordinates in the 500k range are not relative to World Spawn, so it's important to use = in the tp command. Example:
/tp =536375 =131 =511375