From 6e03ad55deed8262c6526b9ef9bcf4f397c28920 Mon Sep 17 00:00:00 2001 From: Lupo <931+lupo@noreply.octowow.st> Date: Sat, 24 Oct 2026 00:00:00 +0000 Subject: [PATCH] VimWowSettings 0.1.5 --- .gitattributes | 1 + LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++ README.md | 26 ++ VimWowSettings.toc | 10 + settings.lua | 748 +++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 1459 insertions(+) create mode 100644 .gitattributes create mode 100644 LICENSE create mode 100644 README.md create mode 100644 VimWowSettings.toc create mode 100644 settings.lua diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..fa1385d --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* -text diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + 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/README.md b/README.md new file mode 100644 index 0000000..d313481 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# VimWowSettings + +The options window the Vim mods share: **Esc > VimWow Options**, with a tab +for each installed mod (its options and key bindings) and a General tab +(High contrast). It does nothing alone; mods such as +[VimFinder](https://octowow.st/git/Lupo/VimFinder) need it. + +- A World of Warcraft 1.12.1 (build 5875) client (`## Interface: 11200`). +- No DLL needed. + +## Install + +With Git, from your game folder: + +``` +cd Interface/AddOns +git clone https://octowow.st/git/Lupo/VimWowSettings.git +``` + +To update later, run `git pull` in the `VimWowSettings` folder. + +Without Git, download the ZIP from this page, unzip it into +`Interface/AddOns/`, and rename the folder to exactly `VimWowSettings`. + +At character select, under AddOns, make sure it is ticked. Its settings +are saved per account in `VimWowSettingsDB`. diff --git a/VimWowSettings.toc b/VimWowSettings.toc new file mode 100644 index 0000000..13da24e --- /dev/null +++ b/VimWowSettings.toc @@ -0,0 +1,10 @@ +## Interface: 11200 +## Title: VimWow Settings |cff808080by Lupo|r +## Notes: The options window VimWow and its addons share: a tab for each, with its options and key bindings. +## Author: Lupo +# ## Version: 0.1.3 +# ## Version: 0.1.4 +## Version: 0.1.5 +## SavedVariables: VimWowSettingsDB + +settings.lua diff --git a/settings.lua b/settings.lua new file mode 100644 index 0000000..5d0d8a5 --- /dev/null +++ b/settings.lua @@ -0,0 +1,748 @@ +-- VimWowSettings: one Vanilla-sized options window for VimWow and its side +-- addons (VimFinder, VimBag, VimMap). Each addon registers a tab along the +-- bottom of the window: its pages of options and its key bindings, kept in +-- the addon's own SavedVariables table. Moved out of VimWow/settings_ui.lua +-- (0.1.84) so each addon carries its settings without VimWow. +-- +-- VimWowSettings:Register({ +-- id = "VimBag", name = "Bags", order = 200, +-- db = function() return VimBagDB end, +-- pages = {{name = "General", options = {...}}}, +-- bindings = {{action = "VIMBAGOPEN", defaults = {"CTRL-B"}}}, +-- onChange = function(key) end, +-- }) +-- onChange runs, for every tab, after a checkbox, choice or binding changes +-- and when a key capture starts or stops; a slider only writes db(). +-- local first, second = VimWowSettings:BindingKeys("VimBag", action, defaults) +-- +-- Option format: {key, label, help} is a checkbox; slider = {low, high, +-- step} (with an optional format) is a slider; checked/unchecked names the +-- checkbox's two values; choices cycle through values. A page without +-- options lists the tab's bindings; a tab with bindings and no such page +-- gets one named Bindings. db().bindings[action] holds {key 1, key 2} and +-- db().disabledBindings[action] marks an action turned off. +-- disabled = function() ... end greys an option out while it returns true. +-- A page with draw = function(content) ... end draws itself: the window +-- gives it an empty frame below the page buttons, hidden with the page, +-- and calls draw each time the page renders (VimAddons' tab, 0.1.4). +-- +-- VimWowSettings' own tab, General, keeps the settings every addon reads +-- (VimWowSettingsDB): High contrast, VimWowSettings:HighContrast(). +VimWowSettings = VimWowSettings or {} +local UI = VimWowSettings +UI.addons = UI.addons or {} + +local function button(parent, label, width, height, x, y, handler) + local control = CreateFrame("Button", nil, parent, "UIPanelButtonTemplate") + control:SetWidth(width) + control:SetHeight(height) + control:SetPoint("TOPLEFT", parent, "TOPLEFT", x, y) + control:SetText(label) + control:SetScript("OnClick", handler) + return control +end + +local function label(parent, value, x, y) + local text = parent:CreateFontString(nil, "OVERLAY", "GameFontNormal") + text:SetPoint("TOPLEFT", parent, "TOPLEFT", x, y) + text:SetText(value) + return text +end + +local function record(id) + for _, entry in ipairs(UI.addons) do + if entry.id == id then return entry end + end +end + +local function store(entry) + local db = entry and entry.spec.db and entry.spec.db() + return db or {} +end + +-- The shown tab's SavedVariables table. +local function db() + return store(UI.current) +end + +-- Every addon hears of a change: a capture blocks all their keys, and a new +-- binding or option may be any addon's. +local function changed(key) + for _, entry in ipairs(UI.addons) do + if entry.spec.onChange then entry.spec.onChange(key) end + end +end + +local function sortAddons() + table.sort(UI.addons, function(a, b) + local left, right = a.spec.order or 1000, b.spec.order or 1000 + if left ~= right then return left < right end + return a.id < b.id + end) +end + +function UI:Register(spec) + if type(spec) ~= "table" or not spec.id or not spec.name + or type(spec.db) ~= "function" then + error("VimWowSettings:Register needs id, name and db") + end + local entry = record(spec.id) + if not entry then + entry = {id = spec.id, page = 1, bindingPage = 1, rowCache = {}} + table.insert(self.addons, entry) + end + entry.spec = spec + entry.pages = spec.pages or {} + entry.catalog = spec.bindings or {} + local listsBindings = false + for _, page in ipairs(entry.pages) do + -- if not page.options then listsBindings = true end + if not page.options and not page.draw then listsBindings = true end + end + if table.getn(entry.catalog) > 0 and not listsBindings then + table.insert(entry.pages, {name = "Bindings"}) + end + sortAddons() + -- The window opens on the first tab (VimWow's when it is loaded) until + -- it is shown. + if not (self.frame and self.frame:IsVisible()) then self:Use(self.addons[1]) end + if self.frame then self:BuildAddonTabs() end + return entry +end + +-- An addon's keys for an action: none when turned off, else the keys set +-- in its options, else the defaults. +function UI:BindingKeys(id, action, defaults) + local saved = store(record(id)) + if saved.disabledBindings and saved.disabledBindings[action] then + return nil, nil + end + local assigned = saved.bindings and saved.bindings[action] + if assigned and assigned[1] then return assigned[1], assigned[2] end + defaults = defaults or {} + return defaults[1], defaults[2] +end + +-- Shows `entry`'s tab. pages, tabs, page, bindingPage and rowCache always +-- describe the shown tab. +function UI:Use(entry) + if not entry then return end + local old = self.current + if old then old.page, old.bindingPage = self.page or old.page, self.bindingPage or old.bindingPage end + self.current = entry + self.pages = entry.pages + self.bindings = entry.catalog + self.page = entry.page or 1 + self.bindingPage = entry.bindingPage or 1 + self.rowCache = entry.rowCache + self.tabs = entry.pageButtons or {} +end + +local function suffix(text) + return function(value) return tostring(value) .. text end +end +UI.Suffix = suffix + +local function settingHandler(option) + return function() + if option.disabled and option.disabled() then UI:Render(); return end + local saved = db() + if option.choices then + local position = 0 + for i, candidate in ipairs(option.choices) do + if candidate == saved[option.key] then + position = i; break + end + end + -- saved[option.key] = option.choices[position + -- % table.getn(option.choices) + 1] + -- Lua 5.0 has no % operator (ClassicAPI transpiles it); the + -- position is never negative, so math.mod gives the same. + saved[option.key] = option.choices[math.mod(position, + table.getn(option.choices)) + 1] + -- A two-value checkbox switches between its named values. + elseif option.checked then + saved[option.key] = saved[option.key] == option.checked + and option.unchecked or option.checked + else + saved[option.key] = not saved[option.key] + end + changed(option.key) + UI:Render() + end +end + +-- A slider shows its value with the option's format, or as a multiple. +local function sliderText(option, value) + if option.format then return option.format(value) end + return value .. "x" +end + +-- Sliders store their value rounded to the slider step. +local function sliderHandler(option, slider) + return function() + local step = option.slider[3] + local value = math.floor(slider:GetValue() / step + 0.5) * step + local saved = db() + if saved[option.key] == value then return end + saved[option.key] = value + if slider.valueText then + slider.valueText:SetText(sliderText(option, value)) + end + -- The camera keys read the speed each time one is pressed. + end +end + +local function pageHandler(index) + return function() + UI.page = index + UI:Render() + end +end + +local function addonHandler(index) + return function() + UI:Use(UI.addons[index]) + UI:Render() + end +end + +local function bindingHandler(method, spec, slot) + return function() UI[method](UI, spec, slot) end +end + +function UI:Effective(spec) + return self:BindingKeys(self.current.id, spec.action, spec.defaults) +end + +function UI:StopCapture() + self.captureAction = nil + self.captureSlot = nil + self.pendingKey = nil + VimWowBindingsCapturing = false + if self.capture then self.capture:EnableKeyboard(false); self.capture:Hide() end + changed() +end + +function UI:StartCapture(spec, slot) + self.captureAction = spec.action + self.captureSpec = spec + self.captureSlot = slot + self.pendingKey = nil + VimWowBindingsCapturing = true + self.captureMessage:SetText("Press a key for " + .. (getglobal("BINDING_NAME_" .. spec.action) or spec.action) + .. ". Esc cancels.") + self.capture:Show() + self.capture:EnableKeyboard(true) + changed() +end + +local function modifiedKey(key) + if not key or key == "LSHIFT" or key == "RSHIFT" + or key == "LCTRL" or key == "RCTRL" + or key == "LALT" or key == "RALT" + or key == "SHIFT" or key == "CTRL" or key == "ALT" then return end + local prefix = "" + if IsControlKeyDown and IsControlKeyDown() then prefix = prefix .. "CTRL-" end + if IsAltKeyDown and IsAltKeyDown() then prefix = prefix .. "ALT-" end + if IsShiftKeyDown and IsShiftKeyDown() then prefix = prefix .. "SHIFT-" end + return prefix .. string.upper(key) +end + +-- ------------------------------------------------------------ stock keys +-- A client without ClassicAPI.dll has no override bindings. The side +-- addons then take their window's keys through a capture frame, and their +-- open key is a game key binding (their Bindings.xml). + +-- A key written as this window writes a pressed one: CTRL-, ALT-, SHIFT-, +-- in that order, whatever order `key` names them in. +function UI.NormalKey(key) + if type(key) ~= "string" or key == "" then return end + local held, rest = {}, key + while true do + local _, _, modifier, tail = string.find(rest, "^(%u+)%-(.+)$") + if modifier == "CTRL" or modifier == "ALT" or modifier == "SHIFT" then + held[modifier] = true + rest = tail + else + break + end + end + local prefix = "" + if held.CTRL then prefix = prefix .. "CTRL-" end + if held.ALT then prefix = prefix .. "ALT-" end + if held.SHIFT then prefix = prefix .. "SHIFT-" end + return prefix .. string.upper(rest) +end + +-- A capture frame: SetKeys({[key] = button}) gives it those keys. While it +-- has any, it takes the whole keyboard (the game's own keys wait until it +-- gives the keyboard back) and a key it has clicks its button. +function UI:NewKeyCapture(name) + local capture = CreateFrame("Frame", name, UIParent) + capture:SetFrameStrata("TOOLTIP") + capture:EnableKeyboard(false) + capture.keys = {} + capture:SetScript("OnKeyDown", function(_, raw) + local key = modifiedKey(raw or arg1) + local target = key and capture.keys[key] + if target then target:Click() end + end) + function capture:SetKeys(keys) + local normal, any = {}, false + for key, target in pairs(keys or {}) do + local written = UI.NormalKey(key) + if written and target then + normal[written] = target + any = true + end + end + self.keys = normal + self:EnableKeyboard(any) + end + return capture +end + +-- Puts an addon's open keys on the game's key bindings, to its Bindings.xml +-- command `action`: a key is taken only while no other binding has it, and +-- a key no longer wanted is given back. `held` (kept in the addon's saved +-- variables) lists the keys bound this way. Call it only once the client's +-- own bindings have loaded (after PLAYER_ENTERING_WORLD). +function UI.ClaimGameKeys(held, action, first, second) + if type(SetBinding) ~= "function" or type(GetBindingAction) ~= "function" then + return + end + local wanted = {} + if first then wanted[first] = true end + if second then wanted[second] = true end + local changed = false + for key in pairs(held) do + if not wanted[key] then + if GetBindingAction(key) == action then + SetBinding(key) + changed = true + end + held[key] = nil + end + end + for key in pairs(wanted) do + local owner = GetBindingAction(key) + if owner == nil or owner == "" then + SetBinding(key, action) + changed = true + held[key] = true + elseif owner == action then + held[key] = true + end + end + if changed and type(SaveBindings) == "function" then + SaveBindings(type(GetCurrentBindingSet) == "function" + and GetCurrentBindingSet() or 1) + end +end + +function UI:CaptureKey(raw) + if raw == "ESCAPE" then self:StopCapture(); self:Render(); return end + local key = modifiedKey(raw) + if not key or not self.captureAction then return end + local owner = GetBindingAction and GetBindingAction(key) or nil + if owner == "" or owner == "UNKNOWN" then owner = nil end + if owner and self.pendingKey ~= key then + self.pendingKey = key + self.captureMessage:SetText(key .. " is bound to " .. owner + .. ". Press it again to use it for " .. self.current.spec.name + .. " while active; the game binding stays intact. Esc cancels.") + return + end + local saved = db() + saved.bindings = saved.bindings or {} + -- An action never set starts from the keys it has now, so setting key 2 + -- keeps key 1. + local pair = saved.bindings[self.captureAction] + or {self:Effective(self.captureSpec)} + pair[self.captureSlot] = key + -- BindingKeys reads a saved pair only when key 1 is set, so a repeated + -- key and a lone key 2 both end up as key 1. + if pair[1] == pair[2] then pair[2] = nil end + if not pair[1] then pair[1], pair[2] = pair[2], nil end + saved.bindings[self.captureAction] = pair + if saved.disabledBindings then + saved.disabledBindings[self.captureAction] = nil + end + self:StopCapture() + self:Render() +end + +function UI:ResetBinding(spec) + local saved = db() + if saved.bindings then saved.bindings[spec.action] = nil end + if saved.disabledBindings then saved.disabledBindings[spec.action] = nil end + changed() + self:Render() +end + +function UI:DisableBinding(spec) + self:ResetBinding(spec) + local saved = db() + saved.disabledBindings = saved.disabledBindings or {} + saved.disabledBindings[spec.action] = true + changed() + self:Render() +end + +function UI:ClearRows() + for _, entry in ipairs(self.addons) do + for _, row in pairs(entry.rowCache or {}) do row:Hide() end + for _, tab in ipairs(entry.pageButtons or {}) do tab:Hide() end + end +end + +-- The page buttons along the top of a tab. +function UI:BuildPageButtons(entry) + if entry.pageButtons then return end + entry.pageButtons = {} + for index, page in ipairs(entry.pages) do + local tab = button(self.frame, page.name, 104, 26, + 23 + (index - 1) * 110, -55, pageHandler(index)) + tab:Hide() + table.insert(entry.pageButtons, tab) + end + if entry == self.current then self.tabs = entry.pageButtons end +end + +-- One bottom tab per addon, as on the character window; [ and ] switch +-- them. +function UI:BuildAddonTabs() + local count = table.getn(self.addons) + self.addonTabs = self.addonTabs or {} + for index = 1, count do + local tab = self.addonTabs[index] + if not tab then + tab = CreateFrame("Button", "VimWowSettingsFrameTab" .. index, + self.frame, "CharacterFrameTabButtonTemplate") + tab:SetID(index) + if index == 1 then + tab:SetPoint("TOPLEFT", self.frame, "BOTTOMLEFT", 15, 7) + else + tab:SetPoint("LEFT", self.addonTabs[index - 1], "RIGHT", -16, 0) + end + self.addonTabs[index] = tab + end + tab:SetText(self.addons[index].spec.name) + tab:SetScript("OnClick", addonHandler(index)) + if PanelTemplates_TabResize then PanelTemplates_TabResize(0, tab) end + tab:Show() + end + for index = count + 1, table.getn(self.addonTabs) do + self.addonTabs[index]:Hide() + end + self.frame.numTabs = count + for _, entry in ipairs(self.addons) do self:BuildPageButtons(entry) end +end + +function UI:Render() + if not self.frame or not self.current then return end + local entry = self.current + entry.page, entry.bindingPage = self.page, self.bindingPage + local spec = entry.spec + self.statusLabel:SetText(spec.status and spec.status() or "") + self.credit:SetText(spec.credit or "") + for index, other in ipairs(self.addons) do + if other == entry and PanelTemplates_SetTab then + PanelTemplates_SetTab(self.frame, index) + end + end + self:ClearRows() + for index, tab in ipairs(self.tabs) do + tab:Show() + if index == self.page then tab:LockHighlight() + else tab:UnlockHighlight() end + end + local saved = db() + local catalog = self.bindings + local extra = spec.bindingsButton + -- A page that draws itself gets its own frame. + local shown = self.pages[self.page] + if shown.draw then + self.pageLabel:SetText(shown.name) + self.prev:Hide(); self.next:Hide(); self.suggestions:Hide() + local cacheKey = "draw:" .. self.page + local content = self.rowCache[cacheKey] + if not content then + content = CreateFrame("Frame", nil, self.frame) + content:SetPoint("TOPLEFT", self.frame, "TOPLEFT", 24, -91) + content:SetWidth(654); content:SetHeight(405) + self.rowCache[cacheKey] = content + end + content:Show() + shown.draw(content) + -- The page without options is the bindings list. + -- if not self.pages[self.page].options then + elseif not shown.options then + local start = (self.bindingPage - 1) * 8 + 1 + for n = 0, 7 do + local binding = catalog[start + n] + if binding then + local cacheKey = "binding:" .. (start + n) + local row = self.rowCache[cacheKey] + if not row then + row = CreateFrame("Frame", nil, self.frame) + row:SetPoint("TOPLEFT", self.frame, "TOPLEFT", 24, + -91 - n * 49) + row:SetWidth(654); row:SetHeight(45) + label(row, getglobal("BINDING_NAME_" .. binding.action) + or binding.action, 0, -6) + row.first = button(row, "", 112, 22, 318, -2, + bindingHandler("StartCapture", binding, 1)) + row.second = button(row, "", 112, 22, 434, -2, + bindingHandler("StartCapture", binding, 2)) + button(row, "Default", 55, 22, 550, -2, + bindingHandler("ResetBinding", binding)) + button(row, "Off", 42, 22, 608, -2, + bindingHandler("DisableBinding", binding)) + self.rowCache[cacheKey] = row + end + local first, second = self:Effective(binding) + local disabled = saved.disabledBindings + and saved.disabledBindings[binding.action] + row.first:SetText(disabled and "Off" or first or "Set key 1") + row.second:SetText(disabled and "Off" or second or "Set key 2") + row:Show() + end + end + self.pageLabel:SetText("Bindings " .. self.bindingPage .. "/" + .. math.max(1, math.ceil(table.getn(catalog) / 8))) + self.prev:Show(); self.next:Show() + if extra then + self.suggestions:SetText(extra.label) + self.suggestions:Show() + else + self.suggestions:Hide() + end + else + self.pageLabel:SetText(self.pages[self.page].name) + self.prev:Hide(); self.next:Hide(); self.suggestions:Hide() + for index, option in ipairs(self.pages[self.page].options) do + local cacheKey = "setting:" .. self.page .. ":" .. index + local row = self.rowCache[cacheKey] + if not row then + row = CreateFrame("Frame", nil, self.frame) + -- Seven rows fit above the page label. + row:SetPoint("TOPLEFT", self.frame, "TOPLEFT", 42, + -105 - (index - 1) * 56) + row:SetWidth(610); row:SetHeight(48) + -- A checkbox sits left of its label, as in the game's options. + local checkbox = not option.slider and not option.choices + local textX = checkbox and 34 or 0 + -- label(row, option.label, textX, -4) + row.label = label(row, option.label, textX, -4) + local help = row:CreateFontString(nil, "OVERLAY", + "GameFontHighlightSmall") + help:SetPoint("TOPLEFT", row, "TOPLEFT", textX, -24) + help:SetText(option.help) + if option.slider then + -- local name = "VimWowSettingSlider" .. option.key + -- VimWow's slider names stay as they were; other tabs + -- add their id. + local name = "VimWowSettingSlider" + .. (entry.id == "VimWow" and "" or entry.id) .. option.key + local slider = CreateFrame("Slider", name, row, + "OptionsSliderTemplate") + slider:SetWidth(170); slider:SetHeight(17) + slider:SetPoint("TOPLEFT", row, "TOPLEFT", 400, -10) + slider:SetMinMaxValues(option.slider[1], option.slider[2]) + slider:SetValueStep(option.slider[3]) + -- Keyboard steps use the option's step. + slider.vimwowStep = option.slider[3] + local low = getglobal(name .. "Low") + local high = getglobal(name .. "High") + if low then low:SetText(sliderText(option, option.slider[1])) end + if high then high:SetText(sliderText(option, option.slider[2])) end + slider.valueText = getglobal(name .. "Text") + slider:SetScript("OnValueChanged", + sliderHandler(option, slider)) + row.slider = slider + elseif option.choices then + row.valueButton = button(row, "", 110, 27, 440, -8, + settingHandler(option)) + else + local check = CreateFrame("CheckButton", + "VimWowSettingCheck" .. (entry.id == "VimWow" and "" or entry.id) + .. option.key, row, + "OptionsCheckButtonTemplate") + check:SetWidth(26); check:SetHeight(26) + check:SetPoint("TOPLEFT", row, "TOPLEFT", 0, 0) + local toggle = settingHandler(option) + check:SetScript("OnClick", function() + toggle() + if type(PlaySound) == "function" then + PlaySound(check:GetChecked() + and "igMainMenuOptionCheckBoxOn" + or "igMainMenuOptionCheckBoxOff") + end + end) + row.check = check + end + self.rowCache[cacheKey] = row + end + local value = saved[option.key] + if row.slider then + row.slider:SetValue(value) + if row.slider.valueText then + row.slider.valueText:SetText(sliderText(option, value)) + end + elseif row.check then + local checked + if option.checked then checked = value == option.checked + else checked = value and true or false end + row.check:SetChecked(checked and 1 or nil) + else + local caption + if option.choices then + caption = option.captions and option.captions[value] + or option.format and option.format(value) + or tostring(value) + else + caption = value and "On" or "Off" + end + row.valueButton:SetText(caption) + end + -- An option another one decides for greys out. + local off = option.disabled and option.disabled() and true or false + local control = row.check or row.valueButton + if control then + if off then control:Disable() else control:Enable() end + end + if off then row.label:SetTextColor(0.5, 0.5, 0.5) + else row.label:SetTextColor(1, 0.82, 0) end + row:Show() + end + end +end + +function UI:Initialize() + if self.frame then return end + local frame = CreateFrame("Frame", "VimWowSettingsFrame", UIParent) + frame:SetWidth(700); frame:SetHeight(555) + frame:SetPoint("CENTER", UIParent, "CENTER", 0, 0) + frame:SetFrameStrata("DIALOG") + frame:EnableMouse(true) + frame:SetBackdrop({bgFile = "Interface\\DialogFrame\\UI-DialogBox-Background", + edgeFile = "Interface\\DialogFrame\\UI-DialogBox-Border", + tile = true, tileSize = 32, edgeSize = 32, + insets = {left = 11, right = 12, top = 12, bottom = 11}}) + label(frame, "VimWow Options", 24, -20) + local credit = frame:CreateFontString(nil, "OVERLAY", "GameFontDisableSmall") + credit:SetPoint("TOPLEFT", frame, "TOPLEFT", 24, -38) + self.credit = credit + -- A close cross like other panels; keyboard navigation skips it, since + -- Esc closes the window. + local close = CreateFrame("Button", "VimWowSettingsFrameCloseButton", frame, + "UIPanelCloseButton") + close:SetPoint("TOPRIGHT", frame, "TOPRIGHT", -5, -5) + close:SetScript("OnClick", function() self:Hide() end) + self.frame = frame + self.statusLabel = label(frame, "", 33, -530) + self.pageLabel = label(frame, "", 33, -512) + self.prev = button(frame, "Previous", 80, 24, 490, -503, + function() self.bindingPage = math.max(1, self.bindingPage - 1) + self:Render() end) + self.next = button(frame, "Next", 80, 24, 582, -503, + function() + self.bindingPage = math.min(math.max(1, + math.ceil(table.getn(self.bindings) / 8)), self.bindingPage + 1) + self:Render() + end) + -- A tab's own button on its bindings page (VimWow: the game keys its + -- keys cover). Options closes first, so a popup is not hidden behind it. + self.suggestions = button(frame, "", 150, 24, 330, -503, + function() + local extra = self.current and self.current.spec.bindingsButton + self:Hide() + if extra and extra.onClick then extra.onClick() end + end) + local capture = CreateFrame("Frame", "VimWowBindingCapture", UIParent) + capture:SetAllPoints(UIParent) + capture:SetFrameStrata("FULLSCREEN_DIALOG") + capture:EnableMouse(true) + capture:SetBackdrop({bgFile = "Interface\\DialogFrame\\UI-DialogBox-Background"}) + capture:SetBackdropColor(0, 0, 0, 0.8) + self.captureMessage = label(capture, "", 100, -200) + capture:SetScript("OnKeyDown", function(_, key) + self:CaptureKey(key or arg1) + end) + capture:EnableKeyboard(false) + capture:Hide() + self.capture = capture + frame:SetScript("OnHide", function() self:StopCapture() end) + frame:Hide() + self:BuildAddonTabs() + if self.current then self.tabs = self.current.pageButtons end + UISpecialFrames = UISpecialFrames or {} + table.insert(UISpecialFrames, "VimWowSettingsFrame") +end + +-- Opens the window, on addon `id`'s tab when given. +function UI:Show(id) + self:Initialize() + if id and record(id) then self:Use(record(id)) end + self.frame:Show() + self:Render() +end + +function UI:Hide() + if self.frame then self.frame:Hide() end +end + +-- ------------------------------------------------------------ shared + +-- Settings every Vim addon reads, on VimWowSettings' own tab (the user, +-- 2026-10-14). High contrast: the 1.12 client has no accessibility or +-- contrast setting to follow, so this is the one; VimQuest's quest areas +-- turn blue with it. +function UI:HighContrast() + return VimWowSettingsDB ~= nil and VimWowSettingsDB.highContrast == true +end + +UI:Register({ + id = "VimWowSettings", name = "General", order = 10000, + db = function() + VimWowSettingsDB = VimWowSettingsDB or {} + return VimWowSettingsDB + end, + pages = {{name = "Accessibility", options = { + {key = "highContrast", label = "High contrast", + help = "Colours that stand out more on the map's parchment: VimQuest's quest areas turn blue."}, + }}}, +}) + +local menuInstaller = CreateFrame("Frame", "VimWowMenuInstaller", UIParent) +menuInstaller:RegisterEvent("PLAYER_LOGIN") +menuInstaller:SetScript("OnEvent", function() + UI.menuReadyAt = GetTime() + 0.3 +end) +menuInstaller:SetScript("OnUpdate", function() + if UI.menuInstalled or not UI.menuReadyAt + or GetTime() < UI.menuReadyAt then return end + if QuestieOcto and QuestieOcto.GameMenu + and not QuestieOcto.GameMenu.installed then return end + if not GameMenuFrame or not GameMenuButtonUIOptions + or not GameMenuButtonKeybindings then return end + local anchor = GameMenuButtonQuestieOctoOptions + or GameMenuButtonAdvancedOptions or GameMenuButtonUIOptions + local item = CreateFrame("Button", "GameMenuButtonVimWowOptions", + GameMenuFrame, "GameMenuButtonTemplate") + item:SetText("VimWow Options") + item:SetPoint("TOP", anchor, "BOTTOM", 0, -1) + item:SetScript("OnClick", function() + if HideUIPanel then HideUIPanel(GameMenuFrame) + else GameMenuFrame:Hide() end + UI:Show() + end) + GameMenuButtonKeybindings:ClearAllPoints() + GameMenuButtonKeybindings:SetPoint("TOP", item, "BOTTOM", 0, -1) + GameMenuFrame:SetHeight(GameMenuFrame:GetHeight() + 32) + UI.menuInstalled = true + menuInstaller:SetScript("OnUpdate", nil) +end)