├── .gitignore ├── COMPILER.bat ├── LICENSE ├── README.md ├── index.py ├── logo.ico ├── osukeyboard.exe ├── requirements.txt ├── sounds ├── key-caps.mp3 ├── key-confirm.mp3 ├── key-delete.mp3 ├── key-movement.mp3 ├── key-press-1.mp3 ├── key-press-2.mp3 ├── key-press-3.mp3 └── key-press-4.mp3 └── utils ├── playsound.py ├── pyhooked.py └── special_keys.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | MANIFEST 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | 50 | # Translations 51 | *.mo 52 | *.pot 53 | 54 | # Django stuff: 55 | *.log 56 | local_settings.py 57 | db.sqlite3 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # Environments 85 | .env 86 | .venv 87 | env/ 88 | venv/ 89 | ENV/ 90 | env.bak/ 91 | venv.bak/ 92 | 93 | # Spyder project settings 94 | .spyderproject 95 | .spyproject 96 | 97 | # Rope project settings 98 | .ropeproject 99 | 100 | # mkdocs documentation 101 | /site 102 | 103 | # mypy 104 | .mypy_cache/ 105 | -------------------------------------------------------------------------------- /COMPILER.bat: -------------------------------------------------------------------------------- 1 | @echo off 2 | :: Variables 3 | set filename="osukeyboard" 4 | 5 | :: Make it compile beautifuldiscord to an executable file 6 | pyinstaller index.py --onefile --icon=logo.ico --add-data="sounds/*.mp3;sounds" --name %filename%.exe 7 | 8 | :: Copy compiled file to root 9 | del %filename%.exe 10 | copy dist\%filename%.exe . 11 | -------------------------------------------------------------------------------- /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 | # OsuKeyboard 2 | A nice little software that simulates the typing sound from Osu! 3 | 4 | If you want to see how it looks, click [here](https://i.alexflipnote.dev/3rSb3XE.mp4) for a short demo. 5 | 6 | ## Download program 7 | Click [here](https://github.com/AlexFlipnote/OsuKeyboard/raw/master/osukeyboard.exe) to download it. 8 | If Windows Defender comes up and warns you, the only reason it does such is due to unsigned software. (Not paying for that..) 9 | 10 | ## Discord 11 | If you want to visit my Discord: https://discord.gg/DpxkY3x 12 | 13 | ## Requirements 14 | - Python 3.6 or above 15 | - Windows 7 or above 16 | 17 | ## Sources 18 | - [ethanhs/pyhooked](https://github.com/ethanhs/pyhooked) 19 | - [Key sounds from Osu!](https://github.com/ppy/osu-resources/tree/master/osu.Game.Resources/Samples/Keyboard) 20 | - [TaylorSMarks/playsound](https://github.com/TaylorSMarks/playsound) 21 | -------------------------------------------------------------------------------- /index.py: -------------------------------------------------------------------------------- 1 | import ctypes 2 | import os 3 | import random 4 | import sys 5 | 6 | from utils import special_keys 7 | from utils.playsound import playsound 8 | from utils.pyhooked import Hook, KeyboardEvent 9 | 10 | 11 | class OsuKeyboard: 12 | def __init__(self, s_folder: str = "sounds"): 13 | self.version = "1.0.4" 14 | self.s_folder = s_folder 15 | self.ignore_keys = special_keys.listing 16 | 17 | self.welcome_message() 18 | ctypes.windll.kernel32.SetConsoleTitleW("OsuKeyboard") 19 | self.hook_handler() 20 | 21 | def welcome_message(self): 22 | """ Welcome (to Osu!) """ 23 | print(f"OsuKeyboard {self.version}\nCreated by: AlexFlipnote\n") 24 | 25 | def get_true_filename(self, filename): 26 | """ Get the assets files when used with .exe """ 27 | try: 28 | base = sys._MEIPASS 29 | except Exception: 30 | base = os.path.abspath(".") 31 | return os.path.join(base, filename) 32 | 33 | def play(self, filename: str): 34 | """ Play sound in the background of Windows """ 35 | return playsound( 36 | self.get_true_filename(f"{self.s_folder}/{filename}"), 37 | block=False 38 | ) 39 | 40 | def handle_keys(self, key_code: int): 41 | """ Handle each key with their own events, as well as ignoring some keys """ 42 | if key_code in self.ignore_keys: 43 | return None 44 | 45 | if key_code in [8, 46]: # Backspace / Delete 46 | self.play("key-delete.mp3") 47 | elif key_code == 20: # Caps key 48 | self.play("key-caps.mp3") 49 | elif key_code == 13: # Enter key 50 | self.play("key-confirm.mp3") 51 | elif key_code in [37, 38, 39, 40]: 52 | self.play("key-movement.mp3") 53 | else: 54 | self.play(f"key-press-{random.randint(1, 4)}.mp3") 55 | 56 | def handle_events(self, args): 57 | """ Start listening to all key presses done on Windows """ 58 | if isinstance(args, KeyboardEvent): 59 | if args.event_type == "key down": 60 | self.handle_keys(args.key_code) 61 | print(f"Key -> {args.current_key} | ASCII: {args.key_code}") 62 | 63 | def hook_handler(self): 64 | """ Hook script to Windows keyboard event """ 65 | hk = Hook() 66 | hk.handler = self.handle_events 67 | hk.hook() 68 | 69 | 70 | if __name__ == '__main__': 71 | OsuKeyboard() 72 | -------------------------------------------------------------------------------- /logo.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AlexFlipnote/OsuKeyboard/b929d92455cbae37e203f3e77e4828c6e5ba5339/logo.ico -------------------------------------------------------------------------------- /osukeyboard.exe: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AlexFlipnote/OsuKeyboard/b929d92455cbae37e203f3e77e4828c6e5ba5339/osukeyboard.exe -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pyinstaller 2 | -------------------------------------------------------------------------------- /sounds/key-caps.mp3: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AlexFlipnote/OsuKeyboard/b929d92455cbae37e203f3e77e4828c6e5ba5339/sounds/key-caps.mp3 -------------------------------------------------------------------------------- /sounds/key-confirm.mp3: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AlexFlipnote/OsuKeyboard/b929d92455cbae37e203f3e77e4828c6e5ba5339/sounds/key-confirm.mp3 -------------------------------------------------------------------------------- /sounds/key-delete.mp3: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AlexFlipnote/OsuKeyboard/b929d92455cbae37e203f3e77e4828c6e5ba5339/sounds/key-delete.mp3 -------------------------------------------------------------------------------- /sounds/key-movement.mp3: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AlexFlipnote/OsuKeyboard/b929d92455cbae37e203f3e77e4828c6e5ba5339/sounds/key-movement.mp3 -------------------------------------------------------------------------------- /sounds/key-press-1.mp3: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AlexFlipnote/OsuKeyboard/b929d92455cbae37e203f3e77e4828c6e5ba5339/sounds/key-press-1.mp3 -------------------------------------------------------------------------------- /sounds/key-press-2.mp3: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AlexFlipnote/OsuKeyboard/b929d92455cbae37e203f3e77e4828c6e5ba5339/sounds/key-press-2.mp3 -------------------------------------------------------------------------------- /sounds/key-press-3.mp3: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AlexFlipnote/OsuKeyboard/b929d92455cbae37e203f3e77e4828c6e5ba5339/sounds/key-press-3.mp3 -------------------------------------------------------------------------------- /sounds/key-press-4.mp3: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/AlexFlipnote/OsuKeyboard/b929d92455cbae37e203f3e77e4828c6e5ba5339/sounds/key-press-4.mp3 -------------------------------------------------------------------------------- /utils/playsound.py: -------------------------------------------------------------------------------- 1 | # Source: 2 | # https://github.com/TaylorSMarks/playsound/blob/master/playsound.py 3 | 4 | from platform import system 5 | 6 | system = system() 7 | 8 | 9 | class PlaysoundException(Exception): 10 | pass 11 | 12 | 13 | def _playsoundWin(sound, block=True): 14 | ''' 15 | Utilizes windll.winmm. Tested and known to work with MP3 and WAVE on 16 | Windows 7 with Python 2.7. Probably works with more file formats. 17 | Probably works on Windows XP thru Windows 10. Probably works with all 18 | versions of Python. 19 | Inspired by (but not copied from) Michael Gundlach 's mp3play: 20 | https://github.com/michaelgundlach/mp3play 21 | I never would have tried using windll.winmm without seeing his code. 22 | ''' 23 | from ctypes import c_buffer, windll 24 | from random import random 25 | from time import sleep 26 | from sys import getfilesystemencoding 27 | 28 | def winCommand(*command): 29 | buf = c_buffer(255) 30 | command = ' '.join(command).encode(getfilesystemencoding()) 31 | errorCode = int(windll.winmm.mciSendStringA(command, buf, 254, 0)) 32 | if errorCode: 33 | errorBuffer = c_buffer(255) 34 | windll.winmm.mciGetErrorStringA(errorCode, errorBuffer, 254) 35 | exceptionMessage = ('\n Error ' + str(errorCode) + ' for command:' 36 | '\n ' + command.decode() + 37 | '\n ' + errorBuffer.value.decode()) 38 | raise PlaysoundException(exceptionMessage) 39 | return buf.value 40 | 41 | alias = 'playsound_' + str(random()) 42 | winCommand('open "' + sound + '" alias', alias) 43 | winCommand('set', alias, 'time format milliseconds') 44 | durationInMS = winCommand('status', alias, 'length') 45 | winCommand('play', alias, 'from 0 to', durationInMS.decode()) 46 | 47 | if block: 48 | sleep(float(durationInMS) / 1000.0) 49 | 50 | 51 | def _playsoundOSX(sound, block=True): 52 | ''' 53 | Utilizes AppKit.NSSound. Tested and known to work with MP3 and WAVE on 54 | OS X 10.11 with Python 2.7. Probably works with anything QuickTime supports. 55 | Probably works on OS X 10.5 and newer. Probably works with all versions of 56 | Python. 57 | Inspired by (but not copied from) Aaron's Stack Overflow answer here: 58 | http://stackoverflow.com/a/34568298/901641 59 | I never would have tried using AppKit.NSSound without seeing his code. 60 | ''' 61 | from AppKit import NSSound 62 | from Foundation import NSURL 63 | from time import sleep 64 | 65 | if '://' not in sound: 66 | if not sound.startswith('/'): 67 | from os import getcwd 68 | sound = getcwd() + '/' + sound 69 | sound = 'file://' + sound 70 | url = NSURL.URLWithString_(sound) 71 | nssound = NSSound.alloc().initWithContentsOfURL_byReference_(url, True) 72 | if not nssound: 73 | raise IOError('Unable to load sound named: ' + sound) 74 | nssound.play() 75 | 76 | if block: 77 | sleep(nssound.duration()) 78 | 79 | 80 | def _playsoundNix(sound, block=True): 81 | """Play a sound using GStreamer. 82 | Inspired by this: 83 | https://gstreamer.freedesktop.org/documentation/tutorials/playback/playbin-usage.html 84 | """ 85 | if not block: 86 | raise NotImplementedError("block=False cannot be used on this platform yet") 87 | 88 | # pathname2url escapes non-URL-safe characters 89 | import os 90 | try: 91 | from urllib.request import pathname2url 92 | except ImportError: 93 | # python 2 94 | from urllib import pathname2url 95 | 96 | import gi 97 | gi.require_version('Gst', '1.0') 98 | from gi.repository import Gst 99 | 100 | Gst.init(None) 101 | 102 | playbin = Gst.ElementFactory.make('playbin', 'playbin') 103 | if sound.startswith(('http://', 'https://')): 104 | playbin.props.uri = sound 105 | else: 106 | playbin.props.uri = 'file://' + pathname2url(os.path.abspath(sound)) 107 | 108 | set_result = playbin.set_state(Gst.State.PLAYING) 109 | if set_result != Gst.StateChangeReturn.ASYNC: 110 | raise PlaysoundException( 111 | "playbin.set_state returned " + repr(set_result)) 112 | 113 | # FIXME: use some other bus method than poll() with block=False 114 | # https://lazka.github.io/pgi-docs/#Gst-1.0/classes/Bus.html 115 | bus = playbin.get_bus() 116 | bus.poll(Gst.MessageType.EOS, Gst.CLOCK_TIME_NONE) 117 | playbin.set_state(Gst.State.NULL) 118 | 119 | 120 | if system == 'Windows': 121 | playsound = _playsoundWin 122 | elif system == 'Darwin': 123 | playsound = _playsoundOSX 124 | else: 125 | playsound = _playsoundNix 126 | 127 | del system 128 | -------------------------------------------------------------------------------- /utils/pyhooked.py: -------------------------------------------------------------------------------- 1 | # Source: 2 | # https://github.com/ethanhs/pyhooked/blob/master/pyhooked/__init__.py 3 | 4 | import ctypes 5 | import atexit 6 | 7 | from ctypes import wintypes 8 | from ctypes import CFUNCTYPE, POINTER, c_int, c_uint, c_void_p, windll 9 | from ctypes import byref 10 | from warnings import warn 11 | from traceback import format_exc 12 | 13 | __version__ = '0.8.1' 14 | 15 | cmp_func = CFUNCTYPE(c_int, c_int, wintypes.HINSTANCE, POINTER(c_void_p)) 16 | 17 | # redefine names to avoid needless clutter 18 | GetModuleHandleA = ctypes.windll.kernel32.GetModuleHandleA 19 | SetWindowsHookExA = ctypes.windll.user32.SetWindowsHookExA 20 | GetMessageW = ctypes.windll.user32.GetMessageW 21 | DispatchMessageW = ctypes.windll.user32.DispatchMessageW 22 | TranslateMessage = ctypes.windll.user32.TranslateMessage 23 | CallNextHookEx = ctypes.windll.user32.CallNextHookEx 24 | UnhookWindowsHookEx = ctypes.windll.user32.UnhookWindowsHookEx 25 | 26 | # specify the argument and return types of functions 27 | GetModuleHandleA.restype = wintypes.HMODULE 28 | GetModuleHandleA.argtypes = [wintypes.LPCWSTR] 29 | SetWindowsHookExA.restype = c_int 30 | SetWindowsHookExA.argtypes = [c_int, cmp_func, wintypes.HINSTANCE, wintypes.DWORD] 31 | GetMessageW.argtypes = [POINTER(wintypes.MSG), wintypes.HWND, c_uint, c_uint] 32 | TranslateMessage.argtypes = [POINTER(wintypes.MSG)] 33 | DispatchMessageW.argtypes = [POINTER(wintypes.MSG)] 34 | 35 | 36 | def _callback_pointer(handler): 37 | """Create and return C-pointer""" 38 | return cmp_func(handler) 39 | 40 | 41 | class BaseEvent(object): 42 | """A keyboard or mouse event.""" 43 | pass 44 | 45 | 46 | class KeyboardEvent(BaseEvent): 47 | """Class to describe an event triggered by the keyboard""" 48 | def __init__(self, current_key=None, event_type=None, pressed_key=None, key_code=None): 49 | self.current_key = current_key 50 | self.event_type = event_type 51 | self.pressed_key = pressed_key 52 | self.key_code = key_code 53 | 54 | 55 | class MouseEvent(BaseEvent): 56 | """Class to describe an event triggered by the mouse""" 57 | def __init__(self, current_key=None, event_type=None, mouse_x=None, mouse_y=None): 58 | self.current_key = current_key 59 | self.event_type = event_type 60 | self.mouse_x = mouse_x 61 | self.mouse_y = mouse_y 62 | 63 | 64 | # The following section contains dictionaries that map key codes and other event codes to the event type (e.g. key up) 65 | # and the key or button doing the action (e.g. Tab) 66 | MOUSE_ID_TO_KEY = {512: 'Move', 67 | 513: 'LButton', 68 | 514: 'LButton', 69 | 516: 'RButton', 70 | 517: 'RButton', 71 | 519: 'WheelButton', 72 | 520: 'WheelButton', 73 | 522: 'Wheel'} 74 | 75 | MOUSE_ID_TO_EVENT_TYPE = {512: None, 76 | 513: 'key down', 77 | 514: 'key up', 78 | 516: 'key down', 79 | 517: 'key up', 80 | 519: 'key down', 81 | 520: 'key up', 82 | 522: None} 83 | 84 | # stores the relation between keyboard event codes and the key pressed. Reference: 85 | # https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx 86 | # seems to only work on 32 bits 87 | ID_TO_KEY = {8: 'Back', 88 | 9: 'Tab', 89 | 13: 'Return', 90 | 20: 'Capital', 91 | 27: 'Escape', 92 | 32: 'Space', 93 | 33: 'Prior', 94 | 34: 'Next', 95 | 35: 'End', 96 | 36: 'Home', 97 | 37: 'Left', 98 | 38: 'Up', 99 | 39: 'Right', 100 | 40: 'Down', 101 | 44: 'PrtScr', 102 | 46: 'Delete', 103 | 48: '0', 104 | 49: '1', 105 | 50: '2', 106 | 51: '3', 107 | 52: '4', 108 | 53: '5', 109 | 54: '6', 110 | 55: '7', 111 | 56: '8', 112 | 57: '9', 113 | 65: 'A', 114 | 66: 'B', 115 | 67: 'C', 116 | 68: 'D', 117 | 69: 'E', 118 | 70: 'F', 119 | 71: 'G', 120 | 72: 'H', 121 | 73: 'I', 122 | 74: 'J', 123 | 75: 'K', 124 | 76: 'L', 125 | 77: 'M', 126 | 78: 'N', 127 | 79: 'O', 128 | 80: 'P', 129 | 81: 'Q', 130 | 82: 'R', 131 | 83: 'S', 132 | 84: 'T', 133 | 85: 'U', 134 | 86: 'V', 135 | 87: 'W', 136 | 88: 'X', 137 | 89: 'Y', 138 | 90: 'Z', 139 | 91: 'Lwin', 140 | 92: 'Rwin', 141 | 93: 'App', 142 | 95: 'Sleep', 143 | 96: 'Numpad0', 144 | 97: 'Numpad1', 145 | 98: 'Numpad2', 146 | 99: 'Numpad3', 147 | 100: 'Numpad4', 148 | 101: 'Numpad5', 149 | 102: 'Numpad6', 150 | 103: 'Numpad7', 151 | 104: 'Numpad8', 152 | 105: 'Numpad9', 153 | 106: 'Multiply', 154 | 107: 'Add', 155 | 109: 'Subtract', 156 | 110: 'Decimal', 157 | 111: 'Divide', 158 | 112: 'F1', 159 | 113: 'F2', 160 | 114: 'F3', 161 | 115: 'F4', 162 | 116: 'F5', 163 | 117: 'F6', 164 | 118: 'F7', 165 | 119: 'F8', 166 | 120: 'F9', 167 | 121: 'F10', 168 | 122: 'F11', 169 | 123: 'F12', 170 | 144: 'Numlock', 171 | 160: 'Lshift', 172 | 161: 'Rshift', 173 | 162: 'Lcontrol', 174 | 163: 'Rcontrol', 175 | 164: 'Lmenu', 176 | 165: 'Rmenu', 177 | 186: 'Oem_1', 178 | 187: 'Oem_Plus', 179 | 188: 'Oem_Comma', 180 | 189: 'Oem_Minus', 181 | 190: 'Oem_Period', 182 | 191: 'Oem_2', 183 | 192: 'Oem_3', 184 | 219: 'Oem_4', 185 | 220: 'Oem_5', 186 | 221: 'Oem_6', 187 | 222: 'Oem_7', 188 | # 223: 'OEM_8', 189 | 1001: 'mouse left', # mouse hotkeys 190 | 1002: 'mouse right', 191 | 1003: 'mouse middle', 192 | 1000: 'mouse move', # single event hotkeys 193 | 1004: 'mouse wheel up', 194 | 1005: 'mouse wheel down', 195 | 1010: 'Ctrl', # merged hotkeys 196 | 1011: 'Alt', 197 | 1012: 'Shift', 198 | 1013: 'Win', 199 | } 200 | 201 | event_types = {0x100: 'key down', # WM_KeyDown for normal keys 202 | 0x101: 'key up', # WM_KeyUp for normal keys 203 | 0x104: 'key down', # WM_SYSKEYDOWN, used for Alt key. 204 | 0x105: 'key up', # WM_SYSKEYUP, used for Alt key. 205 | } 206 | # these are used for specifying the hook type we want to make 207 | WH_KEYBOARD_LL = 0x00D 208 | WH_MOUSE_LL = 0x0E 209 | # the Windows quit message, if the program quits while listening. 210 | WM_QUIT = 0x0012 211 | 212 | 213 | class Hook(object): 214 | """Main hotkey class used to and listen for hotkeys. Set an event handler to check what keys are pressed.""" 215 | 216 | def __init__(self, warn_unrecognised=False): 217 | """Initializer of the Hook class, creates class attributes. If warn_unrecognised is True, warn when an unrecognised key is pressed.""" 218 | self.warn_unrecognised = warn_unrecognised 219 | self.pressed_keys = [] 220 | self.keyboard_id = None 221 | self.mouse_id = None 222 | self.mouse_is_hook = False 223 | self.keyboard_is_hook = True 224 | 225 | def handler(self, event): 226 | """Handle keyboard and mouse events.""" 227 | raise NotImplementedError() 228 | 229 | def stop(self): 230 | """Stop this object from listening.""" 231 | windll.user32.PostQuitMessage(0) 232 | 233 | def hook(self, keyboard=True, mouse=False): 234 | """Hook mouse and/or keyboard events""" 235 | self.mouse_is_hook = mouse 236 | self.keyboard_is_hook = keyboard 237 | 238 | # check that we are going to hook into at least one device 239 | if not self.mouse_is_hook and not self.keyboard_is_hook: 240 | raise Exception("You must hook into either the keyboard and/or mouse events") 241 | 242 | if self.keyboard_is_hook: 243 | def keyboard_low_level_handler(code, event_code, kb_data_ptr): 244 | """Used to catch keyboard events and deal with the event""" 245 | key_code = 0xFFFFFFFF & kb_data_ptr[0] # key code 246 | current_key = ID_TO_KEY.get(key_code) # check the type of event (see ID_TO_KEY for a list) 247 | if current_key is None: 248 | event = None # We can check this later. 249 | if self.warn_unrecognised: 250 | warn('Unrecognised key ID %d.' % key_code) 251 | else: 252 | event_type = event_types[0xFFFFFFFF & event_code] 253 | 254 | if event_type == 'key down': # add key to those down to list 255 | if current_key not in self.pressed_keys: 256 | self.pressed_keys.append(current_key) 257 | 258 | if event_type == 'key up': # remove when no longer pressed 259 | try: 260 | self.pressed_keys.remove(current_key) 261 | except ValueError: 262 | pass # current_key is not in the list. 263 | 264 | # wrap the keyboard information grabbed into a container class 265 | event = KeyboardEvent(current_key, event_type, self.pressed_keys, key_code) 266 | 267 | # Call the event handler to deal with keys in the list 268 | try: 269 | if event: 270 | self.handler(event) 271 | except Exception: 272 | warn('While handling {}, self.handler produced a traceback:\n{}'.format(event, format_exc())) 273 | finally: 274 | # TODO: fix return here to use non-blocking call 275 | return CallNextHookEx(self.keyboard_id, code, event_code, kb_data_ptr) 276 | 277 | keyboard_pointer = _callback_pointer(keyboard_low_level_handler) 278 | 279 | self.keyboard_id = SetWindowsHookExA(WH_KEYBOARD_LL, keyboard_pointer, 280 | GetModuleHandleA(None), 281 | 0) 282 | 283 | if self.mouse_is_hook: 284 | def mouse_low_level_handler(code, event_code, kb_data_ptr): 285 | """Used to catch and deal with mouse events""" 286 | current_key = MOUSE_ID_TO_KEY.get(event_code) # check the type of event (see MOUSE_ID_TO_KEY for a list) 287 | if current_key is None: 288 | event = None # We can check this later. 289 | if self.warn_unrecognised: 290 | warn('Unrecognised mouse ID %d.' % event_code) 291 | else: 292 | if current_key != 'Move': # if we aren't moving, then we deal with a mouse click 293 | event_type = MOUSE_ID_TO_EVENT_TYPE[event_code] 294 | # the first two members of kb_data_ptr hold the mouse position, x and y 295 | event = MouseEvent(current_key, event_type, kb_data_ptr[0], kb_data_ptr[1]) 296 | 297 | try: 298 | if event: 299 | self.handler(event) 300 | except Exception: 301 | warn('While handling {}, self.handler produced a traceback:\n{}'.format(event, format_exc())) 302 | finally: 303 | # TODO: fix return here to use non-blocking call 304 | return CallNextHookEx(self.mouse_id, code, event_code, kb_data_ptr) 305 | 306 | mouse_pointer = _callback_pointer(mouse_low_level_handler) 307 | self.mouse_id = SetWindowsHookExA(WH_MOUSE_LL, mouse_pointer, 308 | GetModuleHandleA(None), 0) 309 | 310 | atexit.register(UnhookWindowsHookEx, self.keyboard_id) 311 | atexit.register(UnhookWindowsHookEx, self.mouse_id) 312 | 313 | message = wintypes.MSG() 314 | while self.mouse_is_hook or self.keyboard_is_hook: 315 | msg = GetMessageW(byref(message), 0, 0, 0) 316 | if msg in [0, -1]: 317 | self.unhook_keyboard() 318 | self.unhook_mouse() 319 | break # Exit the loop. 320 | 321 | else: 322 | TranslateMessage(byref(message)) 323 | DispatchMessageW(byref(message)) 324 | 325 | def unhook_mouse(self): 326 | """Stop listening to the mouse""" 327 | if self.mouse_is_hook: 328 | self.mouse_is_hook = False 329 | UnhookWindowsHookEx(self.mouse_id) 330 | 331 | def unhook_keyboard(self): 332 | """Stop listening to the keyboard""" 333 | if self.keyboard_is_hook: 334 | self.keyboard_is_hook = False 335 | UnhookWindowsHookEx(self.keyboard_id) 336 | -------------------------------------------------------------------------------- /utils/special_keys.py: -------------------------------------------------------------------------------- 1 | listing = [ 2 | 9, # Tab 3 | 160, # Lshift 4 | 161, # Rshift 5 | 162, # Lcontrol 6 | 163, # Rcontrol 7 | 164, # Lmenu 8 | 165, # Rmenu 9 | ] 10 | --------------------------------------------------------------------------------