commit 2d03f9608e0c0ea8555af4e963c4c8341180fca4 Author: q Date: Mon Oct 17 00:09:05 2022 -0400 initial commit diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..55904b4 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,677 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . + +The above copyright notice, this permission notice and the word "NIGGER" shall be included in all copies or substantial portions of the Software. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0edbec2 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Matrix Morg Bully + +A Matrix bot that insults every matrix.org user that joins a room. + +## Dependencies +1. NodeJS +2. matrix-js-sdk + +## Quickstart +1. `git clone https://code.glowers.club/q/matrix-morg-bully.git` +2. `cd matrix-morg-bully` +3. `yarn add matrix-js-sdk` +4. (Edit example.js to use your desired matrix credentials and bot settings) +5. `node example.js` diff --git a/example.js b/example.js new file mode 100644 index 0000000..2abddf7 --- /dev/null +++ b/example.js @@ -0,0 +1,27 @@ +const sdk = require("matrix-js-sdk"); +const matrixcs = require("matrix-js-sdk/lib/matrix"); +const request = require('request'); +matrixcs.request(request); + +const startupTime = Date.now(); + +const myUserId = "@glowy:glowers.club" +const myAccessToken = "syt_TotallyMyRealAccessTokenAndNotAFake"; +const matrixClient = sdk.createClient({ + baseUrl: "https://glowers.club", + accessToken: myAccessToken, + userId: myUserId +}); + +const MorgBully = require('./index.js'); +const morgBully = new MorgBully(matrixClient); +morgBully.setBlacklistedRooms(["!crybabies:matrix.org", "!peoplewhocanttakeajoke:matrix.org"]); +morgBully.setInsults(["you're a dummy", "you're going to get banned", "I'll slap you with a fish"]); + +matrixClient.on("Room.timeline", function(event, room, toStartOfTimeline) { + if (event.getTs() >= startupTime && event.getType() == "m.room.member") { + morgBully.handleMembership(event, room); + } +}); + +matrixClient.startClient(); diff --git a/index.js b/index.js new file mode 100644 index 0000000..921ea5a --- /dev/null +++ b/index.js @@ -0,0 +1,732 @@ +function MorgBully(matrixClient) { + this.matrixClient = matrixClient; + this.insults = defaultInsults; + this.blacklistedRooms = []; +} + +MorgBully.prototype.setBlacklistedRooms = function(blacklistedRooms) { this.blacklistedRooms = blacklistedRooms; }; +MorgBully.prototype.setInsults = function(insults) { this.insults = insults; }; + +MorgBully.prototype.handleMembership = function(event, room) { + if (event.getContent().membership === "join" && event.getPrevContent().membership !== "join") { + + if (this.blacklistedRooms.indexOf(room.roomId) < 0 && event.getSender().endsWith(":matrix.org")) { + const insult = this.insults[Math.floor(Math.random() * this.insults.length)]; + var formattedBody = ""+event.getSender()+": Stop using matrix.org and switch to another homeserver or "+insult; + var body = event.getContent().displayname + ": Stop using matrix.org and switch to another homeserver or "+insult; + var content = { + "format": "org.matrix.custom.html", + "body": body, + "formatted_body": formattedBody, + "msgtype": "m.text" + }; + this.matrixClient.sendEvent(room.roomId, "m.room.message", content, "", (err, res) => { + if (err != null) { + console.error(err); + } + }); + } + } +} + +const defaultInsults = [ + "your mother will die in her sleep tonight", + "you're gay", + "you're a nigger", + "you're a kike", + "you're Jewish", + "you suck dick", + "you STINK", + "you're a retard nigger monkey", + "you're a coomer", + "kittens will die", + "everyone will know you're a homo", + "I'll kill you", + "you'll burn in Hell", + "you'll get raped", + "everyone will make fun of you", + "FUCK YOU", + "Jesus will frown upon you", + "you're a slut", + "you'll marry a whore and get divorced", + "you're an aberrant", + "you're an amateur", + "you're an animal", + "you're an anorak", + "you're an ape", + "you're an ape covered in human flesh", + "you're an apefucker", + "you're an arfarfan'arf", + "you're an arse", + "you're an arsebreath", + "you're an arsecunt", + "you're an arseface", + "you're an arsehole", + "you're an arse-licker", + "you're an ass", + "you're an assaholic", + "you're an assbutt", + "you're an ass clown", + "you're an asscunt", + "you're an assface", + "you're an assfag", + "you're an assfaggot", + "you're an assfucker", + "you're an asshat", + "you're an asshole", + "you're an ass-kisser", + "you're an ass-licker", + "you're an assmonkey", + "you're an assmouth", + "you're an assmunch", + "you're an ass-nugget", + "you're an ass sucker", + "you're an asstard", + "you're an asswagon", + "you're an assweed", + "you're an asswipe", + "you're an aunt fucker", + "you're a baby", + "you're a backwoodsman", + "you're a badass", + "you're a badgerfucker", + "you're a bag of dicks", + "you're a Bag whore", + "you're a ballkicker", + "you're a ballsack", + "you're a bandit", + "you're a bangsat", + "you're a barbarian", + "you're a Barbie-fucker", + "you're a bastard", + "you're a bean head", + "you're a beast", + "you're a beetlehead", + "you're a beginner", + "you're a beldame", + "you're a bell-end", + "you're a berk", + "you're a bespawler", + "you're a Beta cuck", + "you're a bimbo", + "you're a birdbrain", + "you're a birdfucker", + "you're a bitch", + "you're a bitchass", + "you're a bitch ass motherfucker", + "you're a bitch boy", + "you're a bitchcunt", + "you're a bitchdicksucker", + "you're a bitchface", + "you're a bitchfucker", + "you're a bitchtits", + "you're a bitchwad", + "you're a bitchwhore", + "you're a bitchzilla", + "you're a biznatch", + "you're a blackguard", + "you're a blaggard", + "you're a blockhead", + "you're a blubber gut", + "you're a bluntie", + "you're a bogeyman", + "you're a bonehead", + "you're a boob", + "you're a booby", + "you're a boomer", + "you're a bootlicker", + "you're a boozer", + "you're a boyfucker", + "you're a bozo", + "you're a brainlet", + "you're a brickfucker", + "you're a brickhead", + "you're a brotherfucker", + "you're a buffoon", + "you're a bugfucker", + "you're a bugger", + "you're a bullfuck", + "you're a bum", + "you're a bumbo", + "you're a bum chum", + "you're a bum-fucker", + "you're a burden", + "you're a buttass", + "you're a buttbreath", + "you're a buttfucker", + "you're a butthead", + "you're a butthole", + "you're a buttkisser", + "you're a buttlicker", + "you're a buttmunch", + "you're a butt sniffer", + "you're a Cad", + "you're a camelfucker", + "you're a catfucker", + "you're a caveman", + "you're a chauvinist", + "you're a chav", + "you're a cheater", + "you're a chicken", + "you're a chickenfucker", + "you're a childfucker", + "you're a chode", + "you're a chump", + "you're a churl", + "you're a clitbag", + "you're a clithead", + "you're a Clod", + "you're a clown", + "you're a cock", + "you're a cockalorum", + "you're a cockboy", + "you're a cockburger", + "you're a cockfucker", + "you're a cockhead", + "you're a cockholster", + "you're a cockmaster", + "you're a cockroach", + "you're a cocksucker", + "you're a cockwaddle", + "you're a cockweasel", + "you're a cockwomble", + "you're a coffee slurper", + "you're a con man", + "you're a con merchant", + "you're a coomer", + "you're a corpsefucker", + "you're a cougar", + "you're a country bumpkin", + "you're a cousinfucker", + "you're a cow", + "you're a coward", + "you're a cowfucker", + "you're a crackhead", + "you're a crack whore", + "you're a craphole", + "you're a creep", + "you're a cretin", + "you're a cro magnon", + "you're a crook", + "you're a cuckold", + "you're a cumbucket", + "you're a cum dumpster", + "you're a cum guzzler", + "you're a cum-licker", + "you're a cumslut", + "you're a cumstain", + "you're a cunt", + "you're a cuntass", + "you're a cuntbiscuit", + "you're a cuntbitch", + "you're a cuntbreath", + "you're a cuntface", + "you're a cunt fart", + "you're a cuntfucker", + "you're a cuntlicker", + "you're a cunt muncher", + "you're a cunt rag", + "you're a cuntshit", + "you're a cuntsucker", + "you're a cuntzilla", + "you're a dandiprat", + "you're a daughterfucker", + "you're a deadhead", + "you're a degenerate", + "you're a der-brain", + "you're a desperado", + "you're a devil", + "you're a dick", + "you're a dickass", + "you're a dickbag", + "you're a dickbreath", + "you're a dickcheese", + "you're a dickface", + "you're a dickfucker", + "you're a dickhead", + "you're a dickhole", + "you're a dickless", + "you're a dicklicker", + "you're a dick man", + "you're a dick mouth", + "you're a dick sniffer", + "you're a dicksplash", + "you're a dick-sucker", + "you're a dicktard", + "you're a dickwad", + "you're a dickweasel", + "you're a dick weed", + "you're a dildo", + "you're a dillhole", + "you're a dimmadumbass", + "you're a dimwit", + "you're a ding-head", + "you're a dingleberry", + "you're a dinosaur", + "you're a dipfuck", + "you're a dipshit", + "you're a dirtbag", + "you're a dirthead", + "you're a dirtwad", + "you're a dodo", + "you're a dog", + "you're a dogbolt", + "you're a dogbreath", + "you're a dogfucker", + "you're a dolt", + "you're a donkey", + "you're a donkey dick", + "you're a donkeyfucker", + "you're a doofus", + "you're a dope", + "you're a dotterel", + "you're a douche", + "you're a douche bag", + "you're a doucheburger", + "you're a douche canoe", + "you're a douchefag", + "you're a douchelord", + "you're a douche nozzle", + "you're a douchewad", + "you're a douchewagon", + "you're a dracula", + "you're a dreamer", + "you're a drunkard", + "you're a duckfucker", + "you're a dumbarse", + "you're a dumbass", + "you're a dumbbell", + "you're a dumb fucker", + "you're a dumbo", + "you're a dummy", + "you're a dunce", + "you're a duncebucket", + "you're a dweebling", + "you're an earthworm", + "you're an edgelord", + "you're an egghead", + "you're an egotist", + "you're an envirotard", + "you're a eunuch", + "you're a fag", + "you're a faggot", + "you're a faggotface", + "you're a fagtard", + "you're a fagtits", + "you're a failed abortion", + "you're a fanny", + "you're a farmer", + "you're a fart", + "you're a fartface", + "you're a fatass", + "you're a fatfuck", + "you're a fat geezer", + "you're a fatherfucker", + "you're a fatso", + "you're a fat-tard", + "you're a fatty", + "you're a fellow", + "you're a fetus", + "you're a fibber", + "you're a fink", + "you're a fish", + "you're a fish fucker", + "you're a fishwife", + "you're a fixer", + "you're a flake", + "you're a fool", + "you're a freak", + "you're a fruitcake", + "you're a fuck", + "you're a fuckass", + "you're a fuckbait", + "you're a fuckbucket", + "you're a fucker", + "you're a fuckface", + "you're a fuckhead", + "you're a fucking bitch", + "you're a fucklord", + "you're a fuck noggin", + "you're a fucknose", + "you're a fuck nugget", + "you're a fuckrod", + "you're a fuckshit", + "you're a fuckskull", + "you're a fuckstain", + "you're a fuckster", + "you're a fucktard", + "you're a fucktoy", + "you're a fuckweasel", + "you're a fuckwhistle", + "you're a fuckwit", + "you're a fugly", + "you're a gawk", + "you're a gaytard", + "you're a gaywad", + "you're a geebag", + "you're a gimp", + "you're a git", + "you're a gobshite", + "you're a gold digger", + "you're a goof", + "you're a goon", + "you're a goose", + "you're a gorilla", + "you're a grandmotherfucker", + "you're a greeniac", + "you're a grouch", + "you're a grumpy", + "you're a handfucker", + "you're a headass", + "you're a helldog", + "you're a hikikomori", + "you're a hilding", + "you're a hillbilly", + "you're a hippie", + "you're a ho", + "you're a hobbledehoy", + "you're a hoe", + "you're a hog", + "you're a homo", + "you're a hooligan", + "you're a hooplehead", + "you're a horsefucker", + "you're a horse's ass", + "you're a horse's necktie", + "you're a hosebag", + "you're a hussy", + "you're a hypocrite", + "you're an idiot", + "you're an idiotist", + "you're an idiot sandwich", + "you're an ignoramus", + "you're an imbecile", + "you're an inbred", + "you're an incel", + "you're an intercourser", + "you're a jabroni", + "you're a jackass", + "you're a jackhole", + "you're a jackwagon", + "you're a jagweed", + "you're a jamoke", + "you're a jelly", + "you're a jerk", + "you're a jerkoff", + "you're a jerkwad", + "you're a jit stain", + "you're a jizz guzzler", + "you're a joker", + "you're a junkie", + "you're a karen", + "you're a kevun", + "you're a keyboard warrior", + "you're a kidfucker", + "you're a klutz", + "you're a lady of the evening", + "you're a lamebrain", + "you're a landwhale", + "you're a langer", + "you're a lard face", + "you're a liar", + "you're a libtard", + "you're a lickspittle", + "you're a lobotomite", + "you're a loser", + "you're a louse", + "you're a low-life", + "you're a lunatic", + "you're a lunkhead", + "you're a lurdane", + "you're a lush", + "you're a mackerel", + "you're a madman", + "you're a maggot", + "you're a mamzer", + "you're a meanie", + "you're a megabitch", + "you're a megadouche", + "you're a mental midget", + "you're a milksop", + "you're a minx", + "you're a missing link", + "you're a mongoose", + "you're a monkey", + "you're a monkeyface", + "you're a monster", + "you're a mooncalf", + "you're a moron", + "you're a motherfucker", + "you're a mousefucker", + "you're a mouth breather", + "you're a Mr. Anger", + "you're a Mr. Obsessed", + "you're a Mr. Struggle", + "you're a Mr. Talk", + "you're a mucky pup", + "you're a mumpsimus", + "you're a muppet", + "you're a mutant", + "you're a mutt", + "you're a neanderthal", + "you're a neckbeard", + "you're a necrophiliac", + "you're a ne'er-do-well", + "you're a nephew fucker", + "you're a nerd", + "you're a nerf herder", + "you're a niece fucker", + "you're a nimrod", + "you're a nincompoop", + "you're a ninny", + "you're a ninnyhammer", + "you're a nitwit", + "you're a nobody", + "you're a non", + "you're a nonce", + "you're a noob", + "you're a noodle", + "you're a numbnuts", + "you're a numbskull", + "you're a numpty", + "you're a numskull", + "you're an oaf", + "you're an oddball", + "you're an ogre", + "you're an oompa loompa", + "you're an orphan", + "you're an outlaw", + "you're an oxygen thief", + "you're a pack", + "you're a pain in the ass", + "you're a pariah", + "you're a peasant", + "you're a pedo", + "you're a pedophile", + "you're a penchod", + "you're a pencil dick", + "you're a penis face", + "you're a penispuffer", + "you're a penis sucker", + "you're a pervert", + "you're a pig", + "you're a pigfucker", + "you're a piggy-wiggy", + "you're a pikspiller", + "you're a pillock", + "you're a pinhead", + "you're a pirate", + "you're a pissbrain", + "you're a pissbreath", + "you're a pissface", + "you're a pisshead", + "you're a pleb", + "you're a plonker", + "you're a pooface", + "you're a poohead", + "you're a poop hole", + "you're a porno freak", + "you're a potato", + "you're a prick", + "you're a prickface", + "you're a pseudo-intellectual", + "you're a pube flosser", + "you're a pudwhacker", + "you're a puke bag", + "you're a pukeball", + "you're a puppet", + "you're a pussy", + "you're a pussyboy", + "you're a pussyfucker", + "you're a pussy pisser", + "you're a quack", + "you're a quat", + "you're a queer", + "you're a queer bait", + "you're a querulant", + "you're a raasclaat", + "you're a rabbitfucker", + "you're a rat", + "you're a ratcatcher", + "you're a ratfink", + "you're a ratfucker", + "you're a redneck", + "you're a reject", + "you're a retard", + "you're a riff-raff", + "you're a roaster", + "you're a robot", + "you're a rowdy", + "you're a rudesby", + "you're a ruffian", + "you're a runt", + "you're a sadist", + "you're a Sam Rea", + "you're a saprophyte", + "you're a sausage-masseuse", + "you're a scobberlotcher", + "you're a scoozie", + "you're a scoundrel", + "you're a scumbag", + "you're a scumbreath", + "you're a scumbutt", + "you're a scumface", + "you're a scumfuck", + "you're a scumhead", + "you're a scumlord", + "you're a scumwad", + "you're a scuzzbag", + "you're a serf", + "you're a sewer rat", + "you're a shark", + "you're a sheepfucker", + "you're a sheepshagger", + "you're a shill", + "you're a shitass", + "you're a shitbag", + "you're a shitball", + "you're a shitbird", + "you're a shitbrain", + "you're a shitbreath", + "you're a shitbucket", + "you're a shitbum", + "you're a shitcunt", + "you're a shitdick", + "you're a shit-eater", + "you're a shitehawk", + "you're a shitface", + "you're a shit-for-brains", + "you're a shitfuck", + "you're a shitfucker", + "you're a shitgoblin", + "you're a shithead", + "you're a shitizen", + "you're a shitlord", + "you're a shitneck", + "you're a shitnugget", + "you're a shitpicker", + "you're a shitpiss", + "you're a shitpot", + "you're a shitpuddle", + "you're a shitsack", + "you're a shit stain", + "you're a shitter", + "you're a shitweasel", + "you're a shmekl", + "you're a shrew", + "you're a shyster", + "you're a sibling fucker", + "you're a simp", + "you're a simpleton", + "you're a sisterfucker", + "you're a sister humper", + "you're a skank", + "you're a sket", + "you're a skite", + "you're a skullfucker", + "you're a skunk", + "you're a skunkfucker", + "you're a slag", + "you're a slave", + "you're a sleazewad", + "you're a sleeze", + "you're a sleeze bag", + "you're a slimeface", + "you're a slob", + "you're a slut", + "you're a slutfucker", + "you're a sluthead", + "you're a smell-feast", + "you're a smellfungus", + "you're a snail", + "you're a snake", + "you're a snob", + "you're a snollygoster", + "you're a snot", + "you're a snotball", + "you're a snotface", + "you're a snothead", + "you're a snotwad", + "you're a snowflake", + "you're a son of a bitch", + "you're a son of a motherless goat", + "you're a son of a whore", + "you're a sow", + "you're a soy boy", + "you're a spack", + "you're a sped", + "you're a sphincter", + "you're a splenetic", + "you're a square", + "you're a stink cunt", + "you're a stinker", + "you're a stinkhole", + "you're a straggot", + "you're a stupid", + "you're a swindler", + "you're a swine", + "you're a sycophant", + "you're a thief", + "you're a thotpocket", + "you're a thundercunt", + "you're a titbag", + "you're a toad", + "you're a Toe Eyed Cabbage", + "you're a tomato", + "you're a tool", + "you're a tree hugger", + "you're a troglodyte", + "you're a troll", + "you're a trollface", + "you're a trolltard", + "you're a turd", + "you're a turdball", + "you're a turdbucket", + "you're a turdpile", + "you're a twat", + "you're a twattock", + "you're a twatwaffle", + "you're a twerp", + "you're a twit", + "you're a twunt", + "you're a unclefucker", + "you're a vagina cleaner", + "you're a vampire", + "you're a vandal", + "you're a vantz", + "you're a varmint", + "you're a vermin", + "you're a vonce", + "you're a wacko", + "you're a wallflower", + "you're a wally", + "you're a wanker", + "you're a wank stain", + "you're a Wazzock", + "you're a weeze bag", + "you're a weirdo", + "you're a whore", + "you're a whorefucker", + "you're a whore's-bird", + "you're a whoreson", + "you're a windfucker", + "you're a windsucker", + "you're a wino", + "you're a witch", + "you're a womanizer", + "you're a wommy", + "you're a worm", + "you're a wretch", + "you're a xenophobe", + "you're a yahoo", + "you're a yes-man", + "you're a yiffer", + "you're a yonker", + "you're a yutz", + "you're a zebrafucker", + "you're a zitface", + "you're a zoophile", + "you're a zounderkite" +]; + +module.exports = MorgBully;