commit 86825dd6e539d2d907f5038925d6bf011e67675a Author: omicron Date: Wed Mar 15 17:13:01 2023 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..67e07b8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/build +/release diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +### 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 . diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..9374e1d --- /dev/null +++ b/Makefile @@ -0,0 +1,31 @@ +.PHONY: all build clean release release-zip release-tar + +BUILD_DIR := ./build +RELEASE_DIR := ./release +SRC_DIR := ./src +MEDIA_DIR := ./media + +all: release-zip release-tar + + +release: build + mkdir -p $(RELEASE_DIR) + +build: clean + mkdir -p $(BUILD_DIR) + cp -r $(SRC_DIR) $(BUILD_DIR)/OmicronFrames + mkdir -p $(BUILD_DIR)/OmicronFrames/media/textures + cp -r $(MEDIA_DIR)/textures/*.tga $(BUILD_DIR)/OmicronFrames/media/textures/ + #cp -r $(MEDIA_DIR)/fonts $(BUILD_DIR)/OmicronFrames/media/fonts + cp LICENSE.md $(BUILD_DIR)/OmicronFrames/ + #cp CHANGELOG.md $(BUILD_DIR)/OmicronFrames/ + +release-zip: release + 7z a -tzip $(RELEASE_DIR)/omicronframes.zip -w $(BUILD_DIR)/. + +release-tar: release + tar -cJf $(RELEASE_DIR)/omicronframes.tar.xz -C $(BUILD_DIR) OmicronFrames + tar -czf $(RELEASE_DIR)/omicronframes.tar.gz -C $(BUILD_DIR) OmicronFrames + +clean: + rm -rf $(BUILD_DIR) $(RELEASE_DIR) diff --git a/devloop b/devloop new file mode 100755 index 0000000..e60727c --- /dev/null +++ b/devloop @@ -0,0 +1,24 @@ +#!/usr/bin/bash + +if [[ $# -ne 1 ]]; then + echo "Usage: ${0} " + exit 1 +fi +WOW_ADDON_DIR="${1}" + +if [[ ! -d "${WOW_ADDON_DIR}" ]]; then + echo "The directory does not exist. Please pass the correct addon directory." + exit 1 +fi + +# Every time the source or texture directory tree is changed, wait 1 second and +# build the addon, then install it to the directory passed on the command line +while true; do + inotifywait -qq -e modify,create,delete,move -r ./src ./media + sleep 1 + echo $(date) Source changed. Building... + make -s build + echo $(date) Installing changes... + rsync -q -a ./build/OmicronFrames "${WOW_ADDON_DIR}/" --delete + echo $(date) Done. +done diff --git a/media/textures/bar_subtle_diagonal.tga b/media/textures/bar_subtle_diagonal.tga new file mode 100644 index 0000000..c9accda Binary files /dev/null and b/media/textures/bar_subtle_diagonal.tga differ diff --git a/media/textures/square_a.tga b/media/textures/square_a.tga new file mode 100644 index 0000000..7a1b635 Binary files /dev/null and b/media/textures/square_a.tga differ diff --git a/media/textures/square_b.tga b/media/textures/square_b.tga new file mode 100644 index 0000000..473ce1c Binary files /dev/null and b/media/textures/square_b.tga differ diff --git a/src/OmicronFrames.toc b/src/OmicronFrames.toc new file mode 100644 index 0000000..0132cd8 --- /dev/null +++ b/src/OmicronFrames.toc @@ -0,0 +1,19 @@ +## Interface: 100002 +## Title: Omicron Frames +## Notes: Frames that work for me +## SavedVariables: OmicronFramesDB +## Version: 0.1.0-alpha + +main.lua + +types/types.lua +types/object.lua +types/trigger.lua +types/statusbar.lua +types/auralist.lua +types/indicator.lua +types/unitframe.lua + +frames.lua + +init.lua diff --git a/src/frames.lua b/src/frames.lua new file mode 100644 index 0000000..7c81182 --- /dev/null +++ b/src/frames.lua @@ -0,0 +1,76 @@ +-- Copyright 2023 +-- +-- This file is part of Omicron Frames +-- +-- Omicron Frames 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. +-- +-- Omicron Frames 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 +-- Omicron Frames. If not, see . +local omif = select(2, ...) + +local UnitFrame = omif.GetModule("types").UnitFrame +local frames = omif.GetModule("frames") + +-- re-parent all blizzard frames and then hide the new parent +function HideBlizzardFrames() + local toggleFrame = CreateFrame("Frame", nil, UIParent) + + blizzardFrames = { + PlayerFrame, + TargetFrame, + FocusFrame, + PartyFrame, + CompactRaidFrameContainer + } + + for _, frame in ipairs(blizzardFrames) do + frame:SetParent(toggleFrame) + end + + toggleFrame:Hide() +end + +function CreateRaidFrames(left, top, width, height) + for i=0,5 do + for j=0,4 do + local num = i*5 + j + 1 + local frame = UnitFrame:new("raid" .. num, width, height) + frame:SetPosition(left + (j-2)*width, top - i*height) + end + end + + local player = UnitFrame:new("player", width, height) + player:SetPosition(left-3*width - 50, top) + local target = UnitFrame:new("target", width, height) + target:SetPosition(left+3*width + 50, top) +end + +function CreatePartyFrames(left, top, width, height) + local player = UnitFrame:new("player", width, height) + player:SetPosition(-2*width, top) + for i=1,4 do + local frame = UnitFrame:new("party" .. i, width, height) + frame:SetPosition((i-2)*width, top) + end + + local target = UnitFrame:new("target", width, height) + target:SetPosition(3*width + 50, top) + local focus = UnitFrame:new("focus", width, height) + focus:SetPosition(3*width + 50, top - height) +end + +function CreateFrames() + CreatePartyFrames(0, -290, 110, 45) + --CreateRaidFrames(-850, 400, 110, 45) + --CreateRaidFrames(0, -290, 100, 45) + HideBlizzardFrames() +end +omif.SetEventHandler("OMICRON_LOADING", CreateFrames) diff --git a/src/init.lua b/src/init.lua new file mode 100644 index 0000000..3cfa0ca --- /dev/null +++ b/src/init.lua @@ -0,0 +1,28 @@ +-- Copyright 2023 +-- +-- This file is part of Omicron Frames +-- +-- Omicron Frames 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. +-- +-- Omicron Frames 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 +-- Omicron Frames. If not, see . +local omif = select(2, ...) + +-- Run all functions that start with Setup +local function RunSetupFunctions() + for k, v in pairs(omif) do + if string.sub(k, 1, 5) == "Setup" then + v() + end + end +end + +RunSetupFunctions() diff --git a/src/main.lua b/src/main.lua new file mode 100644 index 0000000..2ee039a --- /dev/null +++ b/src/main.lua @@ -0,0 +1,87 @@ +-- Copyright 2023 +-- +-- This file is part of Omicron Frames +-- +-- Omicron Frames 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. +-- +-- Omicron Frames 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 +-- Omicron Frames. If not, see . +local AddonName, omif = ... +omif.events = {} -- event (str) to list of handlers +omif.db = nil + +omif.modules = {} +-- Simple function that creates or returns a local module table +function omif.GetModule(name) + if omif.modules[name] == nil then + omif.modules[name] = {} + end + return omif.modules[name] +end + +-- Adds a given function to the event handler list for a given event +-- This will later in the addon +function omif.SetEventHandler(event, fn) + if omif.events[event] == nil then + omif.events[event] = {} + end + table.insert(omif.events[event], fn) +end + +-- The main handler receives basically every single event we want to listen to +-- and dispatches them to more appropriate handlers +function omif.MainEventHandler(frame, event, ...) + local handlers = omif.events[event] + if handlers ~= nil and next(handlers) ~= nil then + for i, handler in ipairs(handlers) do + handler(...) + end + end +end + +-- Create the event frame and register all desired events +function omif.SetupEvents() + local frame = CreateFrame("Frame") + for name, _ in pairs(omif.events) do + if string.sub(name, 1, string.len("OMICRON")) ~= "OMICRON" then + frame:RegisterEvent(name) + end + end + frame:SetScript("OnEvent", omif.MainEventHandler) +end + +function omif.OnAddonLoaded(name) + if name ~= AddonName then + return + end + omif.MainEventHandler(nil, "OMICRON_LOADING") + print("Loaded", AddonName) +end +omif.SetEventHandler("ADDON_LOADED", omif.OnAddonLoaded) + +-- Fire custom event OMICRON_FULLY_LOADED. This event is fired when the player +-- enters the world for the first time after logging in or reloading UI. +function omif.FireFullyLoadedEvent(initialLogin, reloadUI) + if initialLogin or reloadUI then + omif.MainEventHandler(nil, "OMICRON_FULLY_LOADED") + end +end +omif.SetEventHandler("PLAYER_ENTERING_WORLD", omif.FireFullyLoadedEvent) + +function omif.SlashCommand(args) + omif.cli.ToggleShow() +end + +function omif.SetupSlashCommands() + _G["SLASH_OMICRON1"] = "/omicronframes" + _G["SLASH_OMICRON2"] = "/omi" + SlashCmdList["OMICRON"] = omif.SlashCommand +end diff --git a/src/types/auralist.lua b/src/types/auralist.lua new file mode 100644 index 0000000..e385588 --- /dev/null +++ b/src/types/auralist.lua @@ -0,0 +1,200 @@ +-- Copyright 2023 +-- +-- This file is part of Omicron Frames +-- +-- Omicron Frames 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. +-- +-- Omicron Frames 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 +-- Omicron Frames. If not, see . +local omi = select(2, ...) +local types = omi.GetModule("types") +local AuraTrigger = types.AuraTrigger + +local AuraList = types.CreateClass("AuraList") +types.AuraList = AuraList + +local statusLists = { + Immune = { + [642] = true, -- Divine Shield, Paladin + [186265] = true -- Aspect of the Turtle, Hunter + }, + Bomb = { + [642] = true, -- Divine Shield, Paladin + [186265] = true, -- Aspect of the Turtle, Hunter + [381615] = true, -- Raszageth, Static Charge + [377467] = true -- Raszageth, Fulminating Charge + }, + Burn = { + [642] = true, -- Divine Shield, Paladin + [186265] = true -- Aspect of the Turtle, Hunter + } +} + +local function ForEachAuraSlots(unit, fn, continuationToken, ...) + local GetAuraDataBySlot = C_UnitAuras.GetAuraDataBySlot + local n = select('#', ...) + for i=1, n do + local slot = select(i, ...) + fn(GetAuraDataBySlot(unit, slot)) + end + return continuationToken +end + +local function ForEachAuraFiltered(unit, filter, fn) + local UnitAuraSlots = UnitAuraSlots + local continuationToken = nil + repeat + continuationToken = ForEachAuraSlots(unit, fn, UnitAuraSlots(unit, filter, nil, continuationToken)) + until (continuationToken == nil) +end + +-- Similar to what AuraUtils.ForEachAura does except the callback fn takes a +-- UnitAuraInfo structure rather than individual arguments +local function ForEachAura(unit, fn) + ForEachAuraFiltered(unit, "HELPFUL", fn) + ForEachAuraFiltered(unit, "HARMFUL", fn) +end + +function AuraList:Init(unitframe) + self.unitframe = unitframe + self.unit = unitframe.unit + + self.statusCount = {} + self.auras = {} -- map AuraInstanceID to UnitAuraInfo table + + + self.triggers = {} + self.triggersBySpell = {} +end + + +function AuraList:AddTrigger(trigger) + table.insert(self.triggers, trigger) + if trigger:IsInstanceOf(AuraTrigger) then + local spellId = trigger.spellId + if self.triggersBySpell[spellId] == nil then + self.triggersBySpell[spellId] = {} + end + table.insert(self.triggersBySpell[spellId], trigger) + end +end + +-- Scan all the auras of the owning unit and build the aura list from scratch +-- This should only ever happen when the unit is first assigned to the frame +function AuraList:Reset() + self.auras = {} + + self.statusCount = {} + + for _, trigger in ipairs(self.triggers) do + trigger:Reset() + end + + ForEachAura(self.unit, function(aura) + self:AddAura(aura) + end) +end + +function AuraList:AddAura(aura) + local statusChanged = false + self.auras[aura.auraInstanceID] = aura + + -- Update status counts associated with this aura + local count = self.statusCount + for _, status in ipairs(self:GetStatusForAura(aura)) do + if not count[status] then + count[status] = 1 + statusChanged = true + else + count[status] = count[status] + 1 + end + end + + for _, trigger in ipairs(self.triggersBySpell[aura.spellId] or {}) do + trigger:AddAura(aura) + end + + -- Update triggers associated with this aura + return statusChanged +end + +-- Returns a table with every status that applies to the given aura +function AuraList:GetStatusForAura(aura) + local status = {} + if aura.dispelName and aura.isHarmful then + table.insert(status, aura.dispelName) + end + for statusName, auraIds in pairs(statusLists) do + if auraIds[aura.spellId] then + table.insert(status, statusName) + end + end + return status +end + +function AuraList:UpdateAura(aura) + for _, trigger in ipairs(self.triggersBySpell[aura.spellId] or {}) do + trigger:UpdateAura(self.auras[aura.auraInstanceId], aura) + end + self.auras[aura.auraInstanceID] = aura +end + +function AuraList:RemoveAura(iid) + local aura = self.auras[iid] + if aura == nil then + -- FIXME: Why does this happen? Are we actually missing important auras? + return false + end + self.auras[iid] = nil + + local statusChanged = false + local count = self.statusCount + for _, status in ipairs(self:GetStatusForAura(aura)) do + if not count[status] then + print("Removed a status that we didn't already have...?", status, aura.spellId) + elseif count[status] == 1 then + count[status] = nil + statusChanged = true + else + count[status] = count[status] - 1 + end + end + + for _, trigger in ipairs(self.triggersBySpell[aura.spellId] or {}) do + trigger:RemoveAura(aura) + end + return statusChanged +end + +function AuraList:Update(info) + local GetAuraDataByAuraInstanceID = C_UnitAuras.GetAuraDataByAuraInstanceID + local statusChanged = false + for _, aura in ipairs(info.addedAuras or {}) do + if self:AddAura(aura) then + statusChanged = true + end + end + + for _, iid in ipairs(info.updatedAuraInstanceIDs or {}) do + local aura = GetAuraDataByAuraInstanceID(self.unit, iid) + -- FIXME: Why can aura be nil? Are we actually missing important auras? + if aura ~= nil then + self:UpdateAura(aura) + end + end + + for _, iid in ipairs(info.removedAuraInstanceIDs or {}) do + if self:RemoveAura(iid) then + statusChanged = true + end + end + return statusChanged +end diff --git a/src/types/indicator.lua b/src/types/indicator.lua new file mode 100644 index 0000000..107299f --- /dev/null +++ b/src/types/indicator.lua @@ -0,0 +1,61 @@ +-- Copyright 2023 +-- +-- This file is part of Omicron Frames +-- +-- Omicron Frames 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. +-- +-- Omicron Frames 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 +-- Omicron Frames. If not, see . +local omi = select(2, ...) +local types = omi.GetModule("types") +local AuraTrigger = types.AuraTrigger + +local Indicator = types.CreateClass("Indicator") +types.Indicator = Indicator + +-- TODO: make different indicators, such as texture, text, border +-- TODO: spellid feels out of place but I wanna quickly get something for now. +-- Should rethink this when Trigger is its own class +function Indicator:Init(unitframe, auralist, size, point, x, y, color, spellId) + local frame = unitframe.overlays + + local texture = frame:CreateTexture(nil, "ARTWORK") + self.texture = texture + texture:Hide() + texture:SetTexture("Interface\\Addons\\OmicronFrames\\media\\textures\\square_b") + texture:SetSize(size, size) + texture:SetPoint(point, x, y) + self:SetColor(color) + texture:SetVertexColor(unpack(color)) + texture:SetDrawLayer("ARTWORK") + + local fn = function(activate) + if activate then + self:Show() + else + self:Hide() + end + end + local trigger = AuraTrigger:new(fn, spellId, true) + auralist:AddTrigger(trigger) +end + +function Indicator:SetColor(color) + self.texture:SetVertexColor(unpack(color)) +end + +function Indicator:Show() + self.texture:Show() +end + +function Indicator:Hide() + self.texture:Hide() +end diff --git a/src/types/object.lua b/src/types/object.lua new file mode 100644 index 0000000..35b226c --- /dev/null +++ b/src/types/object.lua @@ -0,0 +1,53 @@ +-- Copyright 2023 +-- +-- This file is part of Omicron Frames +-- +-- Omicron Frames 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. +-- +-- Omicron Frames 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 +-- Omicron Frames. If not, see . +local omi = select(2, ...) +local Object = omi.GetModule("types").Object +local IsDerivedFrom = omi.GetModule("types").IsDerivedFrom + +-- Create a new instance of Object or (more likely) any inheriting class +function Object.new(class, ...) + local o = {} + setmetatable(o, class) + + if o.Init ~= nil then + o:Init(...) + end + return o +end + +-- Returns true if the Object is a class, false if it is an instance object +function Object.IsClassObject(self) + return self.__typeInfo.class == self +end + +-- Returns true if the Object is an instance, false if it is a class +function Object.IsInstanceObject(self) + return self.__typeInfo.class ~= self +end + +-- return true if this object is an instance of the given class +function Object:IsInstanceOf(class) + if not self:IsInstanceObject() or not class:IsClassObject() then + return false + end + return IsDerivedFrom(self:GetClass(), class) +end + +-- Return the class of any object +function Object.GetClass(self) + return self.__typeInfo.class +end diff --git a/src/types/statusbar.lua b/src/types/statusbar.lua new file mode 100644 index 0000000..1393689 --- /dev/null +++ b/src/types/statusbar.lua @@ -0,0 +1,71 @@ +-- Copyright 2023 +-- +-- This file is part of Omicron Frames +-- +-- Omicron Frames 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. +-- +-- Omicron Frames 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 +-- Omicron Frames. If not, see . +local omi = select(2, ...) +local types = omi.GetModule("types") + +types.StatusBar = types.CreateClass("StatusBar") +local StatusBar = types.StatusBar + +function StatusBar:Init(parent, width, height) + -- parent: the parent frame + -- pct: nil if no percent value is shown, otherwise "left", "right" or "center" + -- value: nil if no value is shown, otherwise "left", "right" or "center" + -- text: nil if no text is shown, otherwise "left", "right" or "center" + -- stack: another StatusBar we will stack under + self.parent = parent + + local parentFrame = parent.secureFrame + local bar = CreateFrame("StatusBar", nil, parentFrame) + bar:SetFrameStrata("MEDIUM") + bar:SetFrameLevel(10) + bar:SetPoint("TOPLEFT", parentFrame, "TOPLEFT", 0, 0) + + bar:SetSize(width, height) + bar:SetStatusBarTexture("Interface\\Addons\\OmicronFrames\\media\\textures\\bar_subtle_diagonal") + bar:GetStatusBarTexture():SetHorizTile(false) + bar:GetStatusBarTexture():SetVertTile(false) + self.bar = bar + + local bg = bar:CreateTexture(nil, "BACKGROUND") + bg:SetTexture("Interface\\Addons\\OmicronFrames\\media\\textures\\bar_subtle_diagonal") + bg:SetAllPoints(true) + self.bg = bg + + self:SetRange(0, 1) + self:SetValue(1) + bar:Show() +end + +function StatusBar:SetRange(min, max) + self.bar:SetMinMaxValues(min, max) +end + +function StatusBar:SetValue(value) + self.bar:SetValue(value) +end + +function StatusBar:SetInterpolatedColor(start, stop, progress) + local r = start[1] + (stop[1] - start[1])*progress + local g = start[2] + (stop[2] - start[2])*progress + local b = start[3] + (stop[3] - start[3])*progress + self:SetColor(r, g, b) +end + +function StatusBar:SetColor(r, g, b) + self.bar:SetStatusBarColor(r, g, b) + self.bg:SetVertexColor(0.2*r, 0.2*g, 0.2*b) +end diff --git a/src/types/trigger.lua b/src/types/trigger.lua new file mode 100644 index 0000000..72c39df --- /dev/null +++ b/src/types/trigger.lua @@ -0,0 +1,136 @@ +-- Copyright 2023 +-- +-- This file is part of Omicron Frames +-- +-- Omicron Frames 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. +-- +-- Omicron Frames 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 +-- Omicron Frames. If not, see . +local omi = select(2, ...) +local types = omi.GetModule("types") + +types.Trigger = types.CreateClass("Trigger") +local Trigger = types.Trigger + + +-- Constructor for Trigger. +-- fn: +-- The callback function that gets called every time this trigger changes +-- states between active and inactive. Function takes one boolean argument. +function Trigger:Init(fn) + self.fn = fn +end + +-- Returns whether the trigger is active +function Trigger:IsActive() + return false +end + +-- Reset the trigger to the default state. Does run the untrigger callback if +-- the trigger is active when Reset is called. +function Trigger:Reset() +end + + +types.AuraTrigger = types.CreateClass("AuraTrigger", Trigger) +local AuraTrigger = types.AuraTrigger + +-- Constructor for AuraTrigger +-- fn: +-- The callback function that gets called every time this trigger changes +-- states between active and inactive. Function takes one boolean argument. +-- +-- requiredCount = 1: +-- The minimum number of conditions that must be met before the trigger +-- activates. What exactly this means depends on the trigger, examples are +-- # of matching auras, # of stacks. +-- +-- invert = false: +-- If the trigger is inverted it will activate when count < requiredCount. +-- If the trigger is not inverted it will activate when count >= requiredCount. +function AuraTrigger:Init(fn, spellId, own, requiredCount, invert) + Trigger.Init(self, fn) + self.spellId = spellId + self.requiredCount = requiredCount or 1 + self.own = own + self.count = 0 + self.invert = invert or false +end + +-- Reset the trigger to the default state. Does run the untrigger callback if +-- the trigger is active when it is called +function AuraTrigger:Reset() + local before = self:IsActive() + self.count = 0 + local after = self:IsActive() + if before ~= after then + self.fn(after) + end +end + +-- Return true if the aura matches the trigger +-- aura: +-- Must be a valid UnitAuraInfo structure. +function AuraTrigger:IsMatching(aura) + if aura.spellId ~= aura.spellId then + return false + end + if self.own and aura.sourceUnit ~= "player" then + return false + end + return true +end + +-- Inform the trigger about an added aura +-- aura: +-- Must be a valid UnitAuraInfo +function AuraTrigger:AddAura(aura) + if not self:IsMatching(aura) then + return + end + self.count = self.count + 1 + + -- Be mindful, this works only if count always changes by 1. + if self.count == self.requiredCount then + self.fn(not self.invert) + end +end + +-- Inform the trigger about an updated aura +-- before: +-- Must be a valid UnitAuraInfo for the aura before the update +-- after: +-- Must be a valid UnitAuraInfo for the aura after the update +function AuraTrigger:UpdateAura(before, after) + -- +end + +-- Inform the trigger about an aura that got removed +-- Must be a valid UnitAuraInfo for the aura before it got removed +function AuraTrigger:RemoveAura(aura) + if not self:IsMatching(aura) then + return + end + self.count = self.count - 1 + -- Be mindful, this works only if count always changes by 1. + if self.count == self.requiredCount - 1 then + self.fn(self.invert) + end +end + +-- Returns true if the trigger is active, false otherwise +function AuraTrigger:IsActive() + if self.invert then + return self.count < self.requiredCount + else + return self.count >= self.requiredCount + end +end diff --git a/src/types/types.lua b/src/types/types.lua new file mode 100644 index 0000000..d90f1e3 --- /dev/null +++ b/src/types/types.lua @@ -0,0 +1,53 @@ +-- Copyright 2023 +-- +-- This file is part of Omicron Frames +-- +-- Omicron Frames 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. +-- +-- Omicron Frames 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 +-- Omicron Frames. If not, see . +local omif = select(2, ...) + +local types = omif.GetModule("types") + +-- Create any class, possibly top level +local function CreateClassRaw(name, parent) + local c = {} + c.__typeInfo = { + name = name, + class = c, + parent = parent + } + c.__index = c + if parent ~= nil then + setmetatable(c, parent) + end + return c +end + +types.Object = CreateClassRaw("Object") + +-- Create a new class, eventually rooted at Object +function types.CreateClass(name, parent) + return CreateClassRaw(name, parent or types.Object) +end + +-- Return true if a is derived from b or if a is b +function types.IsDerivedFrom(a, b) + local current = a + repeat + if current == b then + return true + end + current = current.__typeInfo.parent + until current == nil; + return false +end diff --git a/src/types/unitframe.lua b/src/types/unitframe.lua new file mode 100644 index 0000000..fe0dbf6 --- /dev/null +++ b/src/types/unitframe.lua @@ -0,0 +1,396 @@ +-- Copyright 2023 +-- +-- This file is part of Omicron Frames +-- +-- Omicron Frames 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. +-- +-- Omicron Frames 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 +-- Omicron Frames. If not, see . +local omif = select(2, ...) +local types = omif.GetModule("types") +local StatusBar = types.StatusBar +local AuraList = types.AuraList +local Indicator = types.Indicator + +types.UnitFrame = types.CreateClass("UnitFrame") +local UnitFrame = types.UnitFrame + + +local colors = { + hostile = {0.5, 0.0, 0.0}, + neutral = {0.7, 0.7, 0.0}, + healthy = {0, 0.1, 0}, + high = {0, 1.0, 0}, + mid = {1.0, 1.0, 0}, + low = {1.0, 0.0, 0}, + offline = {0.7, 0.7, 0.7}, + dead = {0.7, 0.7, 0.7}, + magic = {0.4, 0.4, 1.0}, + disease = {0.4, 0.2, 0.0}, + poison = {0.0, 0.7, 0.7}, + curse = {0.7, 0.0, 0.7}, + immune = {0.0, 0.2, 0.4}, + bomb = {1.0, 0.7, 0.7}, + cyan = {0.0, 0.8, 0.8}, + white = {1.0, 1.0, 1.0} +} + +function UnitFrame:Init(unit, width, height) + self.unit = unit + local secure = self:CreateSecureFrame(width, height) + secure:Hide() + self.hp = StatusBar:new(self, width, height) + self.auras = AuraList:new(self) + local overlays = CreateFrame("Frame", nil, secure) + overlays:SetFrameStrata("MEDIUM") + overlays:SetFrameLevel(100) + overlays:SetAllPoints(true) + overlays:Show() + self.overlays = overlays + self.indicators = { + Indicator:new(self, self.auras, 14, "TOPLEFT", 2, -2, colors.white, 383648), + Indicator:new(self, self.auras, 14, "TOPLEFT", 2, -2, colors.white, 974), + Indicator:new(self, self.auras, 14, "BOTTOMLEFT", 2, 2, colors.cyan, 61295) + } + self:RegisterEvents() + self:Enable() +end + +function UnitFrame:StartRangeTicker() + if self.rangeTicker then + return + end + local delta = 0.45 + (fastrandom(0, 100)/1000) + self.rangeTicker = C_Timer.NewTicker(delta, function() + self:UpdateRange() + end) +end + +function UnitFrame:StopRangeTicker() + if self.rangeTicker then + self.rangeTicker:Cancel() + self.rangeTicker = nil + end +end + +function UnitFrame:UpdateRange() + local unit = self.unit + if not UnitIsFriend("player", unit) and IsSpellInRange("Lightning Bolt", unit) ~= 1 then + self.secureFrame:SetAlpha(0.2) + elseif UnitIsFriend("player", unit) and IsSpellInRange("Healing Surge", unit) ~= 1 then + self.secureFrame:SetAlpha(0.2) + else + self.secureFrame:SetAlpha(1.0) + end +end + +function UnitFrame:SetSpellAction(button, spell) + local secure = self.secureFrame + local attributeName = button:gsub("type", "spell") + + secure:SetAttribute(button, "spell") + secure:SetAttribute(attributeName, spell) +end + +function UnitFrame:SetMacroAction(button, macro) + local secure = self.secureFrame + local attributeName = button:gsub("type", "macrotext") + + secure:SetAttribute(button, "macro") + secure:SetAttribute(attributeName, macro:gsub("@UNIT", "@" .. self.unit)) +end + +function UnitFrame:PrepareWheelBinds() + -- By default you can't use the SecureUnitButtonTemplate to handle scroll + -- wheel "clicks". We solve this by using SecureHandler*Template to bind + -- scroll wheel to the current unit frame button when the mouse enters and + -- to unbind it when the mouse leaves. When the keybind is triggered the + -- button will receive a click with a custom button name + + local secure = self.secureFrame + local bindScript = ([[ + self:ClearBindings() + self:SetBindingClick(false, "MOUSEWHEELUP", "BUTTONNAME", "wheel-up") + self:SetBindingClick(false, "MOUSEWHEELDOWN", "BUTTONNAME", "wheel-down") + self:SetBindingClick(false, "ALT-MOUSEWHEELUP", "BUTTONNAME", "alt-wheel-up") + self:SetBindingClick(false, "ALT-MOUSEWHEELDOWN", "BUTTONNAME", "alt-wheel-down") + ]]):gsub("BUTTONNAME", "OmicronSecureFrame" .. self.unit) + + local removeBindScript = [[ + self:ClearBindings() + ]] + secure:SetAttribute("_onenter", bindScript) + secure:SetAttribute("_onleave", removeBindScript) + secure:SetAttribute("_onshow", removeBindScript) + secure:SetAttribute("_onhide", removeBindScript) +end + +function UnitFrame:CreateSecureFrame(width, height) + local name = "OmicronSecureFrame" .. self.unit + local templates = table.concat({ + "SecureUnitButtonTemplate", + "SecureHandlerEnterLeaveTemplate", + "SecureHandlerShowHideTemplate", + }, ",") + local secure = CreateFrame("Button", name, UIParent, templates) + self.secureFrame = secure + secure:SetFrameStrata("MEDIUM") + secure:SetFrameLevel(0) + secure:SetAttribute("unit", self.unit) + + secure:SetSize(width, height) + + secure:RegisterForClicks("AnyDown") + self:PrepareWheelBinds() + + -- No modifiers + secure:SetAttribute("type1", "target") + self:SetMacroAction("type2", "/use [@UNIT,dead,help]Ancestral Vision; [@UNIT]Chain Heal") + self:SetMacroAction("type3", "/use [@UNIT,dead,help]Ancestral Spirit; [@UNIT]Purify Spirit") + self:SetMacroAction("type-wheel-up", "/use [@UNIT]Healing Surge") + self:SetMacroAction("type-wheel-down", "/use [@UNIT,help]Riptide") + + -- alt + self:SetSpellAction("type-alt-wheel-up", "Healing Wave") + self:SetSpellAction("type-alt-wheel-down", "Earth Shield") + + -- Shift + secure:SetAttribute("SHIFT-type2", "menu") + + + if self.unit == "player" then + secure.menu = function(self) + ToggleDropDownMenu(1, nil, PlayerFrameDropDown, "cursor", 0 ,0) + end + elseif self.unit == "target" then + secure.menu = function(self) + ToggleDropDownMenu(1, nil, TargetFrameDropDown, "cursor", 0 ,0) + end + elseif self.unit == "focus" then + secure.menu = function(self) + ToggleDropDownMenu(1, nil, FocusFrameDropDown, "cursor", 0 ,0) + end + elseif self.unit:match("party%d") == self.unit then + --secure.menu = function(self) + -- ToggleDropDownMenu(1, nil, FriendsFrameDropDown, "cursor", 0 ,0) + --end + end + return secure +end + +function UnitFrame:Enable() + if self.unit ~= "player" then + RegisterUnitWatch(self.secureFrame) + else + self.secureFrame:Show() + end + if UnitExists(self.unit) then + self:UpdateAll(self:HasUnitChanged()) + end +end + +function UnitFrame:Disable() + if self.unit ~= "player" then + UnregisterUnitWatch(self.secure_frame) + else + self.secureFrame:Hide() + end +end + +-- returns true if this unit is a target unit +function UnitFrame:IsTargetFrame() + return self.unit:match(".*target") == self.unit +end + +-- returns the target owner +function UnitFrame:GetTargetOwner() + if self.unit == "target" then + return "player" + else + return self.unit:sub(1, -7) + end +end + +-- Set position from the center of the UIParent +function UnitFrame:SetPosition(x, y) + self.secureFrame:SetPoint("CENTER", UIParent, x, y) +end + +function UnitFrame:RegisterEvents() + local unit = self.unit + local secure = self.secureFrame + + secure:SetScript("OnShow", function(frame, event, ...) + self:OnShow() + end) + + secure:SetScript("OnHide", function(frame, event, ...) + self:OnHide() + end) + + secure:SetScript("OnEvent", function(frame, event, ...) + self[event](self, ...) + end) + + if self:IsTargetFrame() then + local owner = self:GetTargetOwner() + if owner == "player" then + secure:RegisterEvent("PLAYER_TARGET_CHANGED") + else + secure:RegisterUnitEvent("UNIT_TARGET", self.parent:GetTargetOwner()) + end + end + + secure:RegisterUnitEvent("UNIT_AURA", unit) + secure:RegisterUnitEvent("UNIT_HEALTH", unit) + secure:RegisterUnitEvent("UNIT_MAXHEALTH", unit) +end + +-- returns whether or not the unit guid has changed since the last call to this +-- function. Always returns false if the current unit does not exist. +function UnitFrame:HasUnitChanged() + local unit = self.unit + if not UnitExists(unit) then + self.guid = nil + return false + end + + local guid = UnitGUID(unit) + if self.guid == guid then + return false + else + self.guid = guid + return true + end +end + +function UnitFrame:UNIT_AURA(unit, info) + if self:HasUnitChanged() then + self:UpdateAll(true) + return + end + if self.auras:Update(info) then + self:UpdateHealthColor() + end +end + +function UnitFrame:UNIT_HEALTH() + if self:HasUnitChanged() then + self:UpdateAll(true) + return + end + self:UpdateHealth() + self:UpdateHealthColor() +end + +function UnitFrame:UNIT_MAXHEALTH() + if self:HasUnitChanged() then + self:UpdateAll(true) + return + end + self:UpdateHealth() + self:UpdateHealthColor() +end + +function UnitFrame:UNIT_TARGET() + self:UpdateAll(self:HasUnitChanged()) +end + +function UnitFrame:PLAYER_TARGET_CHANGED() + self:UpdateAll(self:HasUnitChanged()) +end + +function UnitFrame:OnShow() + self:StartRangeTicker() + self:UpdateAll(self:HasUnitChanged()) +end + +function UnitFrame:OnHide() + self.guid = nil + self:StopRangeTicker() +end + +function UnitFrame:UpdateAll(unitChanged) + if not UnitExists(self.unit) then + return + end + if unitChanged then + self.auras:Reset() + end + self:UpdateHealth() + self:UpdateHealthColor() + self:UpdateRange() +end + +function UnitFrame:UpdateHealth() + local unit = self.unit + local val = UnitHealth(unit) + local max = UnitHealthMax(unit) + + self.hp:SetRange(0, max) + self.hp:SetValue(val) +end + +function UnitFrame:UpdateHealthColor() + local unit = self.unit + local val = UnitHealth(unit) + local max = UnitHealthMax(unit) + + if max == 0 then + return + end + local pct = val / max + local isFriend = UnitIsFriend("player", unit) + + if not isFriend then + self.hp:SetColor(unpack(colors.hostile)) + elseif self.auras.statusCount["Immune"] then + self.hp:SetColor(unpack(colors.immune)) + elseif self.auras.statusCount["Bomb"] then + self.hp:SetColor(unpack(colors.bomb)) + elseif self.auras.statusCount["Magic"] then + self.hp:SetColor(unpack(colors.magic)) + elseif self.auras.statusCount["Curse"] then + self.hp:SetColor(unpack(colors.curse)) + elseif self.auras.statusCount["Poison"] then + self.hp:SetColor(unpack(colors.poison)) + elseif self.auras.statusCount["Disease"] then + self.hp:SetColor(unpack(colors.disease)) + elseif isFriend and UnitIsDead(unit) then + self.hp:SetColor(unpack(colors.dead)) + elseif isFriend and pct >= 0.90 then + self.hp:SetColor(unpack(colors.healthy)) + elseif isFriend and pct >= 0.75 then + local progress = (pct - 0.75) / (0.90-0.75) + self.hp:SetInterpolatedColor(colors.mid, colors.high, progress) + else + local progress = pct / 0.75 + -- Quadratic progress so we get to the dangerous colors faster as hp + -- goes lower + progress = progress * progress + self.hp:SetInterpolatedColor(colors.low, colors.mid, progress) + end +end + +--[[ + -- UNIT_AURA + -- UNIT_CLASSIFICATION_CHANGED + -- UNIT_COMBAT + -- UNIT_CONNECTION + -- UNIT_DISPLAYPOWER + -- UNIT_FACTION + -- UNIT_FLAGS + -- UNIT_LEVEL + -- UNIT_MANA + -- UNIT_HEALTH_PREDICTION + -- UNIT_PHASE +]]-- +