Tameful

(Fabric)

Tame (almost) any animal with a lead. Pets follow you, stay, relax at home, fight
for you, carry you, and never die for good.

----------------------------------------------------------------
FEATURES
----------------------------------------------------------------
Taming
- Put a lead on any animal that isn't hostile (bats too) and choose Yes in
  the popup. The lead is used up (setting). No just leaves it on the lead.
- Wolves, cats, horses and other animals you can already tame still tame the
  vanilla way too.
- Pandas and turtles can now be put on a lead, so they can be tamed.
- Not tameable: happy ghasts, trader llamas (they belong to the wandering
  trader), and water creatures that die on land (axolotls, nautiluses, fish,
  squid, dolphins).

New recipes
- 3 string in a diagonal = 1 lead.
- Saddles can be made from rabbit hide or wool instead of leather, and with a
  copper ingot instead of iron (same shape as the vanilla saddle).

Controls
- Right-click your pet with an empty hand: Follow / Stay. Wolves, cats and
  parrots really sit; other animals stop in place. On horses and saddled
  animals, sneak + right-click.
- Right-click your pet with a stick: open the pet screen.

The pet screen
- Name: shown above the pet with its health, for example "Rex ❤ 32/40".
- Mode: Follow, Stay, or Relax (stays around the spot where you chose Relax).
  - Following pets come with you when you teleport, throw an ender pearl or
    change dimension.
  - Relaxing pets just live their normal animal life near home, and are walked
    back only if they stray. A barn full of them costs about the same as wild
    animals. They don't look for fights but defend themselves.
- Attitude:
  - Passive: never fights.
  - Defensive: fights whoever hurts you or the pet, and whatever you attack.
  - Aggressive: also attacks mobs that are after you or the pet (except
    creepers).
- Wander: how far a relaxing pet roams (6 / 12 / 24 blocks).
- Range: how far an aggressive pet looks for enemies (8 / 16 / 24 blocks).
- Ride: climb on and ride (see Riding).
- Release: asks first, then turns the pet back into a normal animal. Its
  saddle and armor go back into your inventory.
- Status: health, mode, distances and recovery time.

Riding
- Every pet can be ridden. Steer with WASD, jump with Space, get off with
  Shift. Pets climb 1-block steps on their own.
- Every pet rides as fast as a wolf runs (8 blocks/second), even animals from
  other mods.
- In water, hold Space to swim up.
- Flying pets (bees, parrots, bats) fly like swimming: look down to dive,
  look up to climb, and Space rises straight up. They fly for 10 seconds,
  glide down until they land, then rest for 10 seconds (settings).
- Saddle animals (horses, camels, llamas, nautiluses, pigs, striders) ride the
  normal vanilla way.

Health
- Every pet has at least 40 max health, like a tamed wolf.
- Every pet walks, follows and fights at a wolf's speed on land.
- Every pet swims instead of sinking.
- Pets heal 1 health every 2 seconds after 10 seconds out of combat.
- Pets never die (setting): at 0 health a pet rests for 30 seconds instead. It
  won't move or fight, and heals while resting. /kill and the void still
  remove pets.
- Pets don't hunt on their own: a pet wolf leaves sheep alone and a fox
  leaves chickens alone. They only fight through their Attitude.
- Aggressive pets leave other players' pets alone unless those attack.
- Wild animals can still hunt pets.
- In water, pets swim at their own pace.
- Releasing a pet puts its health, speed and hunting back to normal.

Animal by animal
Vanilla abilities keep working on pets: milking, shearing, dyeing, chests on
donkeys and mules, eggs, chickens' slow fall, pandas eating bamboo, sniffers
digging, parrots imitating mobs, cats' morning gifts, two riders on a camel,
and babies growing up. Some animals do more:
- Armadillos: sometimes curl up for a nap when there's nothing to do, and
  uncurl when they need to move.
- Bats: can be tamed, and fight like other pets: they fly at the target and
  bite. Wild bats stay harmless.
- Bees: keep their stinger (wild bees die after stinging), and don't
  pollinate or go into hives, so they stay with you. They fly when ridden.
- Foxes: still pick things up, and drop what they hold when you come within a
  block of them.
- Frogs: as fast as other pets on land; ridden in water, they swim fast and
  dive where you look.
- Goats: ram what they fight (a big shove), and jump about 2 blocks when
  ridden.
- Llamas: spit at what they fight, from up to 10 blocks.
- Mooshrooms: shear one and the cow it turns into is still your pet.
- Pandas: can be put on a lead and tamed.
- Parrots: ride on your shoulder the vanilla way (they hop on when they bump
  into you while you stand still) and fly off when you jump. They fly when
  ridden.
- Turtles: can be put on a lead and tamed. As fast as other pets on land (no
  more crawling); ridden in water, they swim at 8 blocks/second and dive where
  you look.
- Wolves, cats, parrots: really sit when told to stay.

----------------------------------------------------------------
COMMANDS
----------------------------------------------------------------
/tameful    Open the settings screen. (World owner or operators.)

----------------------------------------------------------------
SETTINGS
----------------------------------------------------------------
Change them with /tameful. Saved in config/tameful.json.

flying_pets_get_tired  true   Flying pets carry you for flight_seconds, glide
                              down, then rest for flight_rest_seconds. Off: no
                              limit.
immortal               true   Pets rest for 30 seconds at 0 health instead of
                              dying.
regen_health           true   Pets heal 1 health every 2 seconds after 10
                              seconds without damage, and while resting.
max_tames              0      Most pets per player (0 = unlimited). Pets tamed
                              the vanilla way count too.
lead_consumed          true   Taming uses up the lead.
flight_seconds         10     How long flying pets carry you.
flight_rest_seconds    10     How long they rest before flying again.

----------------------------------------------------------------
HQ COMPATIBILITY
----------------------------------------------------------------
With HQ installed, a "Tameful" button in the HQ list opens /tameful.
Without HQ the mod works exactly the same.

----------------------------------------------------------------
COMPATIBILITY & NOTES
----------------------------------------------------------------
- Works with animals from other mods (any animal that isn't hostile).
- Pets you tamed the vanilla way (wolves, cats, horses...) become full Tameful
  pets.
- Works with Conflict Resolution, which can protect pets from other players.

----------------------------------------------------------------
CHANGELOG
----------------------------------------------------------------
1.0.2
- Pets that are removed from the world (put in a Mob Crate, deleted by
  another mod or a command) no longer count toward max_tames. A pet that
  comes back counts again.

1.0.1
- Flying pets now fly like swimming: look down to dive, look up to climb.
- Pet foxes drop what they hold when you come within a block of them.
- HQ support: a Tameful button in the HQ list.

1.0.0
- First release.