Framework
The botcity.core
module contains specialized implementations aimed at Desktop automation
such as DesktopBot
which is described below.
You are expected to implement the action
method of the DesktopBot
class in
your Bot class.
Here is a very brief example of a bot which opens the BotCity website:
from botcity.core import DesktopBot
class Bot(DesktopBot):
def action(self, execution=None):
# Opens the BotCity website.
self.browse("https://botcity.dev")
if __name__ == '__main__':
Bot.main()
botcity.core.bot.DesktopBot
Bases: BaseBot
Base class for Desktop Bots.
Users must implement the action
method in their classes.
Attributes:
Name | Type | Description |
---|---|---|
state |
State
|
The internal state of this bot. |
maestro |
BotMaestroSDK
|
an instance to interact with the BotMaestro server. |
Source code in botcity/core/bot.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 |
|
add_image(label, path)
Add an image into the state image map.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label |
str
|
The image identifier |
required |
path |
str
|
The path for the image on disk |
required |
Source code in botcity/core/bot.py
83 84 85 86 87 88 89 90 91 |
|
alt_e(wait=0)
Press keys Alt+E
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 |
|
alt_f(wait=0)
Press keys Alt+F
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 |
|
alt_f4(wait=0)
Press keys Alt+F4
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 |
|
alt_r(wait=0)
Press keys Alt+R
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 |
|
alt_space(wait=0)
Press keys Alt+Space
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 |
|
alt_u(wait=0)
Press keys Alt+U
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 |
|
backspace(wait=0)
Press Backspace key
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 |
|
browse(url, location=0)
Invoke the default browser passing an URL
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url |
str
|
The URL to be visited. |
required |
location |
int
|
If possible, open url in a location determined by new: * 0: the same browser window (the default) * 1: a new browser window * 2: a new browser page ("tab") |
0
|
Returns:
Name | Type | Description |
---|---|---|
bool | Whether or not the request was successful |
Source code in botcity/core/bot.py
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 |
|
click(wait_after=config.DEFAULT_SLEEP_AFTER_ACTION, *, clicks=1, interval_between_clicks=0, button='left')
Click on the last found element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait_after |
int
|
Interval to wait after clicking on the element. |
config.DEFAULT_SLEEP_AFTER_ACTION
|
clicks |
int
|
Number of times to click. Defaults to 1. |
1
|
interval_between_clicks |
int
|
The interval between clicks in ms. Defaults to 0. |
0
|
button |
str
|
One of 'left', 'right', 'middle'. Defaults to 'left' |
'left'
|
Source code in botcity/core/bot.py
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
|
click_at(x, y)
Click at the coordinate defined by x and y
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
int
|
The X coordinate |
required |
y |
int
|
The Y coordinate |
required |
Source code in botcity/core/bot.py
619 620 621 622 623 624 625 626 627 |
|
click_on(label)
Click on the element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label |
str
|
The image identifier |
required |
Source code in botcity/core/bot.py
578 579 580 581 582 583 584 585 586 587 588 |
|
click_relative(x, y, wait_after=config.DEFAULT_SLEEP_AFTER_ACTION, *, clicks=1, interval_between_clicks=0, button='left')
Click Relative on the last found element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
int
|
Horizontal offset |
required |
y |
int
|
Vertical offset |
required |
wait_after |
int
|
Interval to wait after clicking on the element. |
config.DEFAULT_SLEEP_AFTER_ACTION
|
clicks |
int
|
Number of times to click. Defaults to 1. |
1
|
interval_between_clicks |
int
|
The interval between clicks in ms. Defaults to 0. |
0
|
button |
str
|
One of 'left', 'right', 'middle'. Defaults to 'left' |
'left'
|
Source code in botcity/core/bot.py
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 |
|
control_a(wait=0)
Press keys CTRL+A
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 |
|
control_c(wait=0)
Press keys CTRL+C
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 |
|
control_end(wait=0)
Press keys CTRL+End
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 |
|
control_f(wait=0)
Press keys CTRL+F
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 |
|
control_home(wait=0)
Press keys CTRL+Home
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 |
|
control_p(wait=0)
Press keys CTRL+P
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 |
|
control_r(wait=0)
Press keys CTRL+R
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 |
|
control_shift_j(wait=0)
Press keys CTRL+Shift+J
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 |
|
control_shift_p(wait=0)
Press keys CTRL+Shift+P
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 |
|
control_t(wait=0)
Press keys CTRL+T
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 |
|
control_u(wait=0)
Press keys CTRL+U
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 |
|
control_v(wait=0)
Press keys CTRL+V
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 |
|
control_w(wait=0)
Press keys CTRL+W
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 |
|
copy_to_clipboard(text, wait=0)
Copy content to the clipboard.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str
|
The text to be copied. |
required |
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
864 865 866 867 868 869 870 871 872 873 874 |
|
delete(wait=0)
Press Delete key
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 |
|
display_size()
Returns the display size in pixels.
Returns:
Name | Type | Description |
---|---|---|
size |
Tuple
|
The screen dimension (width and height) in pixels. |
Source code in botcity/core/bot.py
417 418 419 420 421 422 423 424 425 |
|
double_click(wait_after=config.DEFAULT_SLEEP_AFTER_ACTION)
Double Click on the last found element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait_after |
int
|
Interval to wait after clicking on the element. |
config.DEFAULT_SLEEP_AFTER_ACTION
|
Source code in botcity/core/bot.py
664 665 666 667 668 669 670 671 672 |
|
double_click_relative(x, y, interval_between_clicks=0, wait_after=config.DEFAULT_SLEEP_AFTER_ACTION)
Double Click Relative on the last found element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
int
|
Horizontal offset |
required |
y |
int
|
Vertical offset |
required |
interval_between_clicks |
int
|
The interval between clicks in ms. Defaults to 0. |
0
|
wait_after |
int
|
Interval to wait after clicking on the element. |
config.DEFAULT_SLEEP_AFTER_ACTION
|
Source code in botcity/core/bot.py
674 675 676 677 678 679 680 681 682 683 684 685 686 |
|
enter(wait=0)
Press key Enter
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
888 889 890 891 892 893 894 895 896 897 898 |
|
execute(file_path)
Invoke the system handler to open the given file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
file_path |
str
|
The path for the file to be executed |
required |
Source code in botcity/core/bot.py
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 |
|
find(label, x=None, y=None, width=None, height=None, *, threshold=None, matching=0.9, waiting_time=10000, best=True, grayscale=False)
Find an element defined by label on screen until a timeout happens.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label |
str
|
The image identifier |
required |
x |
int
|
Search region start position x. Defaults to 0. |
None
|
y |
int
|
Search region start position y. Defaults to 0. |
None
|
width |
int
|
Search region width. Defaults to screen width. |
None
|
height |
int
|
Search region height. Defaults to screen height. |
None
|
threshold |
int
|
The threshold to be applied when doing grayscale search. Defaults to None. |
None
|
matching |
float
|
The matching index ranging from 0 to 1. Defaults to 0.9. |
0.9
|
waiting_time |
int
|
Maximum wait time (ms) to search for a hit. Defaults to 10000ms (10s). |
10000
|
best |
bool
|
Whether or not to keep looking until the best matching is found. Defaults to True. |
True
|
grayscale |
bool
|
Whether or not to convert to grayscale before searching. Defaults to False. |
False
|
Returns:
Name | Type | Description |
---|---|---|
element |
NamedTuple
|
The element coordinates. None if not found. |
Source code in botcity/core/bot.py
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
|
find_all(label, x=None, y=None, width=None, height=None, *, threshold=None, matching=0.9, waiting_time=10000, grayscale=False)
Find all elements defined by label on screen until a timeout happens.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label |
str
|
The image identifier |
required |
x |
int
|
Search region start position x. Defaults to 0. |
None
|
y |
int
|
Search region start position y. Defaults to 0. |
None
|
width |
int
|
Search region width. Defaults to screen width. |
None
|
height |
int
|
Search region height. Defaults to screen height. |
None
|
threshold |
int
|
The threshold to be applied when doing grayscale search. Defaults to None. |
None
|
matching |
float
|
The matching index ranging from 0 to 1. Defaults to 0.9. |
0.9
|
waiting_time |
int
|
Maximum wait time (ms) to search for a hit. Defaults to 10000ms (10s). |
10000
|
grayscale |
bool
|
Whether or not to convert to grayscale before searching. Defaults to False. |
False
|
Returns:
Name | Type | Description |
---|---|---|
elements |
collections.Iterable[NamedTuple]
|
A generator with all element coordinates fount. None if not found. |
Source code in botcity/core/bot.py
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 |
|
find_multiple(labels, x=None, y=None, width=None, height=None, *, threshold=None, matching=0.9, waiting_time=10000, best=True, grayscale=False)
Find multiple elements defined by label on screen until a timeout happens.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
labels |
list
|
A list of image identifiers |
required |
x |
int
|
Search region start position x. Defaults to 0. |
None
|
y |
int
|
Search region start position y. Defaults to 0. |
None
|
width |
int
|
Search region width. Defaults to screen width. |
None
|
height |
int
|
Search region height. Defaults to screen height. |
None
|
threshold |
int
|
The threshold to be applied when doing grayscale search. Defaults to None. |
None
|
matching |
float
|
The matching index ranging from 0 to 1. Defaults to 0.9. |
0.9
|
waiting_time |
int
|
Maximum wait time (ms) to search for a hit. Defaults to 10000ms (10s). |
10000
|
best |
bool
|
Whether or not to keep looking until the best matching is found. Defaults to True. |
True
|
grayscale |
bool
|
Whether or not to convert to grayscale before searching. Defaults to False. |
False
|
Returns:
Name | Type | Description |
---|---|---|
results |
dict
|
A dictionary in which the key is the label and value are the element coordinates in a NamedTuple. |
Source code in botcity/core/bot.py
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
|
find_text(label, x=None, y=None, width=None, height=None, *, threshold=None, matching=0.9, waiting_time=10000, best=True)
Find an element defined by label on screen until a timeout happens.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label |
str
|
The image identifier |
required |
x |
int
|
Search region start position x. Defaults to 0. |
None
|
y |
int
|
Search region start position y. Defaults to 0. |
None
|
width |
int
|
Search region width. Defaults to screen width. |
None
|
height |
int
|
Search region height. Defaults to screen height. |
None
|
threshold |
int
|
The threshold to be applied when doing grayscale search. Defaults to None. |
None
|
matching |
float
|
The matching index ranging from 0 to 1. Defaults to 0.9. |
0.9
|
waiting_time |
int
|
Maximum wait time (ms) to search for a hit. Defaults to 10000ms (10s). |
10000
|
best |
bool
|
Whether or not to keep looking until the best matching is found. Defaults to True. |
True
|
Returns:
Name | Type | Description |
---|---|---|
element |
NamedTuple
|
The element coordinates. None if not found. |
Source code in botcity/core/bot.py
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 |
|
find_until(label, x=None, y=None, width=None, height=None, *, threshold=None, matching=0.9, waiting_time=10000, best=True, grayscale=False)
Find an element defined by label on screen until a timeout happens.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label |
str
|
The image identifier |
required |
x |
int
|
Search region start position x. Defaults to 0. |
None
|
y |
int
|
Search region start position y. Defaults to 0. |
None
|
width |
int
|
Search region width. Defaults to screen width. |
None
|
height |
int
|
Search region height. Defaults to screen height. |
None
|
threshold |
int
|
The threshold to be applied when doing grayscale search. Defaults to None. |
None
|
matching |
float
|
The matching index ranging from 0 to 1. Defaults to 0.9. |
0.9
|
waiting_time |
int
|
Maximum wait time (ms) to search for a hit. Defaults to 10000ms (10s). |
10000
|
best |
bool
|
Whether or not to keep looking until the best matching is found. Defaults to True. |
True
|
grayscale |
bool
|
Whether or not to convert to grayscale before searching. Defaults to False. |
False
|
Returns:
Name | Type | Description |
---|---|---|
element |
NamedTuple
|
The element coordinates. None if not found. |
Source code in botcity/core/bot.py
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
|
get_clipboard()
Get the current content in the clipboard.
Returns:
Name | Type | Description |
---|---|---|
text |
str
|
Current clipboard content |
Source code in botcity/core/bot.py
1320 1321 1322 1323 1324 1325 1326 1327 |
|
get_element_coords(label, x=None, y=None, width=None, height=None, matching=0.9, best=True)
Find an element defined by label on screen and returns its coordinates.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label |
str
|
The image identifier |
required |
x |
int
|
X (Left) coordinate of the search area. |
None
|
y |
int
|
Y (Top) coordinate of the search area. |
None
|
width |
int
|
Width of the search area. |
None
|
height |
int
|
Height of the search area. |
None
|
matching |
float
|
Minimum score to consider a match in the element image recognition process. Defaults to 0.9. |
0.9
|
best |
bool
|
Whether or not to search for the best value. If False the method returns on the first find. Defaults to True. |
True
|
Returns:
Name | Type | Description |
---|---|---|
coords |
Tuple
|
A tuple containing the x and y coordinates for the element. |
Source code in botcity/core/bot.py
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 |
|
get_element_coords_centered(label, x=None, y=None, width=None, height=None, matching=0.9, best=True)
Find an element defined by label on screen and returns its centered coordinates.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label |
str
|
The image identifier |
required |
x |
int
|
X (Left) coordinate of the search area. |
None
|
y |
int
|
Y (Top) coordinate of the search area. |
None
|
width |
int
|
Width of the search area. |
None
|
height |
int
|
Height of the search area. |
None
|
matching |
float
|
Minimum score to consider a match in the element image recognition process. Defaults to 0.9. |
0.9
|
best |
bool
|
Whether or not to search for the best value. If False the method returns on the first find. Defaults to True. |
True
|
Returns:
Name | Type | Description |
---|---|---|
coords |
Tuple
|
A tuple containing the x and y coordinates for the center of the element. |
Source code in botcity/core/bot.py
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 |
|
get_image_from_map(label)
Return an image from teh state image map.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
label |
str
|
The image identifier |
required |
Returns:
Name | Type | Description |
---|---|---|
Image | The Image object |
Source code in botcity/core/bot.py
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
|
get_last_element()
Return the last element found.
Returns:
Name | Type | Description |
---|---|---|
element |
NamedTuple
|
The element coordinates (left, top, width, height) |
Source code in botcity/core/bot.py
408 409 410 411 412 413 414 415 |
|
get_last_x()
Get the last X position for the mouse.
Returns:
Name | Type | Description |
---|---|---|
x |
int
|
The last x position for the mouse. |
Source code in botcity/core/bot.py
590 591 592 593 594 595 596 597 |
|
get_last_y()
Get the last Y position for the mouse.
Returns:
Name | Type | Description |
---|---|---|
y |
int
|
The last y position for the mouse. |
Source code in botcity/core/bot.py
599 600 601 602 603 604 605 606 |
|
get_screenshot(filepath=None, region=None)
Capture a screenshot.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
filepath |
str
|
The filepath in which to save the screenshot. Defaults to None. |
None
|
region |
tuple
|
Bounding box containing left, top, width and height to crop screenshot. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Image | The screenshot Image object |
Source code in botcity/core/bot.py
441 442 443 444 445 446 447 448 449 450 451 452 |
|
hold_shift(wait=0)
Hold key Shift
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
995 996 997 998 999 1000 1001 1002 1003 1004 |
|
kb_type(text, interval=0)
Type a text char by char (individual key events).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str
|
text to be typed. |
required |
interval |
int
|
interval (ms) between each key press. Defaults to 0 |
0
|
Source code in botcity/core/bot.py
840 841 842 843 844 845 846 847 848 849 850 |
|
key_end(wait=0)
Press key End
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
922 923 924 925 926 927 928 929 930 931 932 |
|
key_enter(wait=0)
Press key Enter
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
912 913 914 915 916 917 918 919 920 |
|
key_esc(wait=0)
Press key Esc
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
934 935 936 937 938 939 940 941 942 943 944 |
|
key_right(wait=0)
Press key Right
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
900 901 902 903 904 905 906 907 908 909 910 |
|
maximize_window()
Shortcut to maximize window on Windows OS.
Source code in botcity/core/bot.py
1025 1026 1027 1028 1029 1030 1031 |
|
mouse_down(wait_after=config.DEFAULT_SLEEP_AFTER_ACTION, *, button='left')
Holds down the requested mouse button.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait_after |
int
|
Interval to wait after clicking on the element. |
config.DEFAULT_SLEEP_AFTER_ACTION
|
button |
str
|
One of 'left', 'right', 'middle'. Defaults to 'left' |
'left'
|
Source code in botcity/core/bot.py
712 713 714 715 716 717 718 719 720 721 |
|
mouse_move(x, y)
Mouse the move to the coordinate defined by x and y
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
int
|
The X coordinate |
required |
y |
int
|
The Y coordinate |
required |
Source code in botcity/core/bot.py
608 609 610 611 612 613 614 615 616 617 |
|
mouse_up(wait_after=config.DEFAULT_SLEEP_AFTER_ACTION, *, button='left')
Releases the requested mouse button.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait_after |
int
|
Interval to wait after clicking on the element. |
config.DEFAULT_SLEEP_AFTER_ACTION
|
button |
str
|
One of 'left', 'right', 'middle'. Defaults to 'left' |
'left'
|
Source code in botcity/core/bot.py
723 724 725 726 727 728 729 730 731 732 |
|
move()
Move to the center position of last found item.
Source code in botcity/core/bot.py
752 753 754 755 756 757 758 |
|
move_random(range_x, range_y)
Move randomly along the given x, y range.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
range_x |
int
|
Horizontal range |
required |
range_y |
int
|
Vertical range |
required |
Source code in botcity/core/bot.py
773 774 775 776 777 778 779 780 781 782 783 784 |
|
move_relative(x, y)
Move the mouse relative to its current position.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
int
|
Horizontal offset |
required |
y |
int
|
Vertical offset |
required |
Source code in botcity/core/bot.py
760 761 762 763 764 765 766 767 768 769 770 771 |
|
page_down(wait=0)
Press Page Down key
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 |
|
page_up(wait=0)
Press Page Up key
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 |
|
paste(text=None, wait=0)
Paste content from the clipboard.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str
|
The text to be pasted. Defaults to None |
None
|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
852 853 854 855 856 857 858 859 860 861 862 |
|
release_shift()
Release key Shift. This method needs to be invoked after holding Shift or similar.
Source code in botcity/core/bot.py
1006 1007 1008 1009 1010 1011 |
|
right_click(wait_after=config.DEFAULT_SLEEP_AFTER_ACTION, *, clicks=1, interval_between_clicks=0)
Right click on the last found element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait_after |
int
|
Interval to wait after clicking on the element. |
config.DEFAULT_SLEEP_AFTER_ACTION
|
clicks |
int
|
Number of times to click. Defaults to 1. |
1
|
interval_between_clicks |
int
|
The interval between clicks in ms. Defaults to 0. |
0
|
Source code in botcity/core/bot.py
786 787 788 789 790 791 792 793 794 795 796 797 798 799 |
|
right_click_at(x, y)
Right click at the coordinate defined by x and y
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
int
|
The X coordinate |
required |
y |
int
|
The Y coordinate |
required |
Source code in botcity/core/bot.py
801 802 803 804 805 806 807 808 809 |
|
right_click_relative(x, y, interval_between_clicks=0, wait_after=config.DEFAULT_SLEEP_AFTER_ACTION)
Right Click Relative on the last found element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
int
|
Horizontal offset |
required |
y |
int
|
Vertical offset |
required |
interval_between_clicks |
int
|
The interval between clicks in ms. Defaults to 0. |
0
|
wait_after |
int
|
Interval to wait after clicking on the element. |
config.DEFAULT_SLEEP_AFTER_ACTION
|
Source code in botcity/core/bot.py
811 812 813 814 815 816 817 818 819 820 821 822 823 |
|
save_screenshot(path)
Saves a screenshot in a given path.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
str
|
The filepath in which to save the screenshot |
required |
Source code in botcity/core/bot.py
475 476 477 478 479 480 481 482 483 |
|
screen_cut(x, y, width=None, height=None)
Capture a screenshot from a region of the screen.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
int
|
region start position x |
required |
y |
int
|
region start position y |
required |
width |
int
|
region width |
None
|
height |
int
|
region height |
None
|
Returns:
Name | Type | Description |
---|---|---|
Image | The screenshot Image object |
Source code in botcity/core/bot.py
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
|
screenshot(filepath=None, region=None)
Capture a screenshot.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
filepath |
str
|
The filepath in which to save the screenshot. Defaults to None. |
None
|
region |
tuple
|
Bounding box containing left, top, width and height to crop screenshot. |
None
|
Returns:
Name | Type | Description |
---|---|---|
Image | The screenshot Image object |
Source code in botcity/core/bot.py
427 428 429 430 431 432 433 434 435 436 437 438 439 |
|
scroll_down(clicks)
Scroll Down n clicks
Parameters:
Name | Type | Description | Default |
---|---|---|---|
clicks |
int
|
Number of times to scroll down. |
required |
Source code in botcity/core/bot.py
734 735 736 737 738 739 740 741 |
|
scroll_up(clicks)
Scroll Up n clicks
Parameters:
Name | Type | Description | Default |
---|---|---|---|
clicks |
int
|
Number of times to scroll up. |
required |
Source code in botcity/core/bot.py
743 744 745 746 747 748 749 750 |
|
shift_tab(wait=0)
Press keys Shift+Tab
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 |
|
sleep(interval)
Wait / Sleep for a given interval.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interval |
int
|
Interval in milliseconds |
required |
Source code in botcity/core/bot.py
1497 1498 1499 1500 1501 1502 1503 1504 1505 |
|
space(wait=0)
Press Space key
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 |
|
tab(wait=0)
Press key Tab
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
876 877 878 879 880 881 882 883 884 885 886 |
|
triple_click(wait_after=config.DEFAULT_SLEEP_AFTER_ACTION)
Triple Click on the last found element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait_after |
int
|
Interval to wait after clicking on the element. |
config.DEFAULT_SLEEP_AFTER_ACTION
|
Source code in botcity/core/bot.py
688 689 690 691 692 693 694 695 696 |
|
triple_click_relative(x, y, interval_between_clicks=0, wait_after=config.DEFAULT_SLEEP_AFTER_ACTION)
Triple Click Relative on the last found element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
int
|
Horizontal offset |
required |
y |
int
|
Vertical offset |
required |
interval_between_clicks |
int
|
The interval between clicks in ms. Defaults to 0. |
0
|
wait_after |
int
|
Interval to wait after clicking on the element. |
config.DEFAULT_SLEEP_AFTER_ACTION
|
Source code in botcity/core/bot.py
698 699 700 701 702 703 704 705 706 707 708 709 710 |
|
type_down(wait=0)
Press Down key
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 |
|
type_key(text, interval=0)
Type a text char by char (individual key events).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
text |
str
|
text to be typed. |
required |
interval |
int
|
interval (ms) between each key press. Defaults to 0 |
0
|
Source code in botcity/core/bot.py
829 830 831 832 833 834 835 836 837 838 |
|
type_keys(keys)
Press a sequence of keys. Hold the keys in the specific order and releases them.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
keys |
list
|
List of keys to be pressed |
required |
Source code in botcity/core/bot.py
1043 1044 1045 1046 1047 1048 1049 1050 |
|
type_keys_with_interval(interval, keys)
Press a sequence of keys. Hold the keys in the specific order and releases them.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interval |
int
|
Interval (ms) in which to press and release keys |
required |
keys |
list
|
List of keys to be pressed |
required |
Source code in botcity/core/bot.py
1033 1034 1035 1036 1037 1038 1039 1040 1041 |
|
type_left(wait=0)
Press Left key
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 |
|
type_right(wait=0)
Press Right key
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 |
|
type_up(wait=0)
Press Up key
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 |
|
type_windows(wait=0)
Press Win logo key
Parameters:
Name | Type | Description | Default |
---|---|---|---|
wait |
int
|
Wait interval (ms) after task |
0
|
Source code in botcity/core/bot.py
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 |
|
wait(interval)
Wait / Sleep for a given interval.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
interval |
int
|
Interval in milliseconds |
required |
Source code in botcity/core/bot.py
1487 1488 1489 1490 1491 1492 1493 1494 1495 |
|
wait_for_file(path, timeout=10000)
Invoke the system handler to open the given file.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
str
|
The path for the file to be executed |
required |
timeout |
int
|
Maximum wait time (ms) to search for a hit. Defaults to 10000ms (10s). |
10000
|
Returns status (bool): Whether or not the file was available before the timeout
Source code in botcity/core/bot.py
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 |
|