Creating Mounts

Introduction

A mount is an animal that the player rides. Mounts are bought from stables. Each mount have separated agility and resistance attributes that can be upped by leveling, and leveling is caused by gaining exp in fights or by training the mount in its stable. Each mounts have a specific stable that they can only be trained on. Each mounts also have specific feeding items that are used to feed them and get exp.

You can view your mount stats by using the Y key in-game. Since mounts are a complicated mechanic, it's recommended to check the Gameplay Guide to understand better.

Extra Data

In order to make the mount display correctly on the Y command menu, you'll need to create a <mount_id>.txt file where <mount_id> is the id id of the mount; in the imgs/ directory of the plugin. In this file, you'll put the ascii art of that mount with, if you want, yaml data color codes.

Explanation

Example of a mount definition:

Warg:
  name: Warg
  plural: Wargs
  gold: 59.36
  mph: 25
  feed:
    food:
    - Beef
    - Porkchop
    - Chicken
    feed needs: 3
  stable:
    required stable: Warg Stable
    stable slot usage: 3
  stats:
    agility addition: .35
    resistance addition: .15
  levels:
    max level: 25
    level stat additions:
      agility addition: .025
      resistance addition: .015
      mph addition: .25
  description: "Wargs are at first Yrch mounts but they can be tamed and then used to fight against Orks. Wargs are fast and agile mounts."

And the full syntax:

<mount id>:
  name: <displayed name(str)>
  plural: <displayed plural name(str)>
  gold: <base cost(float)>
  mph: <speed(int)>
  feed:
    food: <items id(list)>
    feed needs: <coefficient(int)>
  stable:
    required stable: <stable type(str)>
    stable slot usage: <slot usage(int)> # this is deprecated
  stats:
    agility addition: <agility stat addition(float)>
    resistance addition: <armor protection stat addition(float)>
  levels:
    max level: <maximum level(int)>
    level stat additions:
      agility addition: <agility stat addition per level(float)>
      resistance addition: <armor protection stat per level(float)>
      mph addition: <mph stat per level(float)>
  description: <a clear and concise description(str)>

Full explanation of all attributes:

• name // the name of this mount type.
• plural // the plural name of this mount type.
• gold // the base price in gold of this mount type. Can vary depending on the stable cost value where it is bought.
• mph // this is the base speed of this mount. The more it's higher, the mount the player will travel faster. Check the Traveling Time Handling wiki page for more information.
• feed
  • food // the list of items that the player can use to feed this mount.
  • feed needs // usually values between 1 and 5. 1-2 being small mounts and 3-5 carnivore mounts. The more its higher, the more the player will have to feed them to gain exp.
• stable
  • required stable // the name/type of stable that this mount can only be trained on. Checked with the stable stables key.
  • stable slot usage // this is a deprecated attribute so just put any values here.
• stats
  • agility addition // usually between .01 and .4. .01-.1 being slow mounts and .2-.4 agile mounts. This is base value that this mount has on level 0.
  • resistance addition // usually between .05 and .4. .05-.15 being weak/agile mounts and .2-.4 strong/big mounts. This is base value that this mount has on level 0.
• levels
  • max level // this is the maximum level that this mount can have.
  • level stats addition
    • agility addition // Usually tiny values around .01. The agility that this mount gain every time it levels up.
    • resistance addition // Usually tiny values around .01. The resistance that this mount gain every time it levels up.
    • mph addition // Usually tiny values around .15. The mph that this mount gain every time it levels yp;
• description // the description of the mount that is shown on Y menu.