├── .readthedocs.yaml ├── CHANGELOG.md ├── LICENSE ├── README.md ├── dist ├── pyrobloxbot-1.0.9-py3-none-any.whl └── pyrobloxbot-1.0.9.tar.gz ├── docs ├── Makefile ├── build │ ├── doctrees │ │ ├── environment.pickle │ │ ├── index.doctree │ │ ├── modules.doctree │ │ └── pyrobloxbot.doctree │ └── html │ │ ├── .buildinfo │ │ ├── _sources │ │ ├── index.rst.txt │ │ ├── modules.rst.txt │ │ └── pyrobloxbot.rst.txt │ │ ├── _static │ │ ├── _sphinx_javascript_frameworks_compat.js │ │ ├── basic.css │ │ ├── css │ │ │ ├── badge_only.css │ │ │ ├── fonts │ │ │ │ ├── Roboto-Slab-Bold.woff │ │ │ │ ├── Roboto-Slab-Bold.woff2 │ │ │ │ ├── Roboto-Slab-Regular.woff │ │ │ │ ├── Roboto-Slab-Regular.woff2 │ │ │ │ ├── fontawesome-webfont.eot │ │ │ │ ├── fontawesome-webfont.svg │ │ │ │ ├── fontawesome-webfont.ttf │ │ │ │ ├── fontawesome-webfont.woff │ │ │ │ ├── fontawesome-webfont.woff2 │ │ │ │ ├── lato-bold-italic.woff │ │ │ │ ├── lato-bold-italic.woff2 │ │ │ │ ├── lato-bold.woff │ │ │ │ ├── lato-bold.woff2 │ │ │ │ ├── lato-normal-italic.woff │ │ │ │ ├── lato-normal-italic.woff2 │ │ │ │ ├── lato-normal.woff │ │ │ │ └── lato-normal.woff2 │ │ │ └── theme.css │ │ ├── doctools.js │ │ ├── documentation_options.js │ │ ├── file.png │ │ ├── jquery.js │ │ ├── js │ │ │ ├── badge_only.js │ │ │ ├── html5shiv-printshiv.min.js │ │ │ ├── html5shiv.min.js │ │ │ └── theme.js │ │ ├── language_data.js │ │ ├── minus.png │ │ ├── plus.png │ │ ├── pygments.css │ │ ├── searchtools.js │ │ └── sphinx_highlight.js │ │ ├── genindex.html │ │ ├── index.html │ │ ├── modules.html │ │ ├── objects.inv │ │ ├── py-modindex.html │ │ ├── pyrobloxbot.html │ │ ├── search.html │ │ └── searchindex.js ├── make.bat └── source │ ├── conf.py │ ├── index.rst │ ├── modules.rst │ └── pyrobloxbot.rst ├── outdated dists ├── dist 1.0.0 │ ├── pyrobloxbot-1.0.0-py3-none-any.whl │ └── pyrobloxbot-1.0.0.tar.gz ├── dist 1.0.1 │ ├── pyrobloxbot-1.0.1-py3-none-any.whl │ └── pyrobloxbot-1.0.1.tar.gz ├── dist 1.0.2 │ ├── pyrobloxbot-1.0.2-py3-none-any.whl │ └── pyrobloxbot-1.0.2.tar.gz ├── dist 1.0.3 │ ├── pyrobloxbot-1.0.3-py3-none-any.whl │ └── pyrobloxbot-1.0.3.tar.gz ├── dist 1.0.4 │ ├── pyrobloxbot-1.0.4-py3-none-any.whl │ └── pyrobloxbot-1.0.4.tar.gz ├── dist 1.0.5 │ ├── pyrobloxbot-1.0.5-py3-none-any.whl │ └── pyrobloxbot-1.0.5.tar.gz ├── dist 1.0.6 │ ├── pyrobloxbot-1.0.6-py3-none-any.whl │ └── pyrobloxbot-1.0.6.tar.gz ├── dist 1.0.7 │ ├── pyrobloxbot-1.0.7-py3-none-any.whl │ └── pyrobloxbot-1.0.7.tar.gz └── dist 1.0.8 │ ├── pyrobloxbot-1.0.8-py3-none-any.whl │ └── pyrobloxbot-1.0.8.tar.gz ├── pyproject.toml ├── requirements.txt └── src └── pyrobloxbot ├── __init__.py ├── exceptions.py └── literals.py /.readthedocs.yaml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | 3 | build: 4 | os: "ubuntu-22.04" 5 | tools: 6 | python: "3.9" 7 | 8 | python: 9 | install: 10 | - requirements: requirements.txt 11 | 12 | sphinx: 13 | configuration: docs/source/conf.py -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | ### 1.0.9 3 | - Added docs for the module's global variables 4 | 5 | - Added `launch_game` function to open a roblox game from its id 6 | 7 | Example: 8 | 9 | ```python 10 | import pyrobloxbot as bot 11 | 12 | id = 2753915549 # The game id for Blox Fruits 13 | bot.launch_game(id) 14 | ``` 15 | 16 | - Added `press_key` and `hold_key` aliases for `keyboard_action` and `hold_keyboard_action` functions respectively 17 | 18 | - Added `ui_scroll_up` and `ui_scroll_down` functions to scroll through ui elements 19 | 20 | - Added `key_up` and `key_down` functions to hold and release keys without blocking execution 21 | 22 | - Fixed issue with using `leave_game` function while ui navigation is enabled 23 | 24 | - Added `image_is_visible` function to check wheter a given image is present on screen 25 | 26 | Example: 27 | ```python 28 | import pyrobloxbot as bot 29 | from time import sleep 30 | 31 | #Wait until the button.png image is visible before continuing 32 | #The function only has to be 80% confident about whether the image is visible to continue 33 | #This is still almost guaranteed to not give false positives 34 | 35 | while not bot.image_is_visible("button.png", confidence=0.8): 36 | sleep(0.5) #Wait a bit before checking again 37 | 38 | print("The button is on screen!") 39 | ``` 40 | 41 | ### 1.0.8 42 | This version was missing some dependencies 43 | 44 | Other than that, the changes present in 1.0.9 also apply to this version, even though using it isn't recommended 45 | 46 | ### 1.0.7 47 | - Added failsafe that can be triggered by key combination (default is control + m) 48 | 49 | The failsafe hotkey can be changed through `set_failsafe_hotkey` 50 | 51 | Example: 52 | ```python 53 | #Sets the failsafe hotkey to control + shift + y 54 | set_failsafe_hotkey("ctrl", "shift", "y") 55 | ``` 56 | 57 | - The key used to toggle the ui navigation mode can now be changed by changing the `UI_NAV_KEY` variable 58 | 59 | Example: 60 | ```python 61 | import pyrobloxbot as bot 62 | bot.UI_NAV_KEY = "~" # The tilde key will now be used to turn on the ui navigation mode 63 | ``` 64 | 65 | - Added `ui_navigate` function which takes a direction string and calls the corresponding ui navigation function 66 | 67 | `ui_navigate` raises `InvalidUiDirectionException` if the direction argument is not in `literals.UI_NAVIGATE_DIRECTIONS.VALUES` 68 | 69 | - `walk` function can now take multiple walk directions as arguments at the same time to walk diagonally 70 | 71 | ### 1.0.6 72 | - `require_focus` decorator no longer runs when importing module 73 | 74 | - `keyboard_action` and `hold_keyboard_action` can now take multiple keys as arguments at the same time 75 | 76 | Example: 77 | 78 | ```python 79 | #Hold "a", "b" and "c" at the same time for 2 seconds 80 | hold_keyboard_action("a", "b", "c", duration=2) 81 | ``` 82 | 83 | ### 1.0.5 84 | Added docstrings 85 | 86 | ### 1.0.4 87 | First stable release -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # pyrobloxbot 3 | 4 | [![Documentation badge](https://readthedocs.org/projects/pyrobloxbot/badge/?version=latest&style=flat-default)](https://pyrobloxbot.readthedocs.io/en/latest/pyrobloxbot.html) 5 | [![PyPI Version](https://img.shields.io/pypi/v/pyrobloxbot?label=pypi%20package)](https://pypi.python.org/pypi/pyrobloxbot) 6 | [![PyPI Downloads](https://img.shields.io/pypi/dm/pyrobloxbot)](https://pypi.python.org/pypi/pyrobloxbot) 7 | 8 | A python library to control the roblox character and interact with game ui through keyboard inputs 9 | 10 | This library uses ```pydirectinput``` to control the keyboard 11 | 12 | It has a decorator to ensure that the roblox window is in focus before sending keyboard inputs 13 | 14 | There is also a global failsafe that can be triggered using _**control + m**_ to avoid your bot getting out of control 15 | - The failsafe hotkey can be changed using `set_failsafe_hotkey` 16 | 17 | Example: 18 | ```python 19 | #Sets the failsafe hotkey to control + shift + y 20 | set_failsafe_hotkey("ctrl", "shift", "y") 21 | ``` 22 | 23 | If you have any issues while using the library, please reach out through my discord (mews75) 24 | 25 | ## Installation 26 | 27 | Install pyrobloxbot using ```pip install pyrobloxbot``` 28 | 29 | ## Usage/Examples 30 | 31 | ```python 32 | import pyrobloxbot as bot 33 | 34 | #Send a message in chat 35 | bot.chat("Hello world!") 36 | 37 | #Walk forward for 5 seconds 38 | bot.walk_forward(5) 39 | 40 | #Reset player character 41 | bot.reset_player() 42 | ``` 43 | 44 | ## [Documentation](https://pyrobloxbot.readthedocs.io/en/latest/pyrobloxbot.html) 45 | 46 | ## [Changelog](https://github.com/Mews/py-roblox-bot/blob/main/CHANGELOG.md) 47 | -------------------------------------------------------------------------------- /dist/pyrobloxbot-1.0.9-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/dist/pyrobloxbot-1.0.9-py3-none-any.whl -------------------------------------------------------------------------------- /dist/pyrobloxbot-1.0.9.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/dist/pyrobloxbot-1.0.9.tar.gz -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line, and also 5 | # from the environment for the first two. 6 | SPHINXOPTS ?= 7 | SPHINXBUILD ?= sphinx-build 8 | SOURCEDIR = source 9 | BUILDDIR = build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | -------------------------------------------------------------------------------- /docs/build/doctrees/environment.pickle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/doctrees/environment.pickle -------------------------------------------------------------------------------- /docs/build/doctrees/index.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/doctrees/index.doctree -------------------------------------------------------------------------------- /docs/build/doctrees/modules.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/doctrees/modules.doctree -------------------------------------------------------------------------------- /docs/build/doctrees/pyrobloxbot.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/doctrees/pyrobloxbot.doctree -------------------------------------------------------------------------------- /docs/build/html/.buildinfo: -------------------------------------------------------------------------------- 1 | # Sphinx build info version 1 2 | # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. 3 | config: 599b6c6bdecd1ce1d9620aa0a0215bf8 4 | tags: 645f666f9bcd5a90fca523b33c5a78b7 5 | -------------------------------------------------------------------------------- /docs/build/html/_sources/index.rst.txt: -------------------------------------------------------------------------------- 1 | .. pyrobloxbot documentation master file, created by 2 | sphinx-quickstart on Tue Feb 13 20:28:32 2024. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | Welcome to pyrobloxbot's documentation! 7 | ======================================= 8 | 9 | .. toctree:: 10 | :maxdepth: 2 11 | :caption: Contents: 12 | 13 | 14 | 15 | Indices and tables 16 | ================== 17 | 18 | * :ref:`genindex` 19 | * :ref:`modindex` 20 | * :ref:`search` 21 | -------------------------------------------------------------------------------- /docs/build/html/_sources/modules.rst.txt: -------------------------------------------------------------------------------- 1 | pyrobloxbot 2 | =========== 3 | 4 | .. toctree:: 5 | :maxdepth: 4 6 | 7 | pyrobloxbot 8 | -------------------------------------------------------------------------------- /docs/build/html/_sources/pyrobloxbot.rst.txt: -------------------------------------------------------------------------------- 1 | pyrobloxbot package 2 | =================== 3 | 4 | Submodules 5 | ---------- 6 | 7 | pyrobloxbot.exceptions module 8 | ----------------------------- 9 | 10 | .. automodule:: pyrobloxbot.exceptions 11 | :members: 12 | :undoc-members: 13 | :show-inheritance: 14 | 15 | pyrobloxbot.literals module 16 | --------------------------- 17 | 18 | .. automodule:: pyrobloxbot.literals 19 | :members: 20 | :undoc-members: 21 | :show-inheritance: 22 | 23 | Module contents 24 | --------------- 25 | 26 | .. automodule:: pyrobloxbot 27 | :members: 28 | :undoc-members: 29 | :show-inheritance: 30 | -------------------------------------------------------------------------------- /docs/build/html/_static/_sphinx_javascript_frameworks_compat.js: -------------------------------------------------------------------------------- 1 | /* Compatability shim for jQuery and underscores.js. 2 | * 3 | * Copyright Sphinx contributors 4 | * Released under the two clause BSD licence 5 | */ 6 | 7 | /** 8 | * small helper function to urldecode strings 9 | * 10 | * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL 11 | */ 12 | jQuery.urldecode = function(x) { 13 | if (!x) { 14 | return x 15 | } 16 | return decodeURIComponent(x.replace(/\+/g, ' ')); 17 | }; 18 | 19 | /** 20 | * small helper function to urlencode strings 21 | */ 22 | jQuery.urlencode = encodeURIComponent; 23 | 24 | /** 25 | * This function returns the parsed url parameters of the 26 | * current request. Multiple values per key are supported, 27 | * it will always return arrays of strings for the value parts. 28 | */ 29 | jQuery.getQueryParameters = function(s) { 30 | if (typeof s === 'undefined') 31 | s = document.location.search; 32 | var parts = s.substr(s.indexOf('?') + 1).split('&'); 33 | var result = {}; 34 | for (var i = 0; i < parts.length; i++) { 35 | var tmp = parts[i].split('=', 2); 36 | var key = jQuery.urldecode(tmp[0]); 37 | var value = jQuery.urldecode(tmp[1]); 38 | if (key in result) 39 | result[key].push(value); 40 | else 41 | result[key] = [value]; 42 | } 43 | return result; 44 | }; 45 | 46 | /** 47 | * highlight a given string on a jquery object by wrapping it in 48 | * span elements with the given class name. 49 | */ 50 | jQuery.fn.highlightText = function(text, className) { 51 | function highlight(node, addItems) { 52 | if (node.nodeType === 3) { 53 | var val = node.nodeValue; 54 | var pos = val.toLowerCase().indexOf(text); 55 | if (pos >= 0 && 56 | !jQuery(node.parentNode).hasClass(className) && 57 | !jQuery(node.parentNode).hasClass("nohighlight")) { 58 | var span; 59 | var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); 60 | if (isInSVG) { 61 | span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); 62 | } else { 63 | span = document.createElement("span"); 64 | span.className = className; 65 | } 66 | span.appendChild(document.createTextNode(val.substr(pos, text.length))); 67 | node.parentNode.insertBefore(span, node.parentNode.insertBefore( 68 | document.createTextNode(val.substr(pos + text.length)), 69 | node.nextSibling)); 70 | node.nodeValue = val.substr(0, pos); 71 | if (isInSVG) { 72 | var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); 73 | var bbox = node.parentElement.getBBox(); 74 | rect.x.baseVal.value = bbox.x; 75 | rect.y.baseVal.value = bbox.y; 76 | rect.width.baseVal.value = bbox.width; 77 | rect.height.baseVal.value = bbox.height; 78 | rect.setAttribute('class', className); 79 | addItems.push({ 80 | "parent": node.parentNode, 81 | "target": rect}); 82 | } 83 | } 84 | } 85 | else if (!jQuery(node).is("button, select, textarea")) { 86 | jQuery.each(node.childNodes, function() { 87 | highlight(this, addItems); 88 | }); 89 | } 90 | } 91 | var addItems = []; 92 | var result = this.each(function() { 93 | highlight(this, addItems); 94 | }); 95 | for (var i = 0; i < addItems.length; ++i) { 96 | jQuery(addItems[i].parent).before(addItems[i].target); 97 | } 98 | return result; 99 | }; 100 | 101 | /* 102 | * backward compatibility for jQuery.browser 103 | * This will be supported until firefox bug is fixed. 104 | */ 105 | if (!jQuery.browser) { 106 | jQuery.uaMatch = function(ua) { 107 | ua = ua.toLowerCase(); 108 | 109 | var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || 110 | /(webkit)[ \/]([\w.]+)/.exec(ua) || 111 | /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || 112 | /(msie) ([\w.]+)/.exec(ua) || 113 | ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || 114 | []; 115 | 116 | return { 117 | browser: match[ 1 ] || "", 118 | version: match[ 2 ] || "0" 119 | }; 120 | }; 121 | jQuery.browser = {}; 122 | jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; 123 | } 124 | -------------------------------------------------------------------------------- /docs/build/html/_static/basic.css: -------------------------------------------------------------------------------- 1 | /* 2 | * basic.css 3 | * ~~~~~~~~~ 4 | * 5 | * Sphinx stylesheet -- basic theme. 6 | * 7 | * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | /* -- main layout ----------------------------------------------------------- */ 13 | 14 | div.clearer { 15 | clear: both; 16 | } 17 | 18 | div.section::after { 19 | display: block; 20 | content: ''; 21 | clear: left; 22 | } 23 | 24 | /* -- relbar ---------------------------------------------------------------- */ 25 | 26 | div.related { 27 | width: 100%; 28 | font-size: 90%; 29 | } 30 | 31 | div.related h3 { 32 | display: none; 33 | } 34 | 35 | div.related ul { 36 | margin: 0; 37 | padding: 0 0 0 10px; 38 | list-style: none; 39 | } 40 | 41 | div.related li { 42 | display: inline; 43 | } 44 | 45 | div.related li.right { 46 | float: right; 47 | margin-right: 5px; 48 | } 49 | 50 | /* -- sidebar --------------------------------------------------------------- */ 51 | 52 | div.sphinxsidebarwrapper { 53 | padding: 10px 5px 0 10px; 54 | } 55 | 56 | div.sphinxsidebar { 57 | float: left; 58 | width: 230px; 59 | margin-left: -100%; 60 | font-size: 90%; 61 | word-wrap: break-word; 62 | overflow-wrap : break-word; 63 | } 64 | 65 | div.sphinxsidebar ul { 66 | list-style: none; 67 | } 68 | 69 | div.sphinxsidebar ul ul, 70 | div.sphinxsidebar ul.want-points { 71 | margin-left: 20px; 72 | list-style: square; 73 | } 74 | 75 | div.sphinxsidebar ul ul { 76 | margin-top: 0; 77 | margin-bottom: 0; 78 | } 79 | 80 | div.sphinxsidebar form { 81 | margin-top: 10px; 82 | } 83 | 84 | div.sphinxsidebar input { 85 | border: 1px solid #98dbcc; 86 | font-family: sans-serif; 87 | font-size: 1em; 88 | } 89 | 90 | div.sphinxsidebar #searchbox form.search { 91 | overflow: hidden; 92 | } 93 | 94 | div.sphinxsidebar #searchbox input[type="text"] { 95 | float: left; 96 | width: 80%; 97 | padding: 0.25em; 98 | box-sizing: border-box; 99 | } 100 | 101 | div.sphinxsidebar #searchbox input[type="submit"] { 102 | float: left; 103 | width: 20%; 104 | border-left: none; 105 | padding: 0.25em; 106 | box-sizing: border-box; 107 | } 108 | 109 | 110 | img { 111 | border: 0; 112 | max-width: 100%; 113 | } 114 | 115 | /* -- search page ----------------------------------------------------------- */ 116 | 117 | ul.search { 118 | margin: 10px 0 0 20px; 119 | padding: 0; 120 | } 121 | 122 | ul.search li { 123 | padding: 5px 0 5px 20px; 124 | background-image: url(file.png); 125 | background-repeat: no-repeat; 126 | background-position: 0 7px; 127 | } 128 | 129 | ul.search li a { 130 | font-weight: bold; 131 | } 132 | 133 | ul.search li p.context { 134 | color: #888; 135 | margin: 2px 0 0 30px; 136 | text-align: left; 137 | } 138 | 139 | ul.keywordmatches li.goodmatch a { 140 | font-weight: bold; 141 | } 142 | 143 | /* -- index page ------------------------------------------------------------ */ 144 | 145 | table.contentstable { 146 | width: 90%; 147 | margin-left: auto; 148 | margin-right: auto; 149 | } 150 | 151 | table.contentstable p.biglink { 152 | line-height: 150%; 153 | } 154 | 155 | a.biglink { 156 | font-size: 1.3em; 157 | } 158 | 159 | span.linkdescr { 160 | font-style: italic; 161 | padding-top: 5px; 162 | font-size: 90%; 163 | } 164 | 165 | /* -- general index --------------------------------------------------------- */ 166 | 167 | table.indextable { 168 | width: 100%; 169 | } 170 | 171 | table.indextable td { 172 | text-align: left; 173 | vertical-align: top; 174 | } 175 | 176 | table.indextable ul { 177 | margin-top: 0; 178 | margin-bottom: 0; 179 | list-style-type: none; 180 | } 181 | 182 | table.indextable > tbody > tr > td > ul { 183 | padding-left: 0em; 184 | } 185 | 186 | table.indextable tr.pcap { 187 | height: 10px; 188 | } 189 | 190 | table.indextable tr.cap { 191 | margin-top: 10px; 192 | background-color: #f2f2f2; 193 | } 194 | 195 | img.toggler { 196 | margin-right: 3px; 197 | margin-top: 3px; 198 | cursor: pointer; 199 | } 200 | 201 | div.modindex-jumpbox { 202 | border-top: 1px solid #ddd; 203 | border-bottom: 1px solid #ddd; 204 | margin: 1em 0 1em 0; 205 | padding: 0.4em; 206 | } 207 | 208 | div.genindex-jumpbox { 209 | border-top: 1px solid #ddd; 210 | border-bottom: 1px solid #ddd; 211 | margin: 1em 0 1em 0; 212 | padding: 0.4em; 213 | } 214 | 215 | /* -- domain module index --------------------------------------------------- */ 216 | 217 | table.modindextable td { 218 | padding: 2px; 219 | border-collapse: collapse; 220 | } 221 | 222 | /* -- general body styles --------------------------------------------------- */ 223 | 224 | div.body { 225 | min-width: 360px; 226 | max-width: 800px; 227 | } 228 | 229 | div.body p, div.body dd, div.body li, div.body blockquote { 230 | -moz-hyphens: auto; 231 | -ms-hyphens: auto; 232 | -webkit-hyphens: auto; 233 | hyphens: auto; 234 | } 235 | 236 | a.headerlink { 237 | visibility: hidden; 238 | } 239 | 240 | a:visited { 241 | color: #551A8B; 242 | } 243 | 244 | h1:hover > a.headerlink, 245 | h2:hover > a.headerlink, 246 | h3:hover > a.headerlink, 247 | h4:hover > a.headerlink, 248 | h5:hover > a.headerlink, 249 | h6:hover > a.headerlink, 250 | dt:hover > a.headerlink, 251 | caption:hover > a.headerlink, 252 | p.caption:hover > a.headerlink, 253 | div.code-block-caption:hover > a.headerlink { 254 | visibility: visible; 255 | } 256 | 257 | div.body p.caption { 258 | text-align: inherit; 259 | } 260 | 261 | div.body td { 262 | text-align: left; 263 | } 264 | 265 | .first { 266 | margin-top: 0 !important; 267 | } 268 | 269 | p.rubric { 270 | margin-top: 30px; 271 | font-weight: bold; 272 | } 273 | 274 | img.align-left, figure.align-left, .figure.align-left, object.align-left { 275 | clear: left; 276 | float: left; 277 | margin-right: 1em; 278 | } 279 | 280 | img.align-right, figure.align-right, .figure.align-right, object.align-right { 281 | clear: right; 282 | float: right; 283 | margin-left: 1em; 284 | } 285 | 286 | img.align-center, figure.align-center, .figure.align-center, object.align-center { 287 | display: block; 288 | margin-left: auto; 289 | margin-right: auto; 290 | } 291 | 292 | img.align-default, figure.align-default, .figure.align-default { 293 | display: block; 294 | margin-left: auto; 295 | margin-right: auto; 296 | } 297 | 298 | .align-left { 299 | text-align: left; 300 | } 301 | 302 | .align-center { 303 | text-align: center; 304 | } 305 | 306 | .align-default { 307 | text-align: center; 308 | } 309 | 310 | .align-right { 311 | text-align: right; 312 | } 313 | 314 | /* -- sidebars -------------------------------------------------------------- */ 315 | 316 | div.sidebar, 317 | aside.sidebar { 318 | margin: 0 0 0.5em 1em; 319 | border: 1px solid #ddb; 320 | padding: 7px; 321 | background-color: #ffe; 322 | width: 40%; 323 | float: right; 324 | clear: right; 325 | overflow-x: auto; 326 | } 327 | 328 | p.sidebar-title { 329 | font-weight: bold; 330 | } 331 | 332 | nav.contents, 333 | aside.topic, 334 | div.admonition, div.topic, blockquote { 335 | clear: left; 336 | } 337 | 338 | /* -- topics ---------------------------------------------------------------- */ 339 | 340 | nav.contents, 341 | aside.topic, 342 | div.topic { 343 | border: 1px solid #ccc; 344 | padding: 7px; 345 | margin: 10px 0 10px 0; 346 | } 347 | 348 | p.topic-title { 349 | font-size: 1.1em; 350 | font-weight: bold; 351 | margin-top: 10px; 352 | } 353 | 354 | /* -- admonitions ----------------------------------------------------------- */ 355 | 356 | div.admonition { 357 | margin-top: 10px; 358 | margin-bottom: 10px; 359 | padding: 7px; 360 | } 361 | 362 | div.admonition dt { 363 | font-weight: bold; 364 | } 365 | 366 | p.admonition-title { 367 | margin: 0px 10px 5px 0px; 368 | font-weight: bold; 369 | } 370 | 371 | div.body p.centered { 372 | text-align: center; 373 | margin-top: 25px; 374 | } 375 | 376 | /* -- content of sidebars/topics/admonitions -------------------------------- */ 377 | 378 | div.sidebar > :last-child, 379 | aside.sidebar > :last-child, 380 | nav.contents > :last-child, 381 | aside.topic > :last-child, 382 | div.topic > :last-child, 383 | div.admonition > :last-child { 384 | margin-bottom: 0; 385 | } 386 | 387 | div.sidebar::after, 388 | aside.sidebar::after, 389 | nav.contents::after, 390 | aside.topic::after, 391 | div.topic::after, 392 | div.admonition::after, 393 | blockquote::after { 394 | display: block; 395 | content: ''; 396 | clear: both; 397 | } 398 | 399 | /* -- tables ---------------------------------------------------------------- */ 400 | 401 | table.docutils { 402 | margin-top: 10px; 403 | margin-bottom: 10px; 404 | border: 0; 405 | border-collapse: collapse; 406 | } 407 | 408 | table.align-center { 409 | margin-left: auto; 410 | margin-right: auto; 411 | } 412 | 413 | table.align-default { 414 | margin-left: auto; 415 | margin-right: auto; 416 | } 417 | 418 | table caption span.caption-number { 419 | font-style: italic; 420 | } 421 | 422 | table caption span.caption-text { 423 | } 424 | 425 | table.docutils td, table.docutils th { 426 | padding: 1px 8px 1px 5px; 427 | border-top: 0; 428 | border-left: 0; 429 | border-right: 0; 430 | border-bottom: 1px solid #aaa; 431 | } 432 | 433 | th { 434 | text-align: left; 435 | padding-right: 5px; 436 | } 437 | 438 | table.citation { 439 | border-left: solid 1px gray; 440 | margin-left: 1px; 441 | } 442 | 443 | table.citation td { 444 | border-bottom: none; 445 | } 446 | 447 | th > :first-child, 448 | td > :first-child { 449 | margin-top: 0px; 450 | } 451 | 452 | th > :last-child, 453 | td > :last-child { 454 | margin-bottom: 0px; 455 | } 456 | 457 | /* -- figures --------------------------------------------------------------- */ 458 | 459 | div.figure, figure { 460 | margin: 0.5em; 461 | padding: 0.5em; 462 | } 463 | 464 | div.figure p.caption, figcaption { 465 | padding: 0.3em; 466 | } 467 | 468 | div.figure p.caption span.caption-number, 469 | figcaption span.caption-number { 470 | font-style: italic; 471 | } 472 | 473 | div.figure p.caption span.caption-text, 474 | figcaption span.caption-text { 475 | } 476 | 477 | /* -- field list styles ----------------------------------------------------- */ 478 | 479 | table.field-list td, table.field-list th { 480 | border: 0 !important; 481 | } 482 | 483 | .field-list ul { 484 | margin: 0; 485 | padding-left: 1em; 486 | } 487 | 488 | .field-list p { 489 | margin: 0; 490 | } 491 | 492 | .field-name { 493 | -moz-hyphens: manual; 494 | -ms-hyphens: manual; 495 | -webkit-hyphens: manual; 496 | hyphens: manual; 497 | } 498 | 499 | /* -- hlist styles ---------------------------------------------------------- */ 500 | 501 | table.hlist { 502 | margin: 1em 0; 503 | } 504 | 505 | table.hlist td { 506 | vertical-align: top; 507 | } 508 | 509 | /* -- object description styles --------------------------------------------- */ 510 | 511 | .sig { 512 | font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; 513 | } 514 | 515 | .sig-name, code.descname { 516 | background-color: transparent; 517 | font-weight: bold; 518 | } 519 | 520 | .sig-name { 521 | font-size: 1.1em; 522 | } 523 | 524 | code.descname { 525 | font-size: 1.2em; 526 | } 527 | 528 | .sig-prename, code.descclassname { 529 | background-color: transparent; 530 | } 531 | 532 | .optional { 533 | font-size: 1.3em; 534 | } 535 | 536 | .sig-paren { 537 | font-size: larger; 538 | } 539 | 540 | .sig-param.n { 541 | font-style: italic; 542 | } 543 | 544 | /* C++ specific styling */ 545 | 546 | .sig-inline.c-texpr, 547 | .sig-inline.cpp-texpr { 548 | font-family: unset; 549 | } 550 | 551 | .sig.c .k, .sig.c .kt, 552 | .sig.cpp .k, .sig.cpp .kt { 553 | color: #0033B3; 554 | } 555 | 556 | .sig.c .m, 557 | .sig.cpp .m { 558 | color: #1750EB; 559 | } 560 | 561 | .sig.c .s, .sig.c .sc, 562 | .sig.cpp .s, .sig.cpp .sc { 563 | color: #067D17; 564 | } 565 | 566 | 567 | /* -- other body styles ----------------------------------------------------- */ 568 | 569 | ol.arabic { 570 | list-style: decimal; 571 | } 572 | 573 | ol.loweralpha { 574 | list-style: lower-alpha; 575 | } 576 | 577 | ol.upperalpha { 578 | list-style: upper-alpha; 579 | } 580 | 581 | ol.lowerroman { 582 | list-style: lower-roman; 583 | } 584 | 585 | ol.upperroman { 586 | list-style: upper-roman; 587 | } 588 | 589 | :not(li) > ol > li:first-child > :first-child, 590 | :not(li) > ul > li:first-child > :first-child { 591 | margin-top: 0px; 592 | } 593 | 594 | :not(li) > ol > li:last-child > :last-child, 595 | :not(li) > ul > li:last-child > :last-child { 596 | margin-bottom: 0px; 597 | } 598 | 599 | ol.simple ol p, 600 | ol.simple ul p, 601 | ul.simple ol p, 602 | ul.simple ul p { 603 | margin-top: 0; 604 | } 605 | 606 | ol.simple > li:not(:first-child) > p, 607 | ul.simple > li:not(:first-child) > p { 608 | margin-top: 0; 609 | } 610 | 611 | ol.simple p, 612 | ul.simple p { 613 | margin-bottom: 0; 614 | } 615 | 616 | aside.footnote > span, 617 | div.citation > span { 618 | float: left; 619 | } 620 | aside.footnote > span:last-of-type, 621 | div.citation > span:last-of-type { 622 | padding-right: 0.5em; 623 | } 624 | aside.footnote > p { 625 | margin-left: 2em; 626 | } 627 | div.citation > p { 628 | margin-left: 4em; 629 | } 630 | aside.footnote > p:last-of-type, 631 | div.citation > p:last-of-type { 632 | margin-bottom: 0em; 633 | } 634 | aside.footnote > p:last-of-type:after, 635 | div.citation > p:last-of-type:after { 636 | content: ""; 637 | clear: both; 638 | } 639 | 640 | dl.field-list { 641 | display: grid; 642 | grid-template-columns: fit-content(30%) auto; 643 | } 644 | 645 | dl.field-list > dt { 646 | font-weight: bold; 647 | word-break: break-word; 648 | padding-left: 0.5em; 649 | padding-right: 5px; 650 | } 651 | 652 | dl.field-list > dd { 653 | padding-left: 0.5em; 654 | margin-top: 0em; 655 | margin-left: 0em; 656 | margin-bottom: 0em; 657 | } 658 | 659 | dl { 660 | margin-bottom: 15px; 661 | } 662 | 663 | dd > :first-child { 664 | margin-top: 0px; 665 | } 666 | 667 | dd ul, dd table { 668 | margin-bottom: 10px; 669 | } 670 | 671 | dd { 672 | margin-top: 3px; 673 | margin-bottom: 10px; 674 | margin-left: 30px; 675 | } 676 | 677 | .sig dd { 678 | margin-top: 0px; 679 | margin-bottom: 0px; 680 | } 681 | 682 | .sig dl { 683 | margin-top: 0px; 684 | margin-bottom: 0px; 685 | } 686 | 687 | dl > dd:last-child, 688 | dl > dd:last-child > :last-child { 689 | margin-bottom: 0; 690 | } 691 | 692 | dt:target, span.highlighted { 693 | background-color: #fbe54e; 694 | } 695 | 696 | rect.highlighted { 697 | fill: #fbe54e; 698 | } 699 | 700 | dl.glossary dt { 701 | font-weight: bold; 702 | font-size: 1.1em; 703 | } 704 | 705 | .versionmodified { 706 | font-style: italic; 707 | } 708 | 709 | .system-message { 710 | background-color: #fda; 711 | padding: 5px; 712 | border: 3px solid red; 713 | } 714 | 715 | .footnote:target { 716 | background-color: #ffa; 717 | } 718 | 719 | .line-block { 720 | display: block; 721 | margin-top: 1em; 722 | margin-bottom: 1em; 723 | } 724 | 725 | .line-block .line-block { 726 | margin-top: 0; 727 | margin-bottom: 0; 728 | margin-left: 1.5em; 729 | } 730 | 731 | .guilabel, .menuselection { 732 | font-family: sans-serif; 733 | } 734 | 735 | .accelerator { 736 | text-decoration: underline; 737 | } 738 | 739 | .classifier { 740 | font-style: oblique; 741 | } 742 | 743 | .classifier:before { 744 | font-style: normal; 745 | margin: 0 0.5em; 746 | content: ":"; 747 | display: inline-block; 748 | } 749 | 750 | abbr, acronym { 751 | border-bottom: dotted 1px; 752 | cursor: help; 753 | } 754 | 755 | .translated { 756 | background-color: rgba(207, 255, 207, 0.2) 757 | } 758 | 759 | .untranslated { 760 | background-color: rgba(255, 207, 207, 0.2) 761 | } 762 | 763 | /* -- code displays --------------------------------------------------------- */ 764 | 765 | pre { 766 | overflow: auto; 767 | overflow-y: hidden; /* fixes display issues on Chrome browsers */ 768 | } 769 | 770 | pre, div[class*="highlight-"] { 771 | clear: both; 772 | } 773 | 774 | span.pre { 775 | -moz-hyphens: none; 776 | -ms-hyphens: none; 777 | -webkit-hyphens: none; 778 | hyphens: none; 779 | white-space: nowrap; 780 | } 781 | 782 | div[class*="highlight-"] { 783 | margin: 1em 0; 784 | } 785 | 786 | td.linenos pre { 787 | border: 0; 788 | background-color: transparent; 789 | color: #aaa; 790 | } 791 | 792 | table.highlighttable { 793 | display: block; 794 | } 795 | 796 | table.highlighttable tbody { 797 | display: block; 798 | } 799 | 800 | table.highlighttable tr { 801 | display: flex; 802 | } 803 | 804 | table.highlighttable td { 805 | margin: 0; 806 | padding: 0; 807 | } 808 | 809 | table.highlighttable td.linenos { 810 | padding-right: 0.5em; 811 | } 812 | 813 | table.highlighttable td.code { 814 | flex: 1; 815 | overflow: hidden; 816 | } 817 | 818 | .highlight .hll { 819 | display: block; 820 | } 821 | 822 | div.highlight pre, 823 | table.highlighttable pre { 824 | margin: 0; 825 | } 826 | 827 | div.code-block-caption + div { 828 | margin-top: 0; 829 | } 830 | 831 | div.code-block-caption { 832 | margin-top: 1em; 833 | padding: 2px 5px; 834 | font-size: small; 835 | } 836 | 837 | div.code-block-caption code { 838 | background-color: transparent; 839 | } 840 | 841 | table.highlighttable td.linenos, 842 | span.linenos, 843 | div.highlight span.gp { /* gp: Generic.Prompt */ 844 | user-select: none; 845 | -webkit-user-select: text; /* Safari fallback only */ 846 | -webkit-user-select: none; /* Chrome/Safari */ 847 | -moz-user-select: none; /* Firefox */ 848 | -ms-user-select: none; /* IE10+ */ 849 | } 850 | 851 | div.code-block-caption span.caption-number { 852 | padding: 0.1em 0.3em; 853 | font-style: italic; 854 | } 855 | 856 | div.code-block-caption span.caption-text { 857 | } 858 | 859 | div.literal-block-wrapper { 860 | margin: 1em 0; 861 | } 862 | 863 | code.xref, a code { 864 | background-color: transparent; 865 | font-weight: bold; 866 | } 867 | 868 | h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { 869 | background-color: transparent; 870 | } 871 | 872 | .viewcode-link { 873 | float: right; 874 | } 875 | 876 | .viewcode-back { 877 | float: right; 878 | font-family: sans-serif; 879 | } 880 | 881 | div.viewcode-block:target { 882 | margin: -1px -10px; 883 | padding: 0 10px; 884 | } 885 | 886 | /* -- math display ---------------------------------------------------------- */ 887 | 888 | img.math { 889 | vertical-align: middle; 890 | } 891 | 892 | div.body div.math p { 893 | text-align: center; 894 | } 895 | 896 | span.eqno { 897 | float: right; 898 | } 899 | 900 | span.eqno a.headerlink { 901 | position: absolute; 902 | z-index: 1; 903 | } 904 | 905 | div.math:hover a.headerlink { 906 | visibility: visible; 907 | } 908 | 909 | /* -- printout stylesheet --------------------------------------------------- */ 910 | 911 | @media print { 912 | div.document, 913 | div.documentwrapper, 914 | div.bodywrapper { 915 | margin: 0 !important; 916 | width: 100%; 917 | } 918 | 919 | div.sphinxsidebar, 920 | div.related, 921 | div.footer, 922 | #top-link { 923 | display: none; 924 | } 925 | } -------------------------------------------------------------------------------- /docs/build/html/_static/css/badge_only.css: -------------------------------------------------------------------------------- 1 | .clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/Roboto-Slab-Bold.woff2 -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/Roboto-Slab-Regular.woff2 -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/fontawesome-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/fontawesome-webfont.eot -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/fontawesome-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/fontawesome-webfont.ttf -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/fontawesome-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/fontawesome-webfont.woff -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/fontawesome-webfont.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/fontawesome-webfont.woff2 -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/lato-bold-italic.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/lato-bold-italic.woff -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/lato-bold-italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/lato-bold-italic.woff2 -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/lato-bold.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/lato-bold.woff -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/lato-bold.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/lato-bold.woff2 -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/lato-normal-italic.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/lato-normal-italic.woff -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/lato-normal-italic.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/lato-normal-italic.woff2 -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/lato-normal.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/lato-normal.woff -------------------------------------------------------------------------------- /docs/build/html/_static/css/fonts/lato-normal.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/css/fonts/lato-normal.woff2 -------------------------------------------------------------------------------- /docs/build/html/_static/doctools.js: -------------------------------------------------------------------------------- 1 | /* 2 | * doctools.js 3 | * ~~~~~~~~~~~ 4 | * 5 | * Base JavaScript utilities for all Sphinx HTML documentation. 6 | * 7 | * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | "use strict"; 12 | 13 | const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ 14 | "TEXTAREA", 15 | "INPUT", 16 | "SELECT", 17 | "BUTTON", 18 | ]); 19 | 20 | const _ready = (callback) => { 21 | if (document.readyState !== "loading") { 22 | callback(); 23 | } else { 24 | document.addEventListener("DOMContentLoaded", callback); 25 | } 26 | }; 27 | 28 | /** 29 | * Small JavaScript module for the documentation. 30 | */ 31 | const Documentation = { 32 | init: () => { 33 | Documentation.initDomainIndexTable(); 34 | Documentation.initOnKeyListeners(); 35 | }, 36 | 37 | /** 38 | * i18n support 39 | */ 40 | TRANSLATIONS: {}, 41 | PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), 42 | LOCALE: "unknown", 43 | 44 | // gettext and ngettext don't access this so that the functions 45 | // can safely bound to a different name (_ = Documentation.gettext) 46 | gettext: (string) => { 47 | const translated = Documentation.TRANSLATIONS[string]; 48 | switch (typeof translated) { 49 | case "undefined": 50 | return string; // no translation 51 | case "string": 52 | return translated; // translation exists 53 | default: 54 | return translated[0]; // (singular, plural) translation tuple exists 55 | } 56 | }, 57 | 58 | ngettext: (singular, plural, n) => { 59 | const translated = Documentation.TRANSLATIONS[singular]; 60 | if (typeof translated !== "undefined") 61 | return translated[Documentation.PLURAL_EXPR(n)]; 62 | return n === 1 ? singular : plural; 63 | }, 64 | 65 | addTranslations: (catalog) => { 66 | Object.assign(Documentation.TRANSLATIONS, catalog.messages); 67 | Documentation.PLURAL_EXPR = new Function( 68 | "n", 69 | `return (${catalog.plural_expr})` 70 | ); 71 | Documentation.LOCALE = catalog.locale; 72 | }, 73 | 74 | /** 75 | * helper function to focus on search bar 76 | */ 77 | focusSearchBar: () => { 78 | document.querySelectorAll("input[name=q]")[0]?.focus(); 79 | }, 80 | 81 | /** 82 | * Initialise the domain index toggle buttons 83 | */ 84 | initDomainIndexTable: () => { 85 | const toggler = (el) => { 86 | const idNumber = el.id.substr(7); 87 | const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); 88 | if (el.src.substr(-9) === "minus.png") { 89 | el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; 90 | toggledRows.forEach((el) => (el.style.display = "none")); 91 | } else { 92 | el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; 93 | toggledRows.forEach((el) => (el.style.display = "")); 94 | } 95 | }; 96 | 97 | const togglerElements = document.querySelectorAll("img.toggler"); 98 | togglerElements.forEach((el) => 99 | el.addEventListener("click", (event) => toggler(event.currentTarget)) 100 | ); 101 | togglerElements.forEach((el) => (el.style.display = "")); 102 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); 103 | }, 104 | 105 | initOnKeyListeners: () => { 106 | // only install a listener if it is really needed 107 | if ( 108 | !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && 109 | !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS 110 | ) 111 | return; 112 | 113 | document.addEventListener("keydown", (event) => { 114 | // bail for input elements 115 | if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; 116 | // bail with special keys 117 | if (event.altKey || event.ctrlKey || event.metaKey) return; 118 | 119 | if (!event.shiftKey) { 120 | switch (event.key) { 121 | case "ArrowLeft": 122 | if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; 123 | 124 | const prevLink = document.querySelector('link[rel="prev"]'); 125 | if (prevLink && prevLink.href) { 126 | window.location.href = prevLink.href; 127 | event.preventDefault(); 128 | } 129 | break; 130 | case "ArrowRight": 131 | if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; 132 | 133 | const nextLink = document.querySelector('link[rel="next"]'); 134 | if (nextLink && nextLink.href) { 135 | window.location.href = nextLink.href; 136 | event.preventDefault(); 137 | } 138 | break; 139 | } 140 | } 141 | 142 | // some keyboard layouts may need Shift to get / 143 | switch (event.key) { 144 | case "/": 145 | if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; 146 | Documentation.focusSearchBar(); 147 | event.preventDefault(); 148 | } 149 | }); 150 | }, 151 | }; 152 | 153 | // quick alias for translations 154 | const _ = Documentation.gettext; 155 | 156 | _ready(Documentation.init); 157 | -------------------------------------------------------------------------------- /docs/build/html/_static/documentation_options.js: -------------------------------------------------------------------------------- 1 | const DOCUMENTATION_OPTIONS = { 2 | VERSION: '1.0.5', 3 | LANGUAGE: 'en', 4 | COLLAPSE_INDEX: false, 5 | BUILDER: 'html', 6 | FILE_SUFFIX: '.html', 7 | LINK_SUFFIX: '.html', 8 | HAS_SOURCE: true, 9 | SOURCELINK_SUFFIX: '.txt', 10 | NAVIGATION_WITH_KEYS: false, 11 | SHOW_SEARCH_SUMMARY: true, 12 | ENABLE_SEARCH_SHORTCUTS: true, 13 | }; -------------------------------------------------------------------------------- /docs/build/html/_static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/file.png -------------------------------------------------------------------------------- /docs/build/html/_static/js/badge_only.js: -------------------------------------------------------------------------------- 1 | !function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=4)}({4:function(e,t,r){}}); -------------------------------------------------------------------------------- /docs/build/html/_static/js/html5shiv-printshiv.min.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @preserve HTML5 Shiv 3.7.3-pre | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed 3 | */ 4 | !function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=y.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=y.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),y.elements=c+" "+a,j(b)}function f(a){var b=x[a[v]];return b||(b={},w++,a[v]=w,x[w]=b),b}function g(a,c,d){if(c||(c=b),q)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():u.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||t.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),q)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return y.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(y,b.frag)}function j(a){a||(a=b);var d=f(a);return!y.shivCSS||p||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),q||i(a,d),a}function k(a){for(var b,c=a.getElementsByTagName("*"),e=c.length,f=RegExp("^(?:"+d().join("|")+")$","i"),g=[];e--;)b=c[e],f.test(b.nodeName)&&g.push(b.applyElement(l(b)));return g}function l(a){for(var b,c=a.attributes,d=c.length,e=a.ownerDocument.createElement(A+":"+a.nodeName);d--;)b=c[d],b.specified&&e.setAttribute(b.nodeName,b.nodeValue);return e.style.cssText=a.style.cssText,e}function m(a){for(var b,c=a.split("{"),e=c.length,f=RegExp("(^|[\\s,>+~])("+d().join("|")+")(?=[[\\s,>+~#.:]|$)","gi"),g="$1"+A+"\\:$2";e--;)b=c[e]=c[e].split("}"),b[b.length-1]=b[b.length-1].replace(f,g),c[e]=b.join("}");return c.join("{")}function n(a){for(var b=a.length;b--;)a[b].removeNode()}function o(a){function b(){clearTimeout(g._removeSheetTimer),d&&d.removeNode(!0),d=null}var d,e,g=f(a),h=a.namespaces,i=a.parentWindow;return!B||a.printShived?a:("undefined"==typeof h[A]&&h.add(A),i.attachEvent("onbeforeprint",function(){b();for(var f,g,h,i=a.styleSheets,j=[],l=i.length,n=Array(l);l--;)n[l]=i[l];for(;h=n.pop();)if(!h.disabled&&z.test(h.media)){try{f=h.imports,g=f.length}catch(o){g=0}for(l=0;g>l;l++)n.push(f[l]);try{j.push(h.cssText)}catch(o){}}j=m(j.reverse().join("")),e=k(a),d=c(a,j)}),i.attachEvent("onafterprint",function(){n(e),clearTimeout(g._removeSheetTimer),g._removeSheetTimer=setTimeout(b,500)}),a.printShived=!0,a)}var p,q,r="3.7.3",s=a.html5||{},t=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,u=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,v="_html5shiv",w=0,x={};!function(){try{var a=b.createElement("a");a.innerHTML="",p="hidden"in a,q=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){p=!0,q=!0}}();var y={elements:s.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:r,shivCSS:s.shivCSS!==!1,supportsUnknownElements:q,shivMethods:s.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=y,j(b);var z=/^$|\b(?:all|print)\b/,A="html5shiv",B=!q&&function(){var c=b.documentElement;return!("undefined"==typeof b.namespaces||"undefined"==typeof b.parentWindow||"undefined"==typeof c.applyElement||"undefined"==typeof c.removeNode||"undefined"==typeof a.attachEvent)}();y.type+=" print",y.shivPrint=o,o(b),"object"==typeof module&&module.exports&&(module.exports=y)}("undefined"!=typeof window?window:this,document); -------------------------------------------------------------------------------- /docs/build/html/_static/js/html5shiv.min.js: -------------------------------------------------------------------------------- 1 | /** 2 | * @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed 3 | */ 4 | !function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document); -------------------------------------------------------------------------------- /docs/build/html/_static/js/theme.js: -------------------------------------------------------------------------------- 1 | !function(n){var e={};function t(i){if(e[i])return e[i].exports;var o=e[i]={i:i,l:!1,exports:{}};return n[i].call(o.exports,o,o.exports,t),o.l=!0,o.exports}t.m=n,t.c=e,t.d=function(n,e,i){t.o(n,e)||Object.defineProperty(n,e,{enumerable:!0,get:i})},t.r=function(n){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},t.t=function(n,e){if(1&e&&(n=t(n)),8&e)return n;if(4&e&&"object"==typeof n&&n&&n.__esModule)return n;var i=Object.create(null);if(t.r(i),Object.defineProperty(i,"default",{enumerable:!0,value:n}),2&e&&"string"!=typeof n)for(var o in n)t.d(i,o,function(e){return n[e]}.bind(null,o));return i},t.n=function(n){var e=n&&n.__esModule?function(){return n.default}:function(){return n};return t.d(e,"a",e),e},t.o=function(n,e){return Object.prototype.hasOwnProperty.call(n,e)},t.p="",t(t.s=0)}([function(n,e,t){t(1),n.exports=t(3)},function(n,e,t){(function(){var e="undefined"!=typeof window?window.jQuery:t(2);n.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var t=this;void 0===n&&(n=!0),t.isRunning||(t.isRunning=!0,e((function(e){t.init(e),t.reset(),t.win.on("hashchange",t.reset),n&&t.win.on("scroll",(function(){t.linkScroll||t.winScroll||(t.winScroll=!0,requestAnimationFrame((function(){t.onScroll()})))})),t.win.on("resize",(function(){t.winResize||(t.winResize=!0,requestAnimationFrame((function(){t.onResize()})))})),t.onResize()})))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",(function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")})).on("click",".wy-menu-vertical .current ul li a",(function(){var t=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(t),e.hashChange()})).on("click","[data-toggle='rst-current-version']",(function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")})),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("
"),n("table.docutils.footnote").wrap("
"),n("table.docutils.citation").wrap("
"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function(){var t=n(this);expand=n(''),expand.on("click",(function(n){return e.toggleCurrent(t),n.stopPropagation(),!1})),t.prepend(expand)}))},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),t=e.find('[href="'+n+'"]');if(0===t.length){var i=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(t=e.find('[href="#'+i.attr("id")+'"]')).length&&(t=e.find('[href="#"]'))}if(t.length>0){$(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded","false"),t.addClass("current").attr("aria-expanded","true"),t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded","true");for(let n=1;n<=10;n++)t.closest("li.toctree-l"+n).addClass("current").attr("aria-expanded","true");t[0].scrollIntoView()}}catch(n){console.log("Error expanding nav for anchor",n)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,t=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(t),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",(function(){this.linkScroll=!1}))},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current").attr("aria-expanded","false"),e.siblings().find("li.current").removeClass("current").attr("aria-expanded","false");var t=e.find("> ul li");t.length&&(t.removeClass("current").attr("aria-expanded","false"),e.toggleClass("current").attr("aria-expanded",(function(n,e){return"true"==e?"false":"true"})))}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:n.exports.ThemeNav,StickyNav:n.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],t=0;t0 63 | var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 64 | var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 65 | var s_v = "^(" + C + ")?" + v; // vowel in stem 66 | 67 | this.stemWord = function (w) { 68 | var stem; 69 | var suffix; 70 | var firstch; 71 | var origword = w; 72 | 73 | if (w.length < 3) 74 | return w; 75 | 76 | var re; 77 | var re2; 78 | var re3; 79 | var re4; 80 | 81 | firstch = w.substr(0,1); 82 | if (firstch == "y") 83 | w = firstch.toUpperCase() + w.substr(1); 84 | 85 | // Step 1a 86 | re = /^(.+?)(ss|i)es$/; 87 | re2 = /^(.+?)([^s])s$/; 88 | 89 | if (re.test(w)) 90 | w = w.replace(re,"$1$2"); 91 | else if (re2.test(w)) 92 | w = w.replace(re2,"$1$2"); 93 | 94 | // Step 1b 95 | re = /^(.+?)eed$/; 96 | re2 = /^(.+?)(ed|ing)$/; 97 | if (re.test(w)) { 98 | var fp = re.exec(w); 99 | re = new RegExp(mgr0); 100 | if (re.test(fp[1])) { 101 | re = /.$/; 102 | w = w.replace(re,""); 103 | } 104 | } 105 | else if (re2.test(w)) { 106 | var fp = re2.exec(w); 107 | stem = fp[1]; 108 | re2 = new RegExp(s_v); 109 | if (re2.test(stem)) { 110 | w = stem; 111 | re2 = /(at|bl|iz)$/; 112 | re3 = new RegExp("([^aeiouylsz])\\1$"); 113 | re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); 114 | if (re2.test(w)) 115 | w = w + "e"; 116 | else if (re3.test(w)) { 117 | re = /.$/; 118 | w = w.replace(re,""); 119 | } 120 | else if (re4.test(w)) 121 | w = w + "e"; 122 | } 123 | } 124 | 125 | // Step 1c 126 | re = /^(.+?)y$/; 127 | if (re.test(w)) { 128 | var fp = re.exec(w); 129 | stem = fp[1]; 130 | re = new RegExp(s_v); 131 | if (re.test(stem)) 132 | w = stem + "i"; 133 | } 134 | 135 | // Step 2 136 | re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; 137 | if (re.test(w)) { 138 | var fp = re.exec(w); 139 | stem = fp[1]; 140 | suffix = fp[2]; 141 | re = new RegExp(mgr0); 142 | if (re.test(stem)) 143 | w = stem + step2list[suffix]; 144 | } 145 | 146 | // Step 3 147 | re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; 148 | if (re.test(w)) { 149 | var fp = re.exec(w); 150 | stem = fp[1]; 151 | suffix = fp[2]; 152 | re = new RegExp(mgr0); 153 | if (re.test(stem)) 154 | w = stem + step3list[suffix]; 155 | } 156 | 157 | // Step 4 158 | re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; 159 | re2 = /^(.+?)(s|t)(ion)$/; 160 | if (re.test(w)) { 161 | var fp = re.exec(w); 162 | stem = fp[1]; 163 | re = new RegExp(mgr1); 164 | if (re.test(stem)) 165 | w = stem; 166 | } 167 | else if (re2.test(w)) { 168 | var fp = re2.exec(w); 169 | stem = fp[1] + fp[2]; 170 | re2 = new RegExp(mgr1); 171 | if (re2.test(stem)) 172 | w = stem; 173 | } 174 | 175 | // Step 5 176 | re = /^(.+?)e$/; 177 | if (re.test(w)) { 178 | var fp = re.exec(w); 179 | stem = fp[1]; 180 | re = new RegExp(mgr1); 181 | re2 = new RegExp(meq1); 182 | re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); 183 | if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) 184 | w = stem; 185 | } 186 | re = /ll$/; 187 | re2 = new RegExp(mgr1); 188 | if (re.test(w) && re2.test(w)) { 189 | re = /.$/; 190 | w = w.replace(re,""); 191 | } 192 | 193 | // and turn initial Y back to y 194 | if (firstch == "y") 195 | w = firstch.toLowerCase() + w.substr(1); 196 | return w; 197 | } 198 | } 199 | 200 | -------------------------------------------------------------------------------- /docs/build/html/_static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/minus.png -------------------------------------------------------------------------------- /docs/build/html/_static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/_static/plus.png -------------------------------------------------------------------------------- /docs/build/html/_static/pygments.css: -------------------------------------------------------------------------------- 1 | pre { line-height: 125%; } 2 | td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 3 | span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } 4 | td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 5 | span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 6 | .highlight .hll { background-color: #ffffcc } 7 | .highlight { background: #eeffcc; } 8 | .highlight .c { color: #408090; font-style: italic } /* Comment */ 9 | .highlight .err { border: 1px solid #FF0000 } /* Error */ 10 | .highlight .k { color: #007020; font-weight: bold } /* Keyword */ 11 | .highlight .o { color: #666666 } /* Operator */ 12 | .highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */ 13 | .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ 14 | .highlight .cp { color: #007020 } /* Comment.Preproc */ 15 | .highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */ 16 | .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ 17 | .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ 18 | .highlight .gd { color: #A00000 } /* Generic.Deleted */ 19 | .highlight .ge { font-style: italic } /* Generic.Emph */ 20 | .highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ 21 | .highlight .gr { color: #FF0000 } /* Generic.Error */ 22 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ 23 | .highlight .gi { color: #00A000 } /* Generic.Inserted */ 24 | .highlight .go { color: #333333 } /* Generic.Output */ 25 | .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ 26 | .highlight .gs { font-weight: bold } /* Generic.Strong */ 27 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ 28 | .highlight .gt { color: #0044DD } /* Generic.Traceback */ 29 | .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ 30 | .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ 31 | .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ 32 | .highlight .kp { color: #007020 } /* Keyword.Pseudo */ 33 | .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ 34 | .highlight .kt { color: #902000 } /* Keyword.Type */ 35 | .highlight .m { color: #208050 } /* Literal.Number */ 36 | .highlight .s { color: #4070a0 } /* Literal.String */ 37 | .highlight .na { color: #4070a0 } /* Name.Attribute */ 38 | .highlight .nb { color: #007020 } /* Name.Builtin */ 39 | .highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ 40 | .highlight .no { color: #60add5 } /* Name.Constant */ 41 | .highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ 42 | .highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ 43 | .highlight .ne { color: #007020 } /* Name.Exception */ 44 | .highlight .nf { color: #06287e } /* Name.Function */ 45 | .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ 46 | .highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ 47 | .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ 48 | .highlight .nv { color: #bb60d5 } /* Name.Variable */ 49 | .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ 50 | .highlight .w { color: #bbbbbb } /* Text.Whitespace */ 51 | .highlight .mb { color: #208050 } /* Literal.Number.Bin */ 52 | .highlight .mf { color: #208050 } /* Literal.Number.Float */ 53 | .highlight .mh { color: #208050 } /* Literal.Number.Hex */ 54 | .highlight .mi { color: #208050 } /* Literal.Number.Integer */ 55 | .highlight .mo { color: #208050 } /* Literal.Number.Oct */ 56 | .highlight .sa { color: #4070a0 } /* Literal.String.Affix */ 57 | .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ 58 | .highlight .sc { color: #4070a0 } /* Literal.String.Char */ 59 | .highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */ 60 | .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ 61 | .highlight .s2 { color: #4070a0 } /* Literal.String.Double */ 62 | .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ 63 | .highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ 64 | .highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ 65 | .highlight .sx { color: #c65d09 } /* Literal.String.Other */ 66 | .highlight .sr { color: #235388 } /* Literal.String.Regex */ 67 | .highlight .s1 { color: #4070a0 } /* Literal.String.Single */ 68 | .highlight .ss { color: #517918 } /* Literal.String.Symbol */ 69 | .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ 70 | .highlight .fm { color: #06287e } /* Name.Function.Magic */ 71 | .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ 72 | .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ 73 | .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ 74 | .highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ 75 | .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ -------------------------------------------------------------------------------- /docs/build/html/_static/searchtools.js: -------------------------------------------------------------------------------- 1 | /* 2 | * searchtools.js 3 | * ~~~~~~~~~~~~~~~~ 4 | * 5 | * Sphinx JavaScript utilities for the full-text search. 6 | * 7 | * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | "use strict"; 12 | 13 | /** 14 | * Simple result scoring code. 15 | */ 16 | if (typeof Scorer === "undefined") { 17 | var Scorer = { 18 | // Implement the following function to further tweak the score for each result 19 | // The function takes a result array [docname, title, anchor, descr, score, filename] 20 | // and returns the new score. 21 | /* 22 | score: result => { 23 | const [docname, title, anchor, descr, score, filename] = result 24 | return score 25 | }, 26 | */ 27 | 28 | // query matches the full name of an object 29 | objNameMatch: 11, 30 | // or matches in the last dotted part of the object name 31 | objPartialMatch: 6, 32 | // Additive scores depending on the priority of the object 33 | objPrio: { 34 | 0: 15, // used to be importantResults 35 | 1: 5, // used to be objectResults 36 | 2: -5, // used to be unimportantResults 37 | }, 38 | // Used when the priority is not in the mapping. 39 | objPrioDefault: 0, 40 | 41 | // query found in title 42 | title: 15, 43 | partialTitle: 7, 44 | // query found in terms 45 | term: 5, 46 | partialTerm: 2, 47 | }; 48 | } 49 | 50 | const _removeChildren = (element) => { 51 | while (element && element.lastChild) element.removeChild(element.lastChild); 52 | }; 53 | 54 | /** 55 | * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping 56 | */ 57 | const _escapeRegExp = (string) => 58 | string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string 59 | 60 | const _displayItem = (item, searchTerms, highlightTerms) => { 61 | const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; 62 | const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; 63 | const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; 64 | const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; 65 | const contentRoot = document.documentElement.dataset.content_root; 66 | 67 | const [docName, title, anchor, descr, score, _filename] = item; 68 | 69 | let listItem = document.createElement("li"); 70 | let requestUrl; 71 | let linkUrl; 72 | if (docBuilder === "dirhtml") { 73 | // dirhtml builder 74 | let dirname = docName + "/"; 75 | if (dirname.match(/\/index\/$/)) 76 | dirname = dirname.substring(0, dirname.length - 6); 77 | else if (dirname === "index/") dirname = ""; 78 | requestUrl = contentRoot + dirname; 79 | linkUrl = requestUrl; 80 | } else { 81 | // normal html builders 82 | requestUrl = contentRoot + docName + docFileSuffix; 83 | linkUrl = docName + docLinkSuffix; 84 | } 85 | let linkEl = listItem.appendChild(document.createElement("a")); 86 | linkEl.href = linkUrl + anchor; 87 | linkEl.dataset.score = score; 88 | linkEl.innerHTML = title; 89 | if (descr) { 90 | listItem.appendChild(document.createElement("span")).innerHTML = 91 | " (" + descr + ")"; 92 | // highlight search terms in the description 93 | if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js 94 | highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); 95 | } 96 | else if (showSearchSummary) 97 | fetch(requestUrl) 98 | .then((responseData) => responseData.text()) 99 | .then((data) => { 100 | if (data) 101 | listItem.appendChild( 102 | Search.makeSearchSummary(data, searchTerms) 103 | ); 104 | // highlight search terms in the summary 105 | if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js 106 | highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); 107 | }); 108 | Search.output.appendChild(listItem); 109 | }; 110 | const _finishSearch = (resultCount) => { 111 | Search.stopPulse(); 112 | Search.title.innerText = _("Search Results"); 113 | if (!resultCount) 114 | Search.status.innerText = Documentation.gettext( 115 | "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." 116 | ); 117 | else 118 | Search.status.innerText = _( 119 | `Search finished, found ${resultCount} page(s) matching the search query.` 120 | ); 121 | }; 122 | const _displayNextItem = ( 123 | results, 124 | resultCount, 125 | searchTerms, 126 | highlightTerms, 127 | ) => { 128 | // results left, load the summary and display it 129 | // this is intended to be dynamic (don't sub resultsCount) 130 | if (results.length) { 131 | _displayItem(results.pop(), searchTerms, highlightTerms); 132 | setTimeout( 133 | () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), 134 | 5 135 | ); 136 | } 137 | // search finished, update title and status message 138 | else _finishSearch(resultCount); 139 | }; 140 | 141 | /** 142 | * Default splitQuery function. Can be overridden in ``sphinx.search`` with a 143 | * custom function per language. 144 | * 145 | * The regular expression works by splitting the string on consecutive characters 146 | * that are not Unicode letters, numbers, underscores, or emoji characters. 147 | * This is the same as ``\W+`` in Python, preserving the surrogate pair area. 148 | */ 149 | if (typeof splitQuery === "undefined") { 150 | var splitQuery = (query) => query 151 | .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) 152 | .filter(term => term) // remove remaining empty strings 153 | } 154 | 155 | /** 156 | * Search Module 157 | */ 158 | const Search = { 159 | _index: null, 160 | _queued_query: null, 161 | _pulse_status: -1, 162 | 163 | htmlToText: (htmlString) => { 164 | const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); 165 | htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); 166 | const docContent = htmlElement.querySelector('[role="main"]'); 167 | if (docContent !== undefined) return docContent.textContent; 168 | console.warn( 169 | "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." 170 | ); 171 | return ""; 172 | }, 173 | 174 | init: () => { 175 | const query = new URLSearchParams(window.location.search).get("q"); 176 | document 177 | .querySelectorAll('input[name="q"]') 178 | .forEach((el) => (el.value = query)); 179 | if (query) Search.performSearch(query); 180 | }, 181 | 182 | loadIndex: (url) => 183 | (document.body.appendChild(document.createElement("script")).src = url), 184 | 185 | setIndex: (index) => { 186 | Search._index = index; 187 | if (Search._queued_query !== null) { 188 | const query = Search._queued_query; 189 | Search._queued_query = null; 190 | Search.query(query); 191 | } 192 | }, 193 | 194 | hasIndex: () => Search._index !== null, 195 | 196 | deferQuery: (query) => (Search._queued_query = query), 197 | 198 | stopPulse: () => (Search._pulse_status = -1), 199 | 200 | startPulse: () => { 201 | if (Search._pulse_status >= 0) return; 202 | 203 | const pulse = () => { 204 | Search._pulse_status = (Search._pulse_status + 1) % 4; 205 | Search.dots.innerText = ".".repeat(Search._pulse_status); 206 | if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); 207 | }; 208 | pulse(); 209 | }, 210 | 211 | /** 212 | * perform a search for something (or wait until index is loaded) 213 | */ 214 | performSearch: (query) => { 215 | // create the required interface elements 216 | const searchText = document.createElement("h2"); 217 | searchText.textContent = _("Searching"); 218 | const searchSummary = document.createElement("p"); 219 | searchSummary.classList.add("search-summary"); 220 | searchSummary.innerText = ""; 221 | const searchList = document.createElement("ul"); 222 | searchList.classList.add("search"); 223 | 224 | const out = document.getElementById("search-results"); 225 | Search.title = out.appendChild(searchText); 226 | Search.dots = Search.title.appendChild(document.createElement("span")); 227 | Search.status = out.appendChild(searchSummary); 228 | Search.output = out.appendChild(searchList); 229 | 230 | const searchProgress = document.getElementById("search-progress"); 231 | // Some themes don't use the search progress node 232 | if (searchProgress) { 233 | searchProgress.innerText = _("Preparing search..."); 234 | } 235 | Search.startPulse(); 236 | 237 | // index already loaded, the browser was quick! 238 | if (Search.hasIndex()) Search.query(query); 239 | else Search.deferQuery(query); 240 | }, 241 | 242 | /** 243 | * execute search (requires search index to be loaded) 244 | */ 245 | query: (query) => { 246 | const filenames = Search._index.filenames; 247 | const docNames = Search._index.docnames; 248 | const titles = Search._index.titles; 249 | const allTitles = Search._index.alltitles; 250 | const indexEntries = Search._index.indexentries; 251 | 252 | // stem the search terms and add them to the correct list 253 | const stemmer = new Stemmer(); 254 | const searchTerms = new Set(); 255 | const excludedTerms = new Set(); 256 | const highlightTerms = new Set(); 257 | const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); 258 | splitQuery(query.trim()).forEach((queryTerm) => { 259 | const queryTermLower = queryTerm.toLowerCase(); 260 | 261 | // maybe skip this "word" 262 | // stopwords array is from language_data.js 263 | if ( 264 | stopwords.indexOf(queryTermLower) !== -1 || 265 | queryTerm.match(/^\d+$/) 266 | ) 267 | return; 268 | 269 | // stem the word 270 | let word = stemmer.stemWord(queryTermLower); 271 | // select the correct list 272 | if (word[0] === "-") excludedTerms.add(word.substr(1)); 273 | else { 274 | searchTerms.add(word); 275 | highlightTerms.add(queryTermLower); 276 | } 277 | }); 278 | 279 | if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js 280 | localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) 281 | } 282 | 283 | // console.debug("SEARCH: searching for:"); 284 | // console.info("required: ", [...searchTerms]); 285 | // console.info("excluded: ", [...excludedTerms]); 286 | 287 | // array of [docname, title, anchor, descr, score, filename] 288 | let results = []; 289 | _removeChildren(document.getElementById("search-progress")); 290 | 291 | const queryLower = query.toLowerCase(); 292 | for (const [title, foundTitles] of Object.entries(allTitles)) { 293 | if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { 294 | for (const [file, id] of foundTitles) { 295 | let score = Math.round(100 * queryLower.length / title.length) 296 | results.push([ 297 | docNames[file], 298 | titles[file] !== title ? `${titles[file]} > ${title}` : title, 299 | id !== null ? "#" + id : "", 300 | null, 301 | score, 302 | filenames[file], 303 | ]); 304 | } 305 | } 306 | } 307 | 308 | // search for explicit entries in index directives 309 | for (const [entry, foundEntries] of Object.entries(indexEntries)) { 310 | if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { 311 | for (const [file, id] of foundEntries) { 312 | let score = Math.round(100 * queryLower.length / entry.length) 313 | results.push([ 314 | docNames[file], 315 | titles[file], 316 | id ? "#" + id : "", 317 | null, 318 | score, 319 | filenames[file], 320 | ]); 321 | } 322 | } 323 | } 324 | 325 | // lookup as object 326 | objectTerms.forEach((term) => 327 | results.push(...Search.performObjectSearch(term, objectTerms)) 328 | ); 329 | 330 | // lookup as search terms in fulltext 331 | results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); 332 | 333 | // let the scorer override scores with a custom scoring function 334 | if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); 335 | 336 | // now sort the results by score (in opposite order of appearance, since the 337 | // display function below uses pop() to retrieve items) and then 338 | // alphabetically 339 | results.sort((a, b) => { 340 | const leftScore = a[4]; 341 | const rightScore = b[4]; 342 | if (leftScore === rightScore) { 343 | // same score: sort alphabetically 344 | const leftTitle = a[1].toLowerCase(); 345 | const rightTitle = b[1].toLowerCase(); 346 | if (leftTitle === rightTitle) return 0; 347 | return leftTitle > rightTitle ? -1 : 1; // inverted is intentional 348 | } 349 | return leftScore > rightScore ? 1 : -1; 350 | }); 351 | 352 | // remove duplicate search results 353 | // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept 354 | let seen = new Set(); 355 | results = results.reverse().reduce((acc, result) => { 356 | let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); 357 | if (!seen.has(resultStr)) { 358 | acc.push(result); 359 | seen.add(resultStr); 360 | } 361 | return acc; 362 | }, []); 363 | 364 | results = results.reverse(); 365 | 366 | // for debugging 367 | //Search.lastresults = results.slice(); // a copy 368 | // console.info("search results:", Search.lastresults); 369 | 370 | // print the results 371 | _displayNextItem(results, results.length, searchTerms, highlightTerms); 372 | }, 373 | 374 | /** 375 | * search for object names 376 | */ 377 | performObjectSearch: (object, objectTerms) => { 378 | const filenames = Search._index.filenames; 379 | const docNames = Search._index.docnames; 380 | const objects = Search._index.objects; 381 | const objNames = Search._index.objnames; 382 | const titles = Search._index.titles; 383 | 384 | const results = []; 385 | 386 | const objectSearchCallback = (prefix, match) => { 387 | const name = match[4] 388 | const fullname = (prefix ? prefix + "." : "") + name; 389 | const fullnameLower = fullname.toLowerCase(); 390 | if (fullnameLower.indexOf(object) < 0) return; 391 | 392 | let score = 0; 393 | const parts = fullnameLower.split("."); 394 | 395 | // check for different match types: exact matches of full name or 396 | // "last name" (i.e. last dotted part) 397 | if (fullnameLower === object || parts.slice(-1)[0] === object) 398 | score += Scorer.objNameMatch; 399 | else if (parts.slice(-1)[0].indexOf(object) > -1) 400 | score += Scorer.objPartialMatch; // matches in last name 401 | 402 | const objName = objNames[match[1]][2]; 403 | const title = titles[match[0]]; 404 | 405 | // If more than one term searched for, we require other words to be 406 | // found in the name/title/description 407 | const otherTerms = new Set(objectTerms); 408 | otherTerms.delete(object); 409 | if (otherTerms.size > 0) { 410 | const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); 411 | if ( 412 | [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) 413 | ) 414 | return; 415 | } 416 | 417 | let anchor = match[3]; 418 | if (anchor === "") anchor = fullname; 419 | else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; 420 | 421 | const descr = objName + _(", in ") + title; 422 | 423 | // add custom score for some objects according to scorer 424 | if (Scorer.objPrio.hasOwnProperty(match[2])) 425 | score += Scorer.objPrio[match[2]]; 426 | else score += Scorer.objPrioDefault; 427 | 428 | results.push([ 429 | docNames[match[0]], 430 | fullname, 431 | "#" + anchor, 432 | descr, 433 | score, 434 | filenames[match[0]], 435 | ]); 436 | }; 437 | Object.keys(objects).forEach((prefix) => 438 | objects[prefix].forEach((array) => 439 | objectSearchCallback(prefix, array) 440 | ) 441 | ); 442 | return results; 443 | }, 444 | 445 | /** 446 | * search for full-text terms in the index 447 | */ 448 | performTermsSearch: (searchTerms, excludedTerms) => { 449 | // prepare search 450 | const terms = Search._index.terms; 451 | const titleTerms = Search._index.titleterms; 452 | const filenames = Search._index.filenames; 453 | const docNames = Search._index.docnames; 454 | const titles = Search._index.titles; 455 | 456 | const scoreMap = new Map(); 457 | const fileMap = new Map(); 458 | 459 | // perform the search on the required terms 460 | searchTerms.forEach((word) => { 461 | const files = []; 462 | const arr = [ 463 | { files: terms[word], score: Scorer.term }, 464 | { files: titleTerms[word], score: Scorer.title }, 465 | ]; 466 | // add support for partial matches 467 | if (word.length > 2) { 468 | const escapedWord = _escapeRegExp(word); 469 | Object.keys(terms).forEach((term) => { 470 | if (term.match(escapedWord) && !terms[word]) 471 | arr.push({ files: terms[term], score: Scorer.partialTerm }); 472 | }); 473 | Object.keys(titleTerms).forEach((term) => { 474 | if (term.match(escapedWord) && !titleTerms[word]) 475 | arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); 476 | }); 477 | } 478 | 479 | // no match but word was a required one 480 | if (arr.every((record) => record.files === undefined)) return; 481 | 482 | // found search word in contents 483 | arr.forEach((record) => { 484 | if (record.files === undefined) return; 485 | 486 | let recordFiles = record.files; 487 | if (recordFiles.length === undefined) recordFiles = [recordFiles]; 488 | files.push(...recordFiles); 489 | 490 | // set score for the word in each file 491 | recordFiles.forEach((file) => { 492 | if (!scoreMap.has(file)) scoreMap.set(file, {}); 493 | scoreMap.get(file)[word] = record.score; 494 | }); 495 | }); 496 | 497 | // create the mapping 498 | files.forEach((file) => { 499 | if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) 500 | fileMap.get(file).push(word); 501 | else fileMap.set(file, [word]); 502 | }); 503 | }); 504 | 505 | // now check if the files don't contain excluded terms 506 | const results = []; 507 | for (const [file, wordList] of fileMap) { 508 | // check if all requirements are matched 509 | 510 | // as search terms with length < 3 are discarded 511 | const filteredTermCount = [...searchTerms].filter( 512 | (term) => term.length > 2 513 | ).length; 514 | if ( 515 | wordList.length !== searchTerms.size && 516 | wordList.length !== filteredTermCount 517 | ) 518 | continue; 519 | 520 | // ensure that none of the excluded terms is in the search result 521 | if ( 522 | [...excludedTerms].some( 523 | (term) => 524 | terms[term] === file || 525 | titleTerms[term] === file || 526 | (terms[term] || []).includes(file) || 527 | (titleTerms[term] || []).includes(file) 528 | ) 529 | ) 530 | break; 531 | 532 | // select one (max) score for the file. 533 | const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); 534 | // add result to the result list 535 | results.push([ 536 | docNames[file], 537 | titles[file], 538 | "", 539 | null, 540 | score, 541 | filenames[file], 542 | ]); 543 | } 544 | return results; 545 | }, 546 | 547 | /** 548 | * helper function to return a node containing the 549 | * search summary for a given text. keywords is a list 550 | * of stemmed words. 551 | */ 552 | makeSearchSummary: (htmlText, keywords) => { 553 | const text = Search.htmlToText(htmlText); 554 | if (text === "") return null; 555 | 556 | const textLower = text.toLowerCase(); 557 | const actualStartPosition = [...keywords] 558 | .map((k) => textLower.indexOf(k.toLowerCase())) 559 | .filter((i) => i > -1) 560 | .slice(-1)[0]; 561 | const startWithContext = Math.max(actualStartPosition - 120, 0); 562 | 563 | const top = startWithContext === 0 ? "" : "..."; 564 | const tail = startWithContext + 240 < text.length ? "..." : ""; 565 | 566 | let summary = document.createElement("p"); 567 | summary.classList.add("context"); 568 | summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; 569 | 570 | return summary; 571 | }, 572 | }; 573 | 574 | _ready(Search.init); 575 | -------------------------------------------------------------------------------- /docs/build/html/_static/sphinx_highlight.js: -------------------------------------------------------------------------------- 1 | /* Highlighting utilities for Sphinx HTML documentation. */ 2 | "use strict"; 3 | 4 | const SPHINX_HIGHLIGHT_ENABLED = true 5 | 6 | /** 7 | * highlight a given string on a node by wrapping it in 8 | * span elements with the given class name. 9 | */ 10 | const _highlight = (node, addItems, text, className) => { 11 | if (node.nodeType === Node.TEXT_NODE) { 12 | const val = node.nodeValue; 13 | const parent = node.parentNode; 14 | const pos = val.toLowerCase().indexOf(text); 15 | if ( 16 | pos >= 0 && 17 | !parent.classList.contains(className) && 18 | !parent.classList.contains("nohighlight") 19 | ) { 20 | let span; 21 | 22 | const closestNode = parent.closest("body, svg, foreignObject"); 23 | const isInSVG = closestNode && closestNode.matches("svg"); 24 | if (isInSVG) { 25 | span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); 26 | } else { 27 | span = document.createElement("span"); 28 | span.classList.add(className); 29 | } 30 | 31 | span.appendChild(document.createTextNode(val.substr(pos, text.length))); 32 | const rest = document.createTextNode(val.substr(pos + text.length)); 33 | parent.insertBefore( 34 | span, 35 | parent.insertBefore( 36 | rest, 37 | node.nextSibling 38 | ) 39 | ); 40 | node.nodeValue = val.substr(0, pos); 41 | /* There may be more occurrences of search term in this node. So call this 42 | * function recursively on the remaining fragment. 43 | */ 44 | _highlight(rest, addItems, text, className); 45 | 46 | if (isInSVG) { 47 | const rect = document.createElementNS( 48 | "http://www.w3.org/2000/svg", 49 | "rect" 50 | ); 51 | const bbox = parent.getBBox(); 52 | rect.x.baseVal.value = bbox.x; 53 | rect.y.baseVal.value = bbox.y; 54 | rect.width.baseVal.value = bbox.width; 55 | rect.height.baseVal.value = bbox.height; 56 | rect.setAttribute("class", className); 57 | addItems.push({ parent: parent, target: rect }); 58 | } 59 | } 60 | } else if (node.matches && !node.matches("button, select, textarea")) { 61 | node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); 62 | } 63 | }; 64 | const _highlightText = (thisNode, text, className) => { 65 | let addItems = []; 66 | _highlight(thisNode, addItems, text, className); 67 | addItems.forEach((obj) => 68 | obj.parent.insertAdjacentElement("beforebegin", obj.target) 69 | ); 70 | }; 71 | 72 | /** 73 | * Small JavaScript module for the documentation. 74 | */ 75 | const SphinxHighlight = { 76 | 77 | /** 78 | * highlight the search words provided in localstorage in the text 79 | */ 80 | highlightSearchWords: () => { 81 | if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight 82 | 83 | // get and clear terms from localstorage 84 | const url = new URL(window.location); 85 | const highlight = 86 | localStorage.getItem("sphinx_highlight_terms") 87 | || url.searchParams.get("highlight") 88 | || ""; 89 | localStorage.removeItem("sphinx_highlight_terms") 90 | url.searchParams.delete("highlight"); 91 | window.history.replaceState({}, "", url); 92 | 93 | // get individual terms from highlight string 94 | const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); 95 | if (terms.length === 0) return; // nothing to do 96 | 97 | // There should never be more than one element matching "div.body" 98 | const divBody = document.querySelectorAll("div.body"); 99 | const body = divBody.length ? divBody[0] : document.querySelector("body"); 100 | window.setTimeout(() => { 101 | terms.forEach((term) => _highlightText(body, term, "highlighted")); 102 | }, 10); 103 | 104 | const searchBox = document.getElementById("searchbox"); 105 | if (searchBox === null) return; 106 | searchBox.appendChild( 107 | document 108 | .createRange() 109 | .createContextualFragment( 110 | '

' + 111 | '' + 112 | _("Hide Search Matches") + 113 | "

" 114 | ) 115 | ); 116 | }, 117 | 118 | /** 119 | * helper function to hide the search marks again 120 | */ 121 | hideSearchWords: () => { 122 | document 123 | .querySelectorAll("#searchbox .highlight-link") 124 | .forEach((el) => el.remove()); 125 | document 126 | .querySelectorAll("span.highlighted") 127 | .forEach((el) => el.classList.remove("highlighted")); 128 | localStorage.removeItem("sphinx_highlight_terms") 129 | }, 130 | 131 | initEscapeListener: () => { 132 | // only install a listener if it is really needed 133 | if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; 134 | 135 | document.addEventListener("keydown", (event) => { 136 | // bail for input elements 137 | if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; 138 | // bail with special keys 139 | if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; 140 | if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { 141 | SphinxHighlight.hideSearchWords(); 142 | event.preventDefault(); 143 | } 144 | }); 145 | }, 146 | }; 147 | 148 | _ready(() => { 149 | /* Do not call highlightSearchWords() when we are on the search page. 150 | * It will highlight words from the *previous* search query. 151 | */ 152 | if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); 153 | SphinxHighlight.initEscapeListener(); 154 | }); 155 | -------------------------------------------------------------------------------- /docs/build/html/genindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Index — pyrobloxbot 1.0.5 documentation 7 | 8 | 9 | 10 | 11 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 |
27 | 49 | 50 |
54 | 55 |
56 |
57 |
58 |
    59 |
    • 60 |
  • Index
    • 61 |
  • 62 |
    • 63 |
64 |
65 |
66 |
67 |
68 | 69 | 70 |

Index

71 | 72 |
73 | C 74 | | E 75 | | H 76 | | I 77 | | J 78 | | K 79 | | L 80 | | M 81 | | N 82 | | P 83 | | R 84 | | S 85 | | T 86 | | U 87 | | V 88 | | W 89 | 90 |
91 |

C

92 | 93 | 97 |
98 | 99 |

E

100 | 101 | 105 |
106 | 107 |

H

108 | 109 | 113 |
114 | 115 |

I

116 | 117 | 121 | 127 |
128 | 129 |

J

130 | 131 | 135 | 139 |
140 | 141 |

K

142 | 143 | 147 | 151 |
152 | 153 |

L

154 | 155 | 159 |
160 | 161 |

M

162 | 163 | 176 |
177 | 178 |

N

179 | 180 | 184 |
185 | 186 |

P

187 | 188 | 204 | 213 |
    189 |
  • 190 | pyrobloxbot 191 | 192 |
    • 196 |
  • 197 | pyrobloxbot.exceptions 198 | 199 |
    • 203 |
    205 |
  • 206 | pyrobloxbot.literals 207 | 208 |
    • 212 |
214 | 215 |

R

216 | 217 | 221 | 225 |
226 | 227 |

S

228 | 229 | 233 |
234 | 235 |

T

236 | 237 | 241 | 245 |
246 | 247 |

U

248 | 249 | 257 | 267 |
268 | 269 |

V

270 | 271 | 281 |
282 | 283 |

W

284 | 285 | 293 | 301 |
302 | 303 | 304 | 305 |
306 |
307 |
308 | 309 |
310 | 311 |
312 |

© Copyright 2024, Mews.

313 |
314 | 315 | Built with Sphinx using a 316 | theme 317 | provided by Read the Docs. 318 | 319 | 320 |
321 |
322 |
323 |
324 |
325 | 330 | 331 | 332 | -------------------------------------------------------------------------------- /docs/build/html/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Welcome to pyrobloxbot’s documentation! — pyrobloxbot 1.0.5 documentation 8 | 9 | 10 | 11 | 12 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 |
28 | 54 | 55 |
59 | 60 |
61 |
62 |
63 |
    64 |
    • 65 |
  • Welcome to pyrobloxbot’s documentation!
    • 66 |
  • 67 | View page source 68 |
    • 69 |
70 |
71 |
72 |
73 |
74 | 75 |
76 |

Welcome to pyrobloxbot’s documentation!

77 |
78 |
79 |
80 |
81 |

Indices and tables

82 | 87 |
88 | 89 | 90 |
91 |
92 |
93 | 94 |
95 | 96 |
97 |

© Copyright 2024, Mews.

98 |
99 | 100 | Built with Sphinx using a 101 | theme 102 | provided by Read the Docs. 103 | 104 | 105 |
106 |
107 |
108 |
109 |
110 | 115 | 116 | 117 | -------------------------------------------------------------------------------- /docs/build/html/modules.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | pyrobloxbot — pyrobloxbot 1.0.5 documentation 8 | 9 | 10 | 11 | 12 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 |
28 | 53 | 54 |
58 | 59 |
60 |
61 |
62 | 69 |
70 |
71 |
72 |
73 | 74 |
75 |

pyrobloxbot

76 |
77 | 131 |
132 |
133 | 134 | 135 |
136 |
137 |
138 | 139 |
140 | 141 |
142 |

© Copyright 2024, Mews.

143 |
144 | 145 | Built with Sphinx using a 146 | theme 147 | provided by Read the Docs. 148 | 149 | 150 |
151 |
152 |
153 |
154 |
155 | 160 | 161 | 162 | -------------------------------------------------------------------------------- /docs/build/html/objects.inv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/docs/build/html/objects.inv -------------------------------------------------------------------------------- /docs/build/html/py-modindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Python Module Index — pyrobloxbot 1.0.5 documentation 7 | 8 | 9 | 10 | 11 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 |
30 | 52 | 53 |
57 | 58 |
59 |
60 |
61 |
    62 |
    • 63 |
  • Python Module Index
    • 64 |
  • 65 |
    • 66 |
67 |
68 |
69 |
70 |
71 | 72 | 73 |

Python Module Index

74 | 75 |
76 | p 77 |
78 | 79 | 80 | 81 | 83 | 84 | 86 | 89 | 90 | 91 | 94 | 95 | 96 | 99 |
 
82 | p
87 | pyrobloxbot 88 |
    92 | pyrobloxbot.exceptions 93 |
    97 | pyrobloxbot.literals 98 |
100 | 101 | 102 |
103 |
104 |
105 | 106 |
107 | 108 |
109 |

© Copyright 2024, Mews.

110 |
111 | 112 | Built with Sphinx using a 113 | theme 114 | provided by Read the Docs. 115 | 116 | 117 |
118 |
119 |
120 |
121 |
122 | 127 | 128 | 129 | -------------------------------------------------------------------------------- /docs/build/html/search.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Search — pyrobloxbot 1.0.5 documentation 7 | 8 | 9 | 10 | 11 | 12 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 |
30 | 52 | 53 |
57 | 58 |
59 |
60 |
61 |
    62 |
    • 63 |
  • Search
    • 64 |
  • 65 |
    • 66 |
67 |
68 |
69 |
70 |
71 | 72 | 79 | 80 | 81 |
82 | 83 |
84 | 85 |
86 |
87 |
88 | 89 |
90 | 91 |
92 |

© Copyright 2024, Mews.

93 |
94 | 95 | Built with Sphinx using a 96 | theme 97 | provided by Read the Docs. 98 | 99 | 100 |
101 |
102 |
103 |
104 |
105 | 110 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | -------------------------------------------------------------------------------- /docs/build/html/searchindex.js: -------------------------------------------------------------------------------- 1 | Search.setIndex({"docnames": ["index", "modules", "pyrobloxbot"], "filenames": ["index.rst", "modules.rst", "pyrobloxbot.rst"], "titles": ["Welcome to pyrobloxbot\u2019s documentation!", "pyrobloxbot", "pyrobloxbot package"], "terms": {"index": 0, "modul": [0, 1], "search": 0, "page": 0, "packag": 1, "submodul": 1, "except": 1, "invalidslotnumberexcept": [1, 2], "invaliduidirectionexcept": [1, 2], "invalidwalkdirectionexcept": [1, 2], "norobloxwindowexcept": [1, 2], "liter": 1, "keyboard_kei": [1, 2], "valu": [1, 2], "ui_navigate_direct": [1, 2], "walk_direct": [1, 2], "content": 1, "chat": [1, 2], "equip_slot": [1, 2], "hold_keyboard_act": [1, 2], "jump": [1, 2], "jump_continu": [1, 2], "keyboard_act": [1, 2], "leave_gam": [1, 2], "require_focu": [1, 2], "reset_play": [1, 2], "set_failsafe_hotkei": [1, 2], "toggle_shift_lock": [1, 2], "toggle_ui_navig": [1, 2], "ui_click": [1, 2], "ui_navig": [1, 2], "ui_navigate_down": [1, 2], "ui_navigate_left": [1, 2], "ui_navigate_right": [1, 2], "ui_navigate_up": [1, 2], "walk": [1, 2], "walk_back": [1, 2], "walk_forward": [1, 2], "walk_left": [1, 2], "walk_right": [1, 2], "base": 2, "rais": 2, "when": 2, "slot": 2, "isn": 2, "t": 2, "between": 2, "0": 2, "9": 2, "given": 2, "direct": 2, "function": 2, "can": 2, "find": 2, "roblox": 2, "window": 2, "focu": 2, "class": 2, "object": 2, "valid": 2, "string": 2, "pass": 2, "alia": 2, "n": 2, "r": 2, "1": 2, "2": 2, "3": 2, "4": 2, "5": 2, "6": 2, "7": 2, "8": 2, "_": 2, "b": 2, "c": 2, "d": 2, "e": 2, "f": 2, "g": 2, "h": 2, "i": 2, "j": 2, "k": 2, "l": 2, "m": 2, "o": 2, "p": 2, "q": 2, "": 2, "u": 2, "v": 2, "w": 2, "x": 2, "y": 2, "z": 2, "accept": 2, "add": 2, "alt": 2, "altleft": 2, "altright": 2, "app": 2, "backspac": 2, "browserback": 2, "browserfavorit": 2, "browserforward": 2, "browserhom": 2, "browserrefresh": 2, "browsersearch": 2, "browserstop": 2, "capslock": 2, "clear": 2, "convert": 2, "ctrl": 2, "ctrlleft": 2, "ctrlright": 2, "decim": 2, "del": 2, "delet": 2, "divid": 2, "down": 2, "end": 2, "enter": 2, "esc": 2, "escap": 2, "execut": 2, "f1": 2, "f10": 2, "f11": 2, "f12": 2, "f13": 2, "f14": 2, "f15": 2, "f16": 2, "f17": 2, "f18": 2, "f19": 2, "f2": 2, "f20": 2, "f21": 2, "f22": 2, "f23": 2, "f24": 2, "f3": 2, "f4": 2, "f5": 2, "f6": 2, "f7": 2, "f8": 2, "f9": 2, "final": 2, "fn": 2, "hanguel": 2, "hangul": 2, "hanja": 2, "help": 2, "home": 2, "insert": 2, "junja": 2, "kana": 2, "kanji": 2, "launchapp1": 2, "launchapp2": 2, "launchmail": 2, "launchmediaselect": 2, "left": 2, "modechang": 2, "multipli": 2, "nexttrack": 2, "nonconvert": 2, "num0": 2, "num1": 2, "num2": 2, "num3": 2, "num4": 2, "num5": 2, "num6": 2, "num7": 2, "num8": 2, "num9": 2, "numlock": 2, "pagedown": 2, "pageup": 2, "paus": 2, "pgdn": 2, "pgup": 2, "playpaus": 2, "prevtrack": 2, "print": 2, "printscreen": 2, "prntscrn": 2, "prtsc": 2, "prtscr": 2, "return": 2, "right": 2, "scrolllock": 2, "select": 2, "separ": 2, "shift": 2, "shiftleft": 2, "shiftright": 2, "sleep": 2, "space": 2, "stop": 2, "subtract": 2, "tab": 2, "up": 2, "volumedown": 2, "volumemut": 2, "volumeup": 2, "win": 2, "winleft": 2, "winright": 2, "yen": 2, "command": 2, "option": 2, "optionleft": 2, "optionright": 2, "fw": 2, "forward": 2, "back": 2, "backward": 2, "messag": 2, "str": 2, "send": 2, "paramet": 2, "The": 2, "int": 2, "equip": 2, "item": 2, "action": 2, "durat": 2, "float": 2, "hold": 2, "one": 2, "more": 2, "keyboard": 2, "kei": 2, "time": 2, "If": 2, "than": 2, "provid": 2, "all": 2, "held": 2, "releas": 2, "simultan": 2, "how": 2, "long": 2, "second": 2, "number_of_jump": 2, "delai": 2, "number": 2, "mani": 2, "default": 2, "much": 2, "press": 2, "interv": 2, "leav": 2, "current": 2, "game": 2, "each": 2, "input": 2, "A": 2, "decor": 2, "ensur": 2, "befor": 2, "run": 2, "thi": 2, "us": 2, "reset": 2, "player": 2, "charact": 2, "chang": 2, "hotkei": 2, "requir": 2, "trigger": 2, "failsaf": 2, "control": 2, "combin": 2, "toggl": 2, "lock": 2, "switch": 2, "must": 2, "enabl": 2, "set": 2, "ui": 2, "navig": 2, "mode": 2, "call": 2, "disabl": 2, "you": 2, "ui_nav_kei": 2, "variabl": 2, "click": 2, "element": 2, "through": 2, "specifi": 2, "diagon": 2, "aren": 2}, "objects": {"": [[2, 0, 0, "-", "pyrobloxbot"]], "pyrobloxbot": [[2, 1, 1, "", "chat"], [2, 1, 1, "", "equip_slot"], [2, 0, 0, "-", "exceptions"], [2, 1, 1, "", "hold_keyboard_action"], [2, 1, 1, "", "jump"], [2, 1, 1, "", "jump_continuous"], [2, 1, 1, "", "keyboard_action"], [2, 1, 1, "", "leave_game"], [2, 0, 0, "-", "literals"], [2, 1, 1, "", "require_focus"], [2, 1, 1, "", "reset_player"], [2, 1, 1, "", "set_failsafe_hotkey"], [2, 1, 1, "", "toggle_shift_lock"], [2, 1, 1, "", "toggle_ui_navigation"], [2, 1, 1, "", "ui_click"], [2, 1, 1, "", "ui_navigate"], [2, 1, 1, "", "ui_navigate_down"], [2, 1, 1, "", "ui_navigate_left"], [2, 1, 1, "", "ui_navigate_right"], [2, 1, 1, "", "ui_navigate_up"], [2, 1, 1, "", "walk"], [2, 1, 1, "", "walk_back"], [2, 1, 1, "", "walk_forward"], [2, 1, 1, "", "walk_left"], [2, 1, 1, "", "walk_right"]], "pyrobloxbot.exceptions": [[2, 2, 1, "", "InvalidSlotNumberException"], [2, 2, 1, "", "InvalidUiDirectionException"], [2, 2, 1, "", "InvalidWalkDirectionException"], [2, 2, 1, "", "NoRobloxWindowException"]], "pyrobloxbot.literals": [[2, 3, 1, "", "KEYBOARD_KEYS"], [2, 3, 1, "", "UI_NAVIGATE_DIRECTIONS"], [2, 3, 1, "", "WALK_DIRECTIONS"]], "pyrobloxbot.literals.KEYBOARD_KEYS": [[2, 4, 1, "", "VALUES"]], "pyrobloxbot.literals.UI_NAVIGATE_DIRECTIONS": [[2, 4, 1, "", "VALUES"]], "pyrobloxbot.literals.WALK_DIRECTIONS": [[2, 4, 1, "", "VALUES"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:exception", "3": "py:class", "4": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "exception", "Python exception"], "3": ["py", "class", "Python class"], "4": ["py", "attribute", "Python attribute"]}, "titleterms": {"welcom": 0, "pyrobloxbot": [0, 1, 2], "": 0, "document": 0, "indic": 0, "tabl": 0, "packag": 2, "submodul": 2, "except": 2, "modul": 2, "liter": 2, "content": 2}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Welcome to pyrobloxbot\u2019s documentation!": [[0, "welcome-to-pyrobloxbot-s-documentation"]], "Indices and tables": [[0, "indices-and-tables"]], "pyrobloxbot": [[1, "pyrobloxbot"]], "pyrobloxbot package": [[2, "pyrobloxbot-package"]], "Submodules": [[2, "submodules"]], "pyrobloxbot.exceptions module": [[2, "module-pyrobloxbot.exceptions"]], "pyrobloxbot.literals module": [[2, "module-pyrobloxbot.literals"]], "Module contents": [[2, "module-pyrobloxbot"]]}, "indexentries": {"invalidslotnumberexception": [[2, "pyrobloxbot.exceptions.InvalidSlotNumberException"]], "invaliduidirectionexception": [[2, "pyrobloxbot.exceptions.InvalidUiDirectionException"]], "invalidwalkdirectionexception": [[2, "pyrobloxbot.exceptions.InvalidWalkDirectionException"]], "keyboard_keys (class in pyrobloxbot.literals)": [[2, "pyrobloxbot.literals.KEYBOARD_KEYS"]], "norobloxwindowexception": [[2, "pyrobloxbot.exceptions.NoRobloxWindowException"]], "ui_navigate_directions (class in pyrobloxbot.literals)": [[2, "pyrobloxbot.literals.UI_NAVIGATE_DIRECTIONS"]], "values (pyrobloxbot.literals.keyboard_keys attribute)": [[2, "pyrobloxbot.literals.KEYBOARD_KEYS.VALUES"]], "values (pyrobloxbot.literals.ui_navigate_directions attribute)": [[2, "pyrobloxbot.literals.UI_NAVIGATE_DIRECTIONS.VALUES"]], "values (pyrobloxbot.literals.walk_directions attribute)": [[2, "pyrobloxbot.literals.WALK_DIRECTIONS.VALUES"]], "walk_directions (class in pyrobloxbot.literals)": [[2, "pyrobloxbot.literals.WALK_DIRECTIONS"]], "chat() (in module pyrobloxbot)": [[2, "pyrobloxbot.chat"]], "equip_slot() (in module pyrobloxbot)": [[2, "pyrobloxbot.equip_slot"]], "hold_keyboard_action() (in module pyrobloxbot)": [[2, "pyrobloxbot.hold_keyboard_action"]], "jump() (in module pyrobloxbot)": [[2, "pyrobloxbot.jump"]], "jump_continuous() (in module pyrobloxbot)": [[2, "pyrobloxbot.jump_continuous"]], "keyboard_action() (in module pyrobloxbot)": [[2, "pyrobloxbot.keyboard_action"]], "leave_game() (in module pyrobloxbot)": [[2, "pyrobloxbot.leave_game"]], "module": [[2, "module-pyrobloxbot"], [2, "module-pyrobloxbot.exceptions"], [2, "module-pyrobloxbot.literals"]], "pyrobloxbot": [[2, "module-pyrobloxbot"]], "pyrobloxbot.exceptions": [[2, "module-pyrobloxbot.exceptions"]], "pyrobloxbot.literals": [[2, "module-pyrobloxbot.literals"]], "require_focus() (in module pyrobloxbot)": [[2, "pyrobloxbot.require_focus"]], "reset_player() (in module pyrobloxbot)": [[2, "pyrobloxbot.reset_player"]], "set_failsafe_hotkey() (in module pyrobloxbot)": [[2, "pyrobloxbot.set_failsafe_hotkey"]], "toggle_shift_lock() (in module pyrobloxbot)": [[2, "pyrobloxbot.toggle_shift_lock"]], "toggle_ui_navigation() (in module pyrobloxbot)": [[2, "pyrobloxbot.toggle_ui_navigation"]], "ui_click() (in module pyrobloxbot)": [[2, "pyrobloxbot.ui_click"]], "ui_navigate() (in module pyrobloxbot)": [[2, "pyrobloxbot.ui_navigate"]], "ui_navigate_down() (in module pyrobloxbot)": [[2, "pyrobloxbot.ui_navigate_down"]], "ui_navigate_left() (in module pyrobloxbot)": [[2, "pyrobloxbot.ui_navigate_left"]], "ui_navigate_right() (in module pyrobloxbot)": [[2, "pyrobloxbot.ui_navigate_right"]], "ui_navigate_up() (in module pyrobloxbot)": [[2, "pyrobloxbot.ui_navigate_up"]], "walk() (in module pyrobloxbot)": [[2, "pyrobloxbot.walk"]], "walk_back() (in module pyrobloxbot)": [[2, "pyrobloxbot.walk_back"]], "walk_forward() (in module pyrobloxbot)": [[2, "pyrobloxbot.walk_forward"]], "walk_left() (in module pyrobloxbot)": [[2, "pyrobloxbot.walk_left"]], "walk_right() (in module pyrobloxbot)": [[2, "pyrobloxbot.walk_right"]]}}) -------------------------------------------------------------------------------- /docs/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | pushd %~dp0 4 | 5 | REM Command file for Sphinx documentation 6 | 7 | if "%SPHINXBUILD%" == "" ( 8 | set SPHINXBUILD=sphinx-build 9 | ) 10 | set SOURCEDIR=source 11 | set BUILDDIR=build 12 | 13 | %SPHINXBUILD% >NUL 2>NUL 14 | if errorlevel 9009 ( 15 | echo. 16 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 17 | echo.installed, then set the SPHINXBUILD environment variable to point 18 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 19 | echo.may add the Sphinx directory to PATH. 20 | echo. 21 | echo.If you don't have Sphinx installed, grab it from 22 | echo.https://www.sphinx-doc.org/ 23 | exit /b 1 24 | ) 25 | 26 | if "%1" == "" goto help 27 | 28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 29 | goto end 30 | 31 | :help 32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% 33 | 34 | :end 35 | popd 36 | -------------------------------------------------------------------------------- /docs/source/conf.py: -------------------------------------------------------------------------------- 1 | #Tell sphinx and rtd where to find source code 2 | import sys, pathlib 3 | sys.path.append((pathlib.Path(__file__).parent.parent.parent / "src").resolve().as_posix()) 4 | #for local building 5 | #sys.path.insert(0, "C:\\Users\\Public\\codg\\pyrobloxbot\\src") 6 | 7 | #from pyrobloxbot import literals 8 | 9 | #autodoc_type_aliases = { 10 | #'KEYBOARD_KEYS': literals.KEYBOARD_KEYS, 11 | #'WALK_DIRECTIONS': literals.WALK_DIRECTIONS 12 | #} 13 | 14 | autodoc_type_aliases = { 15 | 'KEYBOARD_KEYS': "KEYBOARD_KEYS", 16 | 'WALK_DIRECTIONS': "WALK_DIRECTIONS", 17 | "UI_NAVIGATE_DIRECTIONS": "UI_NAVIGATE_DIRECTIONS" 18 | } 19 | 20 | # Configuration file for the Sphinx documentation builder. 21 | # 22 | # For the full list of built-in configuration values, see the documentation: 23 | # https://www.sphinx-doc.org/en/master/usage/configuration.html 24 | 25 | # -- Project information ----------------------------------------------------- 26 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information 27 | import sphinx_rtd_theme 28 | project = 'pyrobloxbot' 29 | copyright = '2024, Mews' 30 | author = 'Mews' 31 | release = '1.0.5' 32 | autodoc_mock_imports = ["pydirectinput", "win32gui", "pygetwindow", "keyboard", "pynput", "pyautogui"] 33 | # -- General configuration --------------------------------------------------- 34 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration 35 | 36 | extensions = ["sphinx.ext.autodoc", "sphinx_rtd_theme", "sphinx.ext.autosummary"] 37 | pygments_style = "sphinx" 38 | templates_path = ['_templates'] 39 | exclude_patterns = [] 40 | 41 | 42 | 43 | # -- Options for HTML output ------------------------------------------------- 44 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output 45 | 46 | html_theme = 'sphinx_rtd_theme' 47 | html_static_path = ['_static'] 48 | -------------------------------------------------------------------------------- /docs/source/index.rst: -------------------------------------------------------------------------------- 1 | .. pyrobloxbot documentation master file, created by 2 | sphinx-quickstart on Tue Feb 13 20:28:32 2024. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | Welcome to pyrobloxbot's documentation! 7 | ======================================= 8 | 9 | .. toctree:: 10 | :maxdepth: 2 11 | :caption: Contents: 12 | 13 | 14 | 15 | Indices and tables 16 | ================== 17 | 18 | * :ref:`genindex` 19 | * :ref:`modindex` 20 | * :ref:`search` 21 | -------------------------------------------------------------------------------- /docs/source/modules.rst: -------------------------------------------------------------------------------- 1 | pyrobloxbot 2 | =========== 3 | 4 | .. toctree:: 5 | :maxdepth: 4 6 | 7 | pyrobloxbot 8 | -------------------------------------------------------------------------------- /docs/source/pyrobloxbot.rst: -------------------------------------------------------------------------------- 1 | pyrobloxbot package 2 | =================== 3 | 4 | Submodules 5 | ---------- 6 | 7 | pyrobloxbot.exceptions module 8 | ----------------------------- 9 | 10 | .. automodule:: pyrobloxbot.exceptions 11 | :members: 12 | :undoc-members: 13 | :show-inheritance: 14 | 15 | pyrobloxbot.literals module 16 | --------------------------- 17 | 18 | .. automodule:: pyrobloxbot.literals 19 | :members: 20 | :undoc-members: 21 | :show-inheritance: 22 | 23 | Module contents 24 | --------------- 25 | 26 | .. automodule:: pyrobloxbot 27 | :members: 28 | :undoc-members: 29 | :show-inheritance: 30 | -------------------------------------------------------------------------------- /outdated dists/dist 1.0.0/pyrobloxbot-1.0.0-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.0/pyrobloxbot-1.0.0-py3-none-any.whl -------------------------------------------------------------------------------- /outdated dists/dist 1.0.0/pyrobloxbot-1.0.0.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.0/pyrobloxbot-1.0.0.tar.gz -------------------------------------------------------------------------------- /outdated dists/dist 1.0.1/pyrobloxbot-1.0.1-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.1/pyrobloxbot-1.0.1-py3-none-any.whl -------------------------------------------------------------------------------- /outdated dists/dist 1.0.1/pyrobloxbot-1.0.1.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.1/pyrobloxbot-1.0.1.tar.gz -------------------------------------------------------------------------------- /outdated dists/dist 1.0.2/pyrobloxbot-1.0.2-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.2/pyrobloxbot-1.0.2-py3-none-any.whl -------------------------------------------------------------------------------- /outdated dists/dist 1.0.2/pyrobloxbot-1.0.2.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.2/pyrobloxbot-1.0.2.tar.gz -------------------------------------------------------------------------------- /outdated dists/dist 1.0.3/pyrobloxbot-1.0.3-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.3/pyrobloxbot-1.0.3-py3-none-any.whl -------------------------------------------------------------------------------- /outdated dists/dist 1.0.3/pyrobloxbot-1.0.3.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.3/pyrobloxbot-1.0.3.tar.gz -------------------------------------------------------------------------------- /outdated dists/dist 1.0.4/pyrobloxbot-1.0.4-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.4/pyrobloxbot-1.0.4-py3-none-any.whl -------------------------------------------------------------------------------- /outdated dists/dist 1.0.4/pyrobloxbot-1.0.4.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.4/pyrobloxbot-1.0.4.tar.gz -------------------------------------------------------------------------------- /outdated dists/dist 1.0.5/pyrobloxbot-1.0.5-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.5/pyrobloxbot-1.0.5-py3-none-any.whl -------------------------------------------------------------------------------- /outdated dists/dist 1.0.5/pyrobloxbot-1.0.5.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.5/pyrobloxbot-1.0.5.tar.gz -------------------------------------------------------------------------------- /outdated dists/dist 1.0.6/pyrobloxbot-1.0.6-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.6/pyrobloxbot-1.0.6-py3-none-any.whl -------------------------------------------------------------------------------- /outdated dists/dist 1.0.6/pyrobloxbot-1.0.6.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.6/pyrobloxbot-1.0.6.tar.gz -------------------------------------------------------------------------------- /outdated dists/dist 1.0.7/pyrobloxbot-1.0.7-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.7/pyrobloxbot-1.0.7-py3-none-any.whl -------------------------------------------------------------------------------- /outdated dists/dist 1.0.7/pyrobloxbot-1.0.7.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.7/pyrobloxbot-1.0.7.tar.gz -------------------------------------------------------------------------------- /outdated dists/dist 1.0.8/pyrobloxbot-1.0.8-py3-none-any.whl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.8/pyrobloxbot-1.0.8-py3-none-any.whl -------------------------------------------------------------------------------- /outdated dists/dist 1.0.8/pyrobloxbot-1.0.8.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Mews/py-roblox-bot/b161361c1620f76de82888de4b3d262d385a844e/outdated dists/dist 1.0.8/pyrobloxbot-1.0.8.tar.gz -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["hatchling"] 3 | build-backend = "hatchling.build" 4 | 5 | [project] 6 | name = "pyrobloxbot" 7 | version = "1.0.9" 8 | authors = [ 9 | { name="Mews", email="tiraraspas@gmail.com" }, 10 | ] 11 | description = "A python library to control the roblox character and interact with game ui through keyboard inputs" 12 | readme = "README.md" 13 | requires-python = ">=3.9" 14 | classifiers = [ 15 | "Programming Language :: Python :: 3", 16 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 17 | "Operating System :: Microsoft :: Windows", 18 | ] 19 | dependencies = [ 20 | "pydirectinput", 21 | "pygetwindow", 22 | "pyperclip", 23 | "pywin32", 24 | "keyboard", 25 | "pynput", 26 | "pyautogui", 27 | "opencv-python", 28 | "pillow", 29 | ] 30 | keywords = ["roblox", "bot", "keyboard"] 31 | 32 | [project.urls] 33 | Homepage = "https://github.com/Mews/py-roblox-bot" 34 | Issues = "https://github.com/Mews/py-roblox-bot/issues" -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pyperclip 2 | sphinx_rtd_theme -------------------------------------------------------------------------------- /src/pyrobloxbot/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | import _thread 3 | from functools import wraps 4 | import os 5 | from time import sleep as wait 6 | import pydirectinput as dinput 7 | from pygetwindow import getWindowsWithTitle, getActiveWindow 8 | from win32gui import GetWindowText, GetForegroundWindow 9 | import pyperclip as pyclip 10 | import keyboard as kb 11 | from pynput.keyboard import Key, Controller 12 | import pyautogui as pg 13 | from .exceptions import * 14 | from .literals import * 15 | 16 | UI_NAV_ENABLED = False 17 | UI_NAV_KEY = "\\" 18 | """The key that is used by toggle_ui_navigation to turn on the ui navigation mode""" 19 | 20 | FAILSAFE_HOTKEY = "ctrl+m" 21 | 22 | kb.add_hotkey(FAILSAFE_HOTKEY, _thread.interrupt_main) 23 | 24 | def set_failsafe_hotkey(*keys:KEYBOARD_KEYS.VALUES): 25 | """Changes hotkey required to trigger the failsafe 26 | 27 | The default hotkey is control + m 28 | 29 | :param keys: The key combination for triggering the failsafe 30 | :type keys: KEYBOARD_KEYS 31 | """ 32 | global FAILSAFE_HOTKEY 33 | 34 | kb.clear_hotkey(FAILSAFE_HOTKEY) 35 | 36 | FAILSAFE_HOTKEY = "" 37 | for key in keys: 38 | key = kb._canonical_names.normalize_name(key) 39 | FAILSAFE_HOTKEY += key 40 | FAILSAFE_HOTKEY += "+" 41 | 42 | FAILSAFE_HOTKEY = FAILSAFE_HOTKEY[:-1] 43 | 44 | kb.add_hotkey(FAILSAFE_HOTKEY, _thread.interrupt_main) 45 | 46 | def require_focus(fn): 47 | """A decorator that ensures the roblox window is in focus before running the decorated function 48 | 49 | This is already used by all pyrobloxbot functions that require it so you do not have to add it 50 | 51 | :raises NoRobloxWindowException: Raised when can't find a roblox window to focus 52 | """ 53 | #Fast check to see if roblox window is already focused 54 | @wraps(fn) 55 | def wrapper(*args, **kwargs): 56 | if GetWindowText(GetForegroundWindow()) == "Roblox": 57 | return fn(*args, **kwargs) 58 | 59 | else: 60 | rblxWindow = None 61 | 62 | #Find roblox window 63 | for window in getWindowsWithTitle("Roblox"): 64 | if window.title == "Roblox": 65 | rblxWindow = window 66 | 67 | #Raise error if roblox isn't open 68 | if rblxWindow == None: 69 | raise NoRobloxWindowException("You must have roblox opened") 70 | 71 | #Set focus to roblox window 72 | else: 73 | rblxWindow.maximize() 74 | rblxWindow.activate() 75 | 76 | #Wait for the roblox window to be active 77 | while getActiveWindow() == None: 78 | pass 79 | 80 | return fn(*args, **kwargs) 81 | 82 | return wrapper 83 | 84 | @require_focus 85 | def keyboard_action(*actions:KEYBOARD_KEYS.VALUES): 86 | """Presses one or more keyboard keys 87 | 88 | :param actions: The keys to be pressed 89 | :type actions: KEYBOARD_KEYS 90 | """ 91 | for action in actions: 92 | dinput.press(action) 93 | 94 | @require_focus 95 | def hold_keyboard_action(*actions:KEYBOARD_KEYS.VALUES, duration:float): 96 | """Holds one or more keyboard keys for a given time 97 | 98 | If more than one key is provided, all keys will be held and released simultaneously 99 | 100 | :param actions: The keys to be held 101 | :type actions: KEYBOARD_KEYS 102 | :param duration: How long to hold for, in seconds 103 | :type duration: float 104 | """ 105 | for action in actions: 106 | dinput.keyDown(action) 107 | wait(duration) 108 | for action in actions: 109 | dinput.keyUp(action) 110 | 111 | press_key = keyboard_action 112 | """An alias for the keyboard_action function""" 113 | 114 | hold_key = hold_keyboard_action 115 | """An alias for the hold_keyboard_action function""" 116 | 117 | @require_focus 118 | def key_down(key:KEYBOARD_KEYS.VALUES): 119 | """Holds down a key in a non blocking way 120 | 121 | The key will be held until key_up is called for the same key 122 | 123 | :param key: The key to be held down 124 | :type key: KEYBOARD_KEYS 125 | """ 126 | dinput.keyDown(key) 127 | 128 | @require_focus 129 | def key_up(key:KEYBOARD_KEYS.VALUES): 130 | """Releases a key 131 | 132 | :param key: The key to be released 133 | :type key: KEYBOARD_KEYS 134 | """ 135 | dinput.keyUp(key) 136 | 137 | @require_focus 138 | def walk(*directions:WALK_DIRECTIONS.VALUES, duration:float): 139 | """Walks in one or more directions for a given time 140 | 141 | If more than one direction is given it will walk diagonally 142 | 143 | :param directions: The directions to walk in 144 | :type directions: WALK_DIRECTIONS 145 | :param duration: How long to walk for, in seconds 146 | :type duration: float 147 | :raises InvalidWalkDirectionException: Raised when given directions aren't one of literals.WALK_DIRECTIONS.VALUES 148 | """ 149 | 150 | forwardDirections = ["f", "fw", "forward", "forwards"] 151 | leftDirections = ["l", "left"] 152 | rightDirections = ["r", "right"] 153 | backDirections = ["b", "back", "backward", "backwards"] 154 | 155 | ## Check if all directions are valid 156 | for direction in directions: 157 | direction = direction.lower().strip() 158 | 159 | if direction in forwardDirections: 160 | pass 161 | elif direction in leftDirections: 162 | pass 163 | elif direction in rightDirections: 164 | pass 165 | elif direction in backDirections: 166 | pass 167 | else: 168 | raise InvalidWalkDirectionException("Direction must be one of "+str(WALK_DIRECTIONS.VALUES)) 169 | 170 | #Hold down keys 171 | for direction in directions: 172 | direction = direction.lower().strip() 173 | 174 | if direction in forwardDirections: 175 | dinput.keyDown("w") 176 | elif direction in leftDirections: 177 | dinput.keyDown("a") 178 | elif direction in rightDirections: 179 | dinput.keyDown("d") 180 | elif direction in backDirections: 181 | dinput.keyDown("s") 182 | 183 | wait(duration) 184 | 185 | #Release keys 186 | for direction in directions: 187 | direction = direction.lower().strip() 188 | 189 | if direction in forwardDirections: 190 | dinput.keyUp("w") 191 | elif direction in leftDirections: 192 | dinput.keyUp("a") 193 | elif direction in rightDirections: 194 | dinput.keyUp("d") 195 | elif direction in backDirections: 196 | dinput.keyUp("s") 197 | 198 | @require_focus 199 | def walk_forward(duration:float): 200 | """Walks forward for a given time 201 | 202 | :param duration: How long to walk for, in seconds 203 | :type duration: float 204 | """ 205 | dinput.keyDown("w") 206 | wait(duration) 207 | dinput.keyUp("w") 208 | 209 | @require_focus 210 | def walk_left(duration:float): 211 | """Walks left for a given time 212 | 213 | :param duration: How long to walk for, in seconds 214 | :type duration: float 215 | """ 216 | dinput.keyDown("a") 217 | wait(duration) 218 | dinput.keyUp("a") 219 | 220 | @require_focus 221 | def walk_right(duration:float): 222 | """Walks right for a given time 223 | 224 | :param duration: How long to walk for, in seconds 225 | :type duration: float 226 | """ 227 | dinput.keyDown("d") 228 | wait(duration) 229 | dinput.keyUp("d") 230 | 231 | @require_focus 232 | def walk_back(duration:float): 233 | """Walks back for a given time 234 | 235 | :param duration: How long to walk for, in seconds 236 | :type duration: float 237 | """ 238 | dinput.keyDown("s") 239 | wait(duration) 240 | dinput.keyUp("s") 241 | 242 | @require_focus 243 | def jump(number_of_jumps:int=1, delay:float=0): 244 | """Jumps for a given number of times 245 | 246 | :param number_of_jumps: How many times to jump, defaults to 1 247 | :type number_of_jumps: int 248 | :param delay: How much time between jumps, in seconds, defaults to 0 249 | :type delay: float 250 | """ 251 | for i in range(number_of_jumps): 252 | dinput.press("space") 253 | wait(delay) 254 | 255 | @require_focus 256 | def jump_continuous(duration:float): 257 | """Holds jump for a given time 258 | 259 | :param duration: How long to hold jump for, in seconds 260 | :type duration: float 261 | """ 262 | dinput.keyDown("space") 263 | wait(duration) 264 | dinput.keyUp("space") 265 | 266 | @require_focus 267 | def reset_player(interval:float=0.5): 268 | """Resets player character 269 | 270 | :param interval: How long between each keyboard input, in seconds, defaults to 0.5 271 | :type interval: float 272 | """ 273 | dinput.press(("esc", "r", "enter"), interval=interval) 274 | 275 | @require_focus 276 | def leave_game(interval:float=0.5): 277 | """Leaves the current game 278 | 279 | :param interval: How long between each keyboard input, in seconds, defaults to 0.5 280 | :type interval: float 281 | """ 282 | global UI_NAV_ENABLED 283 | dinput.press(("esc", "l", "enter"), interval=interval) 284 | UI_NAV_ENABLED = False 285 | 286 | @require_focus 287 | def toggle_shift_lock(): 288 | """Toggles shift lock (Shift lock switch must be enabled in roblox settings) 289 | """ 290 | dinput.press("shift") 291 | 292 | @require_focus 293 | def chat(message:str): 294 | """Sends a message in chat 295 | 296 | :param message: The message to send 297 | :type message: str 298 | """ 299 | #Open chat 300 | dinput.keyDown("shift") 301 | dinput.keyDown("7") 302 | dinput.keyUp("shift") 303 | dinput.keyUp("7") 304 | 305 | #Use clipboard to paste message quickly 306 | previousClipboard = pyclip.paste() 307 | 308 | pyclip.copy(message) 309 | dinput.keyDown("ctrl") 310 | dinput.keyDown("v") 311 | dinput.keyUp("ctrl") 312 | dinput.keyUp("v") 313 | 314 | dinput.press("enter") 315 | 316 | toggle_shift_lock() 317 | 318 | #Restore previous clipboard content 319 | pyclip.copy(previousClipboard) 320 | 321 | @require_focus 322 | def toggle_ui_navigation(): 323 | """Toggles ui navigation mode. 324 | 325 | This is called by all ui navigation functions if ui navigation mode is disabled. 326 | 327 | You can change the key used to toggle this mode by changing the module's UI_NAV_KEY variable 328 | 329 | The "UI Navigation Toggle" setting must be enabled on Roblox 330 | """ 331 | global UI_NAV_ENABLED 332 | UI_NAV_ENABLED = not UI_NAV_ENABLED 333 | dinput.press(UI_NAV_KEY) 334 | 335 | 336 | def ui_navigate(direction:UI_NAVIGATE_DIRECTIONS.VALUES): 337 | """Navigates through roblox ui in specified direction 338 | 339 | :param direction: The direction to navigate in 340 | :type direction: UI_NAVIGATE_DIRECTIONS 341 | :raises InvalidUiDirectionException: Raised if direction isn't one of 342 | """ 343 | direction = direction.lower().strip() 344 | 345 | up_directions = ["up", "u"] 346 | left_directions = ["left", "l"] 347 | right_directions = ["right", "r"] 348 | down_directions = ["down", "d"] 349 | 350 | if direction in up_directions: 351 | ui_navigate_up() 352 | 353 | elif direction in left_directions: 354 | ui_navigate_left() 355 | 356 | elif direction in right_directions: 357 | ui_navigate_right() 358 | 359 | elif direction in down_directions: 360 | ui_navigate_left() 361 | 362 | else: 363 | raise InvalidUiDirectionException("Direction must be one of "+str(UI_NAVIGATE_DIRECTIONS.VALUES)) 364 | 365 | @require_focus 366 | def ui_navigate_up(): 367 | """Navigate up in ui elements 368 | """ 369 | if not UI_NAV_ENABLED: 370 | toggle_ui_navigation() 371 | 372 | dinput.press('up') 373 | 374 | @require_focus 375 | def ui_navigate_left(): 376 | """Navigate left in ui elements 377 | """ 378 | if not UI_NAV_ENABLED: 379 | toggle_ui_navigation() 380 | 381 | dinput.press('left') 382 | 383 | @require_focus 384 | def ui_navigate_right(): 385 | """Navigate right in ui elements 386 | """ 387 | if not UI_NAV_ENABLED: 388 | toggle_ui_navigation() 389 | 390 | dinput.press('right') 391 | 392 | @require_focus 393 | def ui_navigate_down(): 394 | """Navigate down in ui elements 395 | """ 396 | if not UI_NAV_ENABLED: 397 | toggle_ui_navigation() 398 | 399 | dinput.press('down') 400 | 401 | @require_focus 402 | def ui_click(): 403 | """Click on currently selected ui element 404 | """ 405 | if not UI_NAV_ENABLED: 406 | toggle_ui_navigation() 407 | 408 | dinput.press("enter") 409 | 410 | @require_focus 411 | def ui_scroll_up(ticks:int, delay:float=0.1): 412 | """Scrolls up through selected ui element 413 | 414 | The ui element itself has to be scrollable 415 | 416 | :param ticks: How many times to scroll 417 | :type ticks: int 418 | :param delay: The delay between each input, defaults to 0.1\n 419 | A lower delay will scroll faster but at some point can lose precision 420 | :type delay: float, optional 421 | """ 422 | if not UI_NAV_ENABLED: 423 | toggle_ui_navigation() 424 | 425 | kb = Controller() 426 | for i in range(ticks): 427 | kb.press(Key.page_up) 428 | kb.release(Key.page_up) 429 | wait(delay) 430 | 431 | @require_focus 432 | def ui_scroll_down(ticks:int, delay:float=0.1): 433 | """Scrolls down in selected ui element 434 | 435 | :param ticks: How many times to scroll 436 | :type ticks: int 437 | :param delay: The delay between each input, defaults to 0.1\n 438 | A lower delay will scroll faster but at some point can lose precision 439 | :type delay: float, optional 440 | """ 441 | if not UI_NAV_ENABLED: 442 | toggle_ui_navigation() 443 | 444 | kb = Controller() 445 | for i in range(ticks): 446 | kb.press(Key.page_down) 447 | kb.release(Key.page_down) 448 | wait(delay) 449 | 450 | @require_focus 451 | def equip_slot(slot:int): 452 | """Equip a given item slot 453 | 454 | :param slot: The item slot to equip 455 | :type slot: int 456 | :raises InvalidSlotNumberException: Raised when slot isn't between 0 and 9 457 | """ 458 | if slot < 0 or slot > 9: 459 | raise InvalidSlotNumberException("Slots should be between 0 and 9") 460 | 461 | dinput.press(str(slot)) 462 | 463 | def launch_game(game_id:int): 464 | """Launches a roblox game 465 | 466 | There can be a few seconds of delay between calling this function and the game opening 467 | 468 | :param game_id: The id of the roblox game to launch 469 | :type game_id: int 470 | """ 471 | game_id = str(game_id) 472 | command = "start roblox://placeId="+str(game_id) 473 | os.system(command=command) 474 | 475 | @require_focus 476 | def image_is_visible(image_path:str, confidence:float=0.9) -> bool: 477 | """Checks whether a given image is visible in the roblox window 478 | 479 | :param image_path: The path to the image file to check 480 | :type image_path: str 481 | :param confidence: How confident the function has to be to return True, must be between 0 and 0.999, defaults to 0.9\n 482 | If this value is too low it may give false positives 483 | 484 | :type confidence: float, optional 485 | :return: Whether or not the image is visible 486 | :rtype: bool 487 | """ 488 | 489 | try: 490 | pg.locateOnScreen(image_path, confidence=confidence) 491 | return True 492 | except pg.ImageNotFoundException: 493 | return False -------------------------------------------------------------------------------- /src/pyrobloxbot/exceptions.py: -------------------------------------------------------------------------------- 1 | class NoRobloxWindowException(Exception): 2 | """Raised when a function can't find a roblox window to focus 3 | """ 4 | pass 5 | 6 | class InvalidSlotNumberException(Exception): 7 | """Raised by equip_slot when slot isn't between 0 and 9 8 | """ 9 | pass 10 | 11 | class InvalidWalkDirectionException(Exception): 12 | """Raised by walk when given a direction that isn't in literals.WALK_DIRECTIONS.VALUES 13 | """ 14 | pass 15 | 16 | class InvalidUiDirectionException(Exception): 17 | """Raised by ui_navigate when given a direction that isn't in literals.UI_NAVIGATE_DIRECTIONS.VALUES 18 | """ -------------------------------------------------------------------------------- /src/pyrobloxbot/literals.py: -------------------------------------------------------------------------------- 1 | import typing 2 | 3 | class KEYBOARD_KEYS: 4 | """Valid strings to pass to keyboard_action and hold_keyboard_action 5 | """ 6 | VALUES = typing.Literal['\t', '\n', '\r', ' ', '!', '"', '#', '$', '%', '&', "'", '(', 7 | ')', '*', '+', ',', '-', '.', '/', '0', '1', '2', '3', '4', '5', '6', '7', 8 | '8', '9', ':', ';', '<', '=', '>', '?', '@', '[', '\\', ']', '^', '_', '`', 9 | 'a', 'b', 'c', 'd', 'e','f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 10 | 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '{', '|', '}', '~', 11 | 'accept', 'add', 'alt', 'altleft', 'altright', 'apps', 'backspace', 12 | 'browserback', 'browserfavorites', 'browserforward', 'browserhome', 13 | 'browserrefresh', 'browsersearch', 'browserstop', 'capslock', 'clear', 14 | 'convert', 'ctrl', 'ctrlleft', 'ctrlright', 'decimal', 'del', 'delete', 15 | 'divide', 'down', 'end', 'enter', 'esc', 'escape', 'execute', 'f1', 'f10', 16 | 'f11', 'f12', 'f13', 'f14', 'f15', 'f16', 'f17', 'f18', 'f19', 'f2', 'f20', 17 | 'f21', 'f22', 'f23', 'f24', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 18 | 'final', 'fn', 'hanguel', 'hangul', 'hanja', 'help', 'home', 'insert', 'junja', 19 | 'kana', 'kanji', 'launchapp1', 'launchapp2', 'launchmail', 20 | 'launchmediaselect', 'left', 'modechange', 'multiply', 'nexttrack', 21 | 'nonconvert', 'num0', 'num1', 'num2', 'num3', 'num4', 'num5', 'num6', 22 | 'num7', 'num8', 'num9', 'numlock', 'pagedown', 'pageup', 'pause', 'pgdn', 23 | 'pgup', 'playpause', 'prevtrack', 'print', 'printscreen', 'prntscrn', 24 | 'prtsc', 'prtscr', 'return', 'right', 'scrolllock', 'select', 'separator', 25 | 'shift', 'shiftleft', 'shiftright', 'sleep', 'space', 'stop', 'subtract', 'tab', 26 | 'up', 'volumedown', 'volumemute', 'volumeup', 'win', 'winleft', 'winright', 'yen', 27 | 'command', 'option', 'optionleft', 'optionright'] 28 | 29 | class WALK_DIRECTIONS: 30 | """Valid strings to pass to walk 31 | """ 32 | VALUES = typing.Literal["f", "fw", "forward", "forwards", "l", "left", "r", "right", "b", "back", "backward", "backwards"] 33 | 34 | class UI_NAVIGATE_DIRECTIONS: 35 | """Valid strings to pass to ui_navigate 36 | """ 37 | VALUES = typing.Literal["up", "u", "left", "l", "right", "r", "down", "d"] --------------------------------------------------------------------------------