(→SetFocus) |
(→Autorun) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Introduction== | ==Introduction== | ||
| − | + | Scripting allows you to enter commands to the bot that will be performed immediately line by line, as opposed to goals which are gradually worked towards. For instance, the directive ''troop a:5000'' in the goals window tells the bot to build archers until you have 5000 then move to the next goal. If you already have 5000 or more archers, it is disregarded. The script command ''train a:5000'' will immediately queue 5000 archers in your barracks regardless of how many you have already, provided of course you have the population and resources needed. | |
The Script window is similar to the Goals window, and is found by selecting the ''Script'' tab on the upper left hand window. There are 5 individual script windows per city, allowing you to build up to 5 command sets per city, that will be saved (provided you select the ''save'' button) along with your goals. Individual scripts are selected by way of the ''Load'' button. | The Script window is similar to the Goals window, and is found by selecting the ''Script'' tab on the upper left hand window. There are 5 individual script windows per city, allowing you to build up to 5 command sets per city, that will be saved (provided you select the ''save'' button) along with your goals. Individual scripts are selected by way of the ''Load'' button. | ||
| − | The commands available give you the ability to perform all of the the same functions | + | The commands available give you the ability to perform all of the the same functions the bot works towards in the goals window, as well as add to or alter those goals. Note that goals modified or added in the script window will not be reflected in the goals window, or saved with them. |
| − | + | The script set includes ''ifgosub'' and ''ifgoto'' statements allowing you to automatically make decisions based on conditions in your city, such as the amount of lumber or number of warriors you have on hand. | |
Variables for use in ''ifgoto & ifgosub'' statements can be found in the [[Reference Section]]. | Variables for use in ''ifgoto & ifgosub'' statements can be found in the [[Reference Section]]. | ||
| − | + | Scripts are executed from the top down, beginning at the line number specified in the ''Run'' box. If no number is entered, or the number is greater than the number of lines in the script, the script begins at line #1. | |
| − | Scripts are executed from the top down, beginning at the line number specified in the ''Run'' box. If no number is entered, or the number is greater than the number of lines in the script, the script begins at line #1. | ||
| − | |||
| − | |||
==Label== | ==Label== | ||
| Line 224: | Line 221: | ||
sleep 4:22:32<br> | sleep 4:22:32<br> | ||
|} | |} | ||
| − | The sleep command will cause | + | The sleep command will cause the bot to pause for the indicated time, which can be expressed as seconds only (i.e. 34, 240, 23432), minutes and seconds (i.e. 4:30) or hours, minutes, seconds (2:44:34). |
<blockquote><pre> | <blockquote><pre> | ||
| Line 263: | Line 260: | ||
|} | |} | ||
| − | Sleeps | + | Sleeps the bot for a random time. |
<blockquote><pre> | <blockquote><pre> | ||
| Line 284: | Line 281: | ||
|} | |} | ||
| − | Disconnects/connects | + | Disconnects/connects the bot from/to the server. Time must be expressed in 24 hr format if using tha @ option. |
Note that any script running that causes the bot to diconnect '''''will continue running''''' again once the bot reconnects. | Note that any script running that causes the bot to diconnect '''''will continue running''''' again once the bot reconnects. | ||
| Line 339: | Line 336: | ||
| config wartown:0 | | config wartown:0 | ||
|} | |} | ||
| − | In order to allow control of all | + | In order to allow control of all the bot functions through the scripting interface, all ''config'' switches that can be set in the goals page are accessible in your script. The new settings will be retained until: |
*they are changed again through a script command | *they are changed again through a script command | ||
*the Set Goals button in the Goals page is selected, or | *the Set Goals button in the Goals page is selected, or | ||
| Line 382: | Line 379: | ||
This command will allow you to add a new ''troop'' goal directive from the script interface. For more information see the [[Troop Goals]] section. | This command will allow you to add a new ''troop'' goal directive from the script interface. For more information see the [[Troop Goals]] section. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 05:21, 16 August 2012
Contents
Introduction
Scripting allows you to enter commands to the bot that will be performed immediately line by line, as opposed to goals which are gradually worked towards. For instance, the directive troop a:5000 in the goals window tells the bot to build archers until you have 5000 then move to the next goal. If you already have 5000 or more archers, it is disregarded. The script command train a:5000 will immediately queue 5000 archers in your barracks regardless of how many you have already, provided of course you have the population and resources needed.
The Script window is similar to the Goals window, and is found by selecting the Script tab on the upper left hand window. There are 5 individual script windows per city, allowing you to build up to 5 command sets per city, that will be saved (provided you select the save button) along with your goals. Individual scripts are selected by way of the Load button.
The commands available give you the ability to perform all of the the same functions the bot works towards in the goals window, as well as add to or alter those goals. Note that goals modified or added in the script window will not be reflected in the goals window, or saved with them.
The script set includes ifgosub and ifgoto statements allowing you to automatically make decisions based on conditions in your city, such as the amount of lumber or number of warriors you have on hand.
Variables for use in ifgoto & ifgosub statements can be found in the Reference Section.
Scripts are executed from the top down, beginning at the line number specified in the Run box. If no number is entered, or the number is greater than the number of lines in the script, the script begins at line #1.
Label
| Usage: | label name |
|---|---|
| Example: | label comfort; label upgraderax |
Creates a placeholder within the scripts that can be referenced for a loop or goto command.
attack 360,843 any t:400,b:400 attack 344,567 any t:400,b:400 attack 400,543 any t:400,b:400 label upgrade upgrade barrack loop upgrade 5
Goto
| Usage: | goto label |
|---|---|
| Example: | goto upgradecot |
Allows you to jump to any label, anywhere in the script.
label medalfarm attack 123,300 !Bubba,!Xavier,any t:400,b:400 goto trainarch label upgradecot upgrade house repeat 2 label trainarch train arch:2500 atk goto upgradecot
Gosub
| Usage: | gosub label |
|---|---|
| Example: | gosub medalfarm |
Allows you to jump to a subroutine.
gosub medalfarm gosub trainarch gosub upgradecot loop 0 label medalfarm attack 123,300 !Bubba,!Xavier,any t:400,b:400 gosubreturn // label upgradecot upgrade house repeat 2 gosubreturn // label trainarch train arch:2500 Hero gosubreturn
GosubReturn
| Usage: | gosubreturn |
|---|---|
| Example: | gosubreturn |
Used at the end of a subroutine to return to the line that called it, and proceed from there.
gosub medalfarm gosub trainarch gosub upgradecot loop 0 label medalfarm attack 123,300 !Bubba,!Xavier,any t:400,b:400 gosubreturn // label upgradecot upgrade house repeat 2 gosubreturn // label trainarch train arch:2500 Hero gosubreturn
Loop
| Usage: |
loop [optional # of times] |
|---|---|
| Example: |
loop |
Allows you to repeat your entire script, or using a label repeat parts of a script. No parameter, or a parameter of 0 (ie - loop 0), will repeat the script indefinitely.
//===============================
// Upgrade everything in your
// city, as long as tech and
// resource requirements are met
//===============================
upgrade
loop
//===============================
// Upgrade your farms, sawmills
// and your ironmines, then
// repeat the process again
// 5 times
//===============================
upgrade farm
upgrade saw
upgrade iron
loop 5
//===============================
// Upgrade your farms, sawmills
// and your ironmines, then
// upgrade cottages and repeat the cottages again
// 5 times
//===============================
upgrade farm
upgrade saw
upgrade iron
label cotupgrade
upgrade cottage
loop 5 cotupgrade
Repeat
| Usage: | repeat [optional # of times] |
|---|---|
| Example: |
repeat |
The repeat command will simply repeat the previous line of script the specified number of times. No parameter, or a parameter of 0 (ie - repeat 0), will repeat the previous line indefinitely.
//================================ // Attack 2 targets, then upgrade // your cottages first, followed // by your barracks //================================ attack 245,325 Bubba arch:25000,warr:25000,t:1000 attack 222,324 any t:400,b:400 upgrade cottage repeat 12 upgrade barrack repeat 12 //================================ // Upgrade all of your buildings // and resource fields to level 9: //================================ upgrade repeat
Sleep
| Usage: |
sleep seconds |
|---|---|
| Example: |
sleep 15 |
The sleep command will cause the bot to pause for the indicated time, which can be expressed as seconds only (i.e. 34, 240, 23432), minutes and seconds (i.e. 4:30) or hours, minutes, seconds (2:44:34).
sleep 30 //Sleeps the script for 30 seconds sleep 2:45 //Sleeps the script for 2 minutes 45 seconds sleep 7:25:00 //Sleeps the script for 7 hours, 25 minutes and 0 seconds
Sleep @
| Usage: | sleep @:hh:mm:ss |
|---|---|
| Example: | sleep @:14:15:00 |
The sleep @ command will puase Y.A.E.B. until the time indicated, based on the system time of your computer. The time must be expressed in 24 hr. format, with 00:00:01 being 1 second after midnight, and 12:00:01 being 1 second past noon. This feature is similar to camp time with the added advantage that the bot will calculate how much camp time is required for your troops to arrive at the given time.
Note that there is always a slight variation between the Evony engine clock and your system time. The exact time difference between the Evony engine and your computer system time is displayed at startup or any time you click the Refresh button on the top left of the screen.
sleep @:15:45 //Sleeps the script until 3:45pm local system time
Sleep rnd
| Usage: |
sleep rnd:maximum.seconds |
|---|---|
| Example: |
sleep rnd:15 |
Sleeps the bot for a random time.
sleep rnd:15 //sleep for a random number of seconds between 0 and 15 sleep rnd:300:600 //sleep randomly for at least 5 minutes, but no more than 10 minutes.
Logout
| Usage: |
logout @:logouttime @:logontime |
|---|---|
| Example: |
logout @:01:30:31 @:06:35:00 |
Disconnects/connects the bot from/to the server. Time must be expressed in 24 hr format if using tha @ option.
Note that any script running that causes the bot to diconnect will continue running again once the bot reconnects.
1: logout 1:00 29:00 2: attack 400,400 any c:1000,s:1000 3: repeat 3 4: sleep 45 5: loop
This script will cause the bot to send 3 spam waves to the target every 30 minutes, indefinitely, disconnecting from the server in between each set.
Goal
| Usage: | goal [desired goal [parameters]] |
|---|---|
| Example: |
goal config npc:5 |
This command will allow you to execute the script line as a goal. It is optional, in the above example just "config npc:5" as a script line would work to adjust the goal config npc to '5'. Any goal can be executed via a script line without this optional command, but this may be useful when a goal and a script have the same name, and you want it to modify the goal explicitly.
ResetGoals
| Usage: | resetgoals |
|---|---|
| Example: | resetgoals |
This command will: remove all building, tech, & fortification directives; cancel all troop requirements, erase all config statements, erase all variables; set reportstokeep & distancepolicy to default values; delete npcbounds, npcheroes, nolevelheroes, spamheroes; remove all send/keep resource/troops directives, set homeheroes:1, traininghero "" 300 -1 -1, gatepolicy 0 0 0 0 0 reset: defencepolicy, HeroPolicy, WarehousePolicy, FarmingPolicy, RallyPolicy, tradepolicy, ProcessingPolicy, & hunting
Config
| Usage: | config [directive]:[value] |
|---|---|
| Example: | config wartown:0 |
In order to allow control of all the bot functions through the scripting interface, all config switches that can be set in the goals page are accessible in your script. The new settings will be retained until:
- they are changed again through a script command
- the Set Goals button in the Goals page is selected, or
- the bot is restarted.
The changes made to settings through the script interface will only change the values currently in memory. No actual changes are made to the Goals page and all values can be restored to settings on the goals page by selecting Set Goals with the goals window displayed.
For more information please refer to the Intro to Goals Section of this Wiki.
BuildingGoals
| Usage: | buildinggoals [build.goal.string] |
|---|---|
| Example: | buildinggoals st:0:0,b:9:12 |
This command will allow you to add a new build goal directive from the script interface. For more information see the Building Goals section.
TechGoals
| Usage: | techgoals [research.goal.string] |
|---|---|
| Example: | techgoals ar:10,ho:10,mt:9 |
This command will allow you to add a new research goal directive from the script interface. For more information see the Research Goals section.
TroopGoal
| Usage: | troopgoal [troop.goal.string] |
|---|---|
| Example: | troopgoal w:5k,a:10k |
This command will allow you to add a new troop goal directive from the script interface. For more information see the Troop Goals section.