*************************************************************************
*                           Animal Breed Master                         *
*************************************************************************

This plugin enables you to keep animals, feed them and to breed offsprings.
It is an alpha version, not feature complete yet, but all the actions listed
below work.


Installation:
------------
Extract animalbreedmaster.zip into the RisingWorld/plugins folder.
(If the plugins-folder does not exists yet, please create it.)
If a previous version already exists, then simply overwrite the old files.

It should look like this:
-- RisingWorld
   |
   |-- plugins
       |
       |-- animalbreedmaster
           |--data/ (folder created automatically after first start,
           |         holding database files for each world)
           |- AnimalBreedMaster.jar
           |- AnimalBreedMaster.prefs.xml (automatically created)
           |- changelog_de.txt
           |- changelog_en.txt
           |- readme_de.txt
           |- readme_en.txt


Settings:
--------
In the AnimalBreedMaster.prefs.xml you can specify the maximum amount of animals per player.
Enter a appropiate value, acceptable range is between 1 and 1000, default is 50:

  <entry key="max_animals_per_player">50</entry>

In addition, the reward system can be turned on or off,
true = activated, false = deactivated

  <entry key="reward_system_active">true</entry>

Since version 0.50 you can (de)activate the renaming action (pointing on animal with paper
in hand).
This is useful if you run into trouble with the rename gui.
true = activated, false = deactivated

  <entry key="rename_action_active">true</entry>

You can (de)activate the invincible action.
This is useful on multiplayer servers if you do not want your players to fool around
with invincible animals.
true = activated, false = deactivated

  <entry key="invincible_action_active">true</entry>


Description:
-----------
You always wanted to be a farmer? Let's go!
You now have the possibility to keep your own animals, to feed them
and to provide for offsprings!

How do you become an Animal Breed Master?
1. First, you must capture wild animals:
   Feed the animal until it obeys you!
   Keep the appropriate treat (see list below) in the hand and
   approach it. You have to point at it (the crosshair must point at the
   animal, the name of the animal appears then).
   Press the interaction key (default: Key <F>) it starts to eat from your hand. After some treats, it is yours!

2. Command the animal to follow you:
   Hold a rolling pin in your hand, point at it and press the interaction key.
   It starts to follow you.
   If you want the animal to stop following you, then interact again with rolling pin.
   While it follows you, you do not have to hold the noodle in your hand.
   In the meantime, you can do other things, e.g. eating or chopping down trees, etc.

3. Give your animal a nice name:
   Hold a piece of paper in your hand, point at it and press the interaction key.
   An input field appears. Enter the desired name (if necessary, click with the mouse in the field)
   and confirm with the <Enter> key.

4. Make your animal mating:
   Feed it again a few times with the appropriate treat.
   If it has eaten enough, then it would like to get started! :D
   However, it needs a like-minded partner!
   You must have at least two mating animals (of the same genus)!

5. The offspring:
   If two animals are willing to mate, then they are getting started!
   One of them becomes pregnant and after almost one and half hour (real-time)
   it will give birth to a young!
   Tip: You can greatly reduce duration by repeated feeding!


Additional interactions:
-----------------------
Leash your animal:
  Hold a piece of lumber in your hands, point at it and press the interaction key.
  Your animal will not move anymore!
  To unleash a leashed animal press the interaction key again.

Make your animal invincible:
  Hold a goldrod in your hand, point at it and press the interaction key.
  If you press the interaction key again on an invincible animal it will become mortal again.

Release your animal (back to the wild):
  Hold a stick in your hands, point at it and press the interaction key.
  Now it does not longer belong to you.


The reward system:
-----------------
For some action, you earn points that you can later convert
into "more exotic" animals!


How to earn points?
For the following actions you get 1 point each:
- capture an animal
- make an animal ready to mate
- an animal gets pregnant
- an animal give birth to a young

What kind of animals can I receive, and for how many points?
- fox    :  60 points
- minipig: 100 points
- penguin:  50 points
- rabbit :  40 points
- rat    : 100 points

How do I get a reward animal?
- you have to hold a certain item in your hand and place it on the floor
  where it is supposed to appear (with key <Q>), this item will be exchanged
  for the new animal
- wait approx. 10 seconds in the near of the dropped item (2-3 meters) until the
  animal appears (or a message if you do not have enough points)
- list of items: see below

How do I know my current points total?
- in the chat enter "/abm help" or
- point at one of your animals with one of the reward items



Interact with the animal by pointing at it with a particular object
in your hand.

List of items and their interaction:
-----------------------------------
corncob: feed pig
carrot: feed cow
sapling (spruce): feed goat
sugarbeet: feed sheep
bacon (raw): feed fox
cherries: feed bear
strawberries: feed rabbit
watermelon seeds: feed chicken
pumpkin seeds: feed chicken
chili pepper: feed chicken
apple: feed elephant
beefsteak (raw): feed jaguar
ribs (raw): feed tiger
piece of watermelon: feed minipig
bacon (cooked): feed rat
potato: feed other animals
lemon: feed other animals

rolling pin: animal follows you
gold rod: animal becomes invincible
lumber: animal will not move anymore
paper: rename animal
stick: release animal

aluminium ingot: find out the number of reward points
gold ingot: find out the number of reward points
mithril ingot: find out the number of reward points
silver ingot: find out the number of reward points
lightbulb: find out the number of reward points


Drop one of the following items on the floor to gain a reward:
-------------------------------------------------------------
aluminium ingot: Fox for 60 reward points
gold ingot: Penguin for 50 reward points
lightbulb: Rat for 100 reward points
mithril ingot: Minipig for 100 reward points
silver ingot: Rabbit for 40 reward points


Additional Information:
----------------------
The name tag above the animal appears in different colours, where:
- yella = a wild animal, can be captured
- green = this animal belongs to you
- blue  = the animal belongs to another player

For performance reasons, interactions are processed in one second intervals.
If an animal does not react promptly, simply do not aim at it for about 1 second.


Chat commands:
-------------
Open the chat console (default key <T>) and enter following:

/abm help

for a short help page.
(Activate chat and press <Page Up> <Page Down> to scroll)

You can toggle the reward system on the fly,
additionally the setting will be saved in AnimalBreedMaster.prefs.xml:

/abm rewsys true
- activates reward system

/abm rewsys false
- deactivates reward system

You can turn off or on the name tags:
/abm showlabels off
/abm showlabels on

You can turn off or on chat notifications:
/abm showchat off
/abm showchat on

Since version 0.50 you can toggle the renaming action on the fly,
this is useful if you run into trouble with the rename gui.
Additionally the setting will be saved in AnimalBreedMaster.prefs.xml:

/abm rename true
/abm renaming true
- activates renaming action

/abm rename false
/abm renaming false
- deactivates renaming action

On multiplayer servers, only administrators are allowed to use this command.

Count your animals:
/abm count all - counts all animals or
/abm count TYPENAME - counts animals of a specific type, e.g.:
  /abm count pig
  /abm count cow
  etc.

List your animals with some information like position, distance and name:
/abm list all - lists all animals or
/abm list TYPENAME - of specific type, e.g.:
  /abm list pig
  /abm list cow
  etc.

Recalling your animals home:
/abm warphome all (recalls all your animals home)
/abm warphome ID (recalls one animal home - use /abm list to find out the ID)
/abm warpallhome (admin only - recalls all tamed animals from all players home at once)


You can toggle the invincible action on the fly.
This is useful on multiplayer servers if you do not want your players to fool around
with invincible animals.
On multiplayer servers, only administrators are allowed to use this command.
Additionally the setting will be saved in AnimalBreedMaster.prefs.xml:

/abm invincible true
- activates invincible action

/abm invincible false
- deactivates invincible action


Further commands for admins only:
- /abm listranchers NAME(optional) - lists all ranchers (players owning animals),
  if NAME is specified, then only those whose name begins with NAME
- /abm listanimals PLAYER_ID - lists all animals from player PLAYER_ID
- /abm changeowner rancher OLD_ID NEW_ID - transfer all animals of player OLD_ID to NEW_ID
  (set NEW_ID = -1 to release all animals to the wild)
- /abm changeowner animal NPC_ID PLAYER_ID - transfer animal NPC_ID to player PLAYER_ID
  (set PLAYER_ID = -1 to release the animal to the wild)
- /abm reset lock rancher ID - unleash all animals of player with ID
- /abm reset lock animal ID - unleash animal with ID
- /abm reset invincible rancher ID - make all animals of player with ID vulnerable again
- /abm reset invincible animal ID - make animal with ID vulnerable again
- /abm gotoanimal ID - teleports you to animal with ID
- /abm goback - brings you back to the last position (after one or more calls to gotoanimal)
