Manual - HackerHarry/mffbashbot GitHub Wiki

• Basics
  • Error handling
  • Structural changes
  • Misc
• Starting the bot
• The bot's control elements (GUI in browser)
• How the bot works
  • Queues
  • Pony farm
  • Auto-Transport
  • Flower arrangements
  • Speed eating
  • Animal hospital
  • Butterflies
  • Cow racing
  • Vineyard
  • Scouts
  • Guild jobs
  • Mega field
  • Sushi bar
  • Spice house
  • Fishing shack
  • Roadside Stands
  • Insect hotel
  • Other

Basics

This bot will basically do something for you, after you've started something. The idea is to support the player play the game, so the player can enjoy playing the game by investing around 10 to 30 minutes a day. The bot is not intended to fully automate the game.[To top]

Error handling

The bot mostly doesn't care about the player making mistakes. If you want to seed corn, but don't have enough corn in stock, the bot will try to fulfill your request. This will (in this case) fail. That particular station won't be served any further until the player corrects the mistake and restarts that station. [To top]

Structural changes

When you buy or change any building, you'll have to re-login using the Back to logon button. Otherwise the change can't be reflected with the GUI. If you tear down a building and build a new one on that very spot, it's recommended to clear out the associated queue in order to avoid problems. [To top]

Misc

If a station has multiple slots, only those will be served that aren't rented using coins. Exceptions are the speed eating, the wind mill and the pony farm.

Missing or superfluous queues on normal farms can be added or deleted by using the Correct queue numbers once option.

If you have a farm name with a white space in it, make sure to substitute it in the file system using %20. Your farm name would look something like My%20farm.

My bot hardly loses its cool. Meaning that if a station can't operate normally, the bot won't stop entirely. Typically, only the faulty position stops but the rest keep on working as expected. [To top]

Starting the bot

The bot needs to be started in the bot's program folder using this syntax: ./mffbashbot.sh farm-logon-name

Password, server-no. & language have to be set in config.ini within your farm folder.

A start procedure might look like this:

harry@testbox:~$ cd ~/mffbashbot
harry@testbox:~/mffbashbot$ ./mffbashbot.sh farm0815

Or like this:

harry@testbox:~$ cd
harry@testbox:~$ ./startallbots.sh

From version 2.50 onwards, the bot is run in a Screen session. One can easily run multiple bots simultaneously this way. The total number of bots is mostly limited by the available screen resolution and CPU power.

Switch between farms using CTRL-A, then the space bar. [To top]

The bot's control elements (GUI in browser)

At the logon screen, it is determined how many farms there are defined under ~/mffbashbot. The discovered farms are then offered in a pull-down menu.

Add farms using the + Farm button from the logon screen. Use the - Farm button to delete a farm. Make sure to stop the bot for that farm, prior to deleting it. A bot can be stopped using CTRL-C.

The GUI is pretty much self-explanatory (e.g. by mouse-over text). A station is described as follows: The pull-down menu at the top lets you choose items, that can be used at that particular position. Underneath that, you can find the buttons used to add or delete items to/from the queue, which can be found at the bottom. Double-clicking the delete icon removes everything from the queue.

Please note, that you need to fill in TWO text boxes with the stables. The bot needs to know how many grain, corn, ... need to be fed.

The GO! Button forces the bot to end its pause (defined as PAUSETIME in the bot script) and to start an iteration. [To top]

How the bot works

Let me say this again: This bot will do something for you, after you've started something.

Queues

The topmost element in a queue will be the next one to be served at that position.

If the topmost element is Sleep, the bot will leave that position alone. It won't be harvested in that case either.

A single element in the queue gets repeated indefinitely.

Two or more elements in a queue also get repeated. After the topmost element has been served, it moves to the bottom of the queue while the remaining items all move one up. [To top]

Pony farm

The pony farm is controlled by only one queue. The bot will try to refill the feeder after a hack. You can control pony energy bar usage via the options. Mind that the max. number of pony energy bars will be added. [To top]

Auto-Transport

Automatic transportation off farms 5, 6, 8 & 10 leaves as many seeds behind, that's needed to cultivate the current number of fields. So if you have two fields on farm five, the bot would leave 120 grain seeds on farm five. This behaviour cannot be altered without changing the code. Auto-Transport off farms 5, 6, 8 & 10 is limited to the items that can be grown there, unless you make a choice from the Transport this off of farm [5|6|8|10] menu. In that case, the bot will transport off only the chosen item.

Auto-Transport TO farms 5 to 10 (can be found in Pondsville) takes place if one of these conditions is met:

• The vehicles capacity is exhausted (exactly) or
• All slots are in use or
• The bot encounters a Sleep with at least one slot in use

The vehicle gets sent back to the main farm for as long as Sleep is not the topmost item. If Sleep is the only item in the transport-queue, the vehicle gets sent back emtpy to farm five to eight. CAUTION: If you overload the vehicle, it will stay on farm one! [To top]

Flower arrangements

Flower arrangements on display will be watered automatically, exept those that don't need (any more) water. [To top]

Speed eating

The speed eating contestant will be fed if the proper option is set. However, rewards will be collected automatically as well as the cash desk bonus. [To top]

Animal hospital

Animals treated at the veterinary clinic, will be cured automagically. Only those tinctures are used, that don't cost coins and heal the quickest. [To top]

Butterflies

Butterflies are fed automagically. Make sure you have enough food. Use the Butterflies... button to choose which eggs to buy. Each iteration the bot tries to buy a desired egg max. 10 times per slot. Danger: This could eat up your pD! Automatically bought eggs will be fed until one step before the minimum blossom yield is reached. After that, the butterfly gets sent to the larger compound. The Bot only buys two types of decoration (their names are unknown to the author). [To top]

Cow racing

Cow training races can be started without user-interaction. Use the appropriate option from the options menu. Exclude cows ranked 1st if you wish. Environmental conditions (heat, rain, mud...) are taken into account. Prior to the race, the bot tries to put benificial equipment on the race cow. These may be items you bought using coins. If nothing suitable is found, the bot tries to buy non-coin equipment for you.

Cow PvP races can also be started automatically via the options. The bot won't act until 90 mins before the race and select a cow that best matches the upcoming race's conditions. It will then equip and (if needed) buy non-coin equipment, and sign your cow up for the race. [To top]

Vineyard

The vineyard options can be found under both Options... and More options.... The bot can take care of your vine from the initial start to harvest. Caution: The Option Keep replacing until spring is sunny might be costly. One should also take care of not accidently selecting options that cost coins. You can have the bot bottle and sell Wine, if you wish. If no free barrel iss available, the most mature wine will be bottled, barrels of the same type are repurchased and wine of the lowest quality is sold to the trader, if needed. The type of wine doesn't matter when it comes to selling it. [To top]

Scouts

Find the scouts' food production on the 2nd farmers' market. Scout tasks can be automated via More options.... Pre-select the "food" that should be used to refill the scouts' energy. Please note:

• The bot will only purchase non-coin task-related items
• Charity tasks will be served, as long as there's enough items in stock
• The bot only refills as much energy as is required to complete a task
• In case a task requires multiple scouts, the bot will not see if all of them can be fed beforehand [To top]

Guild jobs

If you want to help produce stuff for a guild job, you first need to feed or provide the proper goods from the guilds' stock to a position. After that, the bot will notice that circumstance and treat that position as a guild job. An exception is when you cultivate a field for the guild job. As long as you've chosen the proper profession, the field will produce for the guild without further intervention. [To top]

Mega field

Required goods at the vehicle hall (mega field) will be worked on in a left-to-right order. Fertilising machines can not be automated by the bot. If your harvesting device uses up all its durability, the bot will try and buy a new one, provided it's a non-coin item. [To top]

Sushi bar

Using the corresponding queues, you can control the production for the sushi bar. The options allow you to place one dish from each category on a plate. The bot will try and keep that dish available on one plate so customers can help themselves. Fully served customers are automatically cashed out. [To top]

Spice house

Use the pull-down menus under More options... to tell the bot what to put into the oven. Remember to start the oven manually once. Slots are filled to their maximum capacity and with the selected spice only. Filling different crops in one compartment is not supported. As a safety measure, the bot won't touch crop needed to cultivate one field. In case there's not enough goods available, the affected slot will not be filled.

Mills can be served using the queues on farm 10. A manual start is mandatory here as well. As soon as the mill runs out of goods, the bot will try to do a refill to the mills' max. capacity. The Mill-Booster will not be taken into account by the bot. [To top]

Fishing shack

Make the fisherman do his job by setting the proper options. Pre-selected non-coin fishing gear is bought by the bot, once exhausted. You can also set an option to preferring the production of a certain bait. The selection Auto produces non-coin items, where there's sufficient ingredients in the treasure box, automatically in accordance to your fishing level. The bot only looks if there's enough needed items in the treasure box, then proceeds to producing that food before all other elements in the queue. The queue is not updated if a preferred or Auto item gets produced. [To top]

Roadside Stands

Only non-rentable slots of the fruit stands (Roadside Stands) are supported. Don't forget to activate a slot at least once, so the bot can take over. [To top]

Insect hotel

If you activate the option to serve the insect hotel the bot will collect the cash desk bonus and refill already present food in the warehouse if the filling level falls below 25%. [To top]

Other

• You need to reach level four before fields can be cultivated by the bot.

• Rosy will only be sent shopping if all required goods are available in sufficient quantity.

• The Lucky Donkey Luke is collected (if selected) upon every bot (re)start, and afterwards every 24 hrs.

• The bot determines plucking-readiness of trees only by one single tree: The top left one. That's why you can not have the bot plant different trees in one go.

• You may activate power-ups in Pondsville using two queues.

• Stock management will only repurchase goods if there is at least one piece of the goods to be repurchased left in stock.

• Auto-planting on the Event Field can be activated via the options. This only works within the events' predefined time frame - outside it, the option will be deactivated. Find the appropriate queue in Pondsville. Mind you, the bot will not pruchase goods for the Event Field.

• The farm name has to be unique. This means server independently unique.

• The update handler only looks for a new version upon login from the GUI. A re-login every now and then can be helpful.

• If you change a farms' password, make sure to restart the bot and adjust the config.ini for that particular farm. [To top]