diff options
Diffstat (limited to 'libs/fnistool')
| -rw-r--r-- | libs/fnistool/.editorconfig | 9 | ||||
| -rw-r--r-- | libs/fnistool/.gitignore | 109 | ||||
| -rw-r--r-- | libs/fnistool/.pre-commit-config.yaml | 15 | ||||
| -rw-r--r-- | libs/fnistool/CMakeLists.txt | 5 | ||||
| -rw-r--r-- | libs/fnistool/CMakePresets.json | 17 | ||||
| -rw-r--r-- | libs/fnistool/LICENSE | 674 | ||||
| -rw-r--r-- | libs/fnistool/src/CMakeLists.txt | 6 | ||||
| -rw-r--r-- | libs/fnistool/src/FNISPatches.py | 245 | ||||
| -rw-r--r-- | libs/fnistool/src/FNISTool.py | 342 | ||||
| -rw-r--r-- | libs/fnistool/src/FNISToolReset.py | 76 | ||||
| -rw-r--r-- | libs/fnistool/src/FNISTool_en.ts | 295 | ||||
| -rw-r--r-- | libs/fnistool/vcpkg.json | 15 |
12 files changed, 1808 insertions, 0 deletions
diff --git a/libs/fnistool/.editorconfig b/libs/fnistool/.editorconfig new file mode 100644 index 0000000..f64592a --- /dev/null +++ b/libs/fnistool/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*.py] +indent_style = space +indent_size = 4 + +[{CMakeLists.txt, *.cmake}] +indent_style = space +indent_size = 4 diff --git a/libs/fnistool/.gitignore b/libs/fnistool/.gitignore new file mode 100644 index 0000000..5afe969 --- /dev/null +++ b/libs/fnistool/.gitignore @@ -0,0 +1,109 @@ +# Mod Organizer Umbrella stuff +/msbuild.log +/*std*.log +/*build + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ diff --git a/libs/fnistool/.pre-commit-config.yaml b/libs/fnistool/.pre-commit-config.yaml new file mode 100644 index 0000000..4b7d480 --- /dev/null +++ b/libs/fnistool/.pre-commit-config.yaml @@ -0,0 +1,15 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v5.0.0 + hooks: + - id: trailing-whitespace + - id: end-of-file-fixer + - id: check-merge-conflict + - id: check-case-conflict + +ci: + autofix_commit_msg: "[pre-commit.ci] Auto fixes from pre-commit.com hooks." + autofix_prs: true + autoupdate_commit_msg: "[pre-commit.ci] Pre-commit autoupdate." + autoupdate_schedule: quarterly + submodules: false diff --git a/libs/fnistool/CMakeLists.txt b/libs/fnistool/CMakeLists.txt new file mode 100644 index 0000000..01f7443 --- /dev/null +++ b/libs/fnistool/CMakeLists.txt @@ -0,0 +1,5 @@ +cmake_minimum_required(VERSION 3.16) + +project(FNISTool LANGUAGES NONE) + +add_subdirectory(src) diff --git a/libs/fnistool/CMakePresets.json b/libs/fnistool/CMakePresets.json new file mode 100644 index 0000000..acc6d97 --- /dev/null +++ b/libs/fnistool/CMakePresets.json @@ -0,0 +1,17 @@ +{ + "configurePresets": [ + { + "binaryDir": "${sourceDir}/vsbuild", + "toolchainFile": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake", + "generator": "Visual Studio 17 2022", + "name": "vs2022-windows" + } + ], + "buildPresets": [ + { + "name": "vs2022-windows", + "configurePreset": "vs2022-windows" + } + ], + "version": 4 +} diff --git a/libs/fnistool/LICENSE b/libs/fnistool/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/libs/fnistool/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <http://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<http://www.gnu.org/licenses/>. + + 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 +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/libs/fnistool/src/CMakeLists.txt b/libs/fnistool/src/CMakeLists.txt new file mode 100644 index 0000000..84c2fc2 --- /dev/null +++ b/libs/fnistool/src/CMakeLists.txt @@ -0,0 +1,6 @@ +cmake_minimum_required(VERSION 3.16) + +find_package(mo2-cmake CONFIG REQUIRED) + +add_custom_target(FNISTool ALL) +mo2_configure_python(FNISTool SIMPLE) diff --git a/libs/fnistool/src/FNISPatches.py b/libs/fnistool/src/FNISPatches.py new file mode 100644 index 0000000..87fdbf0 --- /dev/null +++ b/libs/fnistool/src/FNISPatches.py @@ -0,0 +1,245 @@ +# This Mod Organizer plugin is released to the pubic under the terms of the GNU GPL version 3, which is accessible from the Free Software Foundation here: https://www.gnu.org/licenses/gpl-3.0-standalone.html + +# To use this plugin, place it in the plugins directory of your Mod Organizer install. You will then find a 'ENTER BUTTON NAME HERE BEFORE RELEASE!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!' option under the tools menu. + +# Intended behaviour: +# * Adds button to tools menu. +# * If FNIS' location isn't known (or isn't valid, e.g. FNIS isn't actually there) when the button is pressed, nag the user to run the main FNIS Tool at least once, and exit. +# * Reads FNIS' patches file for the current game and the MyPatches.txt file to determine which are active. +# * Displays a popup where the user can enable or disable patches, and saves the results to MyPatches.txt when Save is pressed. + +# Future behaviour: +# * Maybe allow the user to show hidden patches +# * Maybe move the saved list to something stored per-profile + +import os +import pathlib +import sys + +from FNISTool import FNISTool +from PyQt6.QtCore import QCoreApplication, qCritical, QFileInfo, Qt +from PyQt6.QtGui import QIcon, QFileSystemModel +from PyQt6.QtWidgets import QDialogButtonBox, QLabel, QListWidget, QListWidgetItem, QMessageBox, QVBoxLayout, QDialog + +import mobase + +patchListNames = { + "Skyrim": "PatchList.txt", + "Skyrim Special Edition": "PatchListSE.txt", + "Skyrim VR": "PatchListVR.txt" +} + +class Patch: + + def __init__(self, fullString): + fields = fullString.split('#') + # field names taken from FNIS PatchListSE.txt + self.patchid = fields[0] + self.hidden = fields[1] == "1" + self.num_bones = fields[2] + self.required_behaviors_pattern = fields[3] + self.text_for_patch = fields[4] + if len(fields) > 5: + self.optional_file_path_for_mod_install_check = fields[5] + else: + self.optional_file_path_for_mod_install_check = None + + def asQListWidgetItem(self): + listItem = QListWidgetItem(self.text_for_patch, None, 0) + listItem.setFlags(listItem.flags() | Qt.ItemFlag.ItemIsUserCheckable) + # We can't set the hidden status until the item is actually in a list + listItem.setData(Qt.ItemDataRole.UserRole, self.patchid) + + return listItem + +class ExpandingQListWidget(QListWidget): + + def __init__(self, parent=None): + super().__init__(parent) + + def sizeHint(self): + return self.childrenRect().size() + +class FNISPatches(mobase.IPluginTool): + + def __init__(self): + super(FNISPatches, self).__init__() + self.__organizer = None + self.__parentWidget = None + + def init(self, organizer): + self.__organizer = organizer + if sys.version_info < (3, 0): + qCritical(self.tr("FNISPatches plugin requires a Python 3 interpreter, but is running on a Python 2 interpreter.")) + QMessageBox.critical(self.__parentWidget, self.tr("Incompatible Python version."), self.tr("This version of the FNIS Patches plugin requires a Python 3 interpreter, but Mod Organizer has provided a Python 2 interpreter. You should check for an updated version, including in the Mod Organizer 2 Development Discord Server.")) + return False + return True + + def name(self): + return "FNIS Patches Tool" + + def localizedName(self): + return self.tr("FNIS Patches Tool") + + def author(self): + return "AnyOldName3" + + def description(self): + return self.tr("Configures the patches which FNIS applies to the game.") + + def version(self): + return mobase.VersionInfo(1, 0, 1, mobase.ReleaseType.final) + + def master(self): + return "FNIS Integration Tool" + + def settings(self): + return [] + + def displayName(self): + return self.tr("FNIS/Configure FNIS Patches") + + def tooltip(self): + return self.tr("Configures the patches which FNIS applies to the game.") + + def icon(self): + fnisPath = self.__organizer.pluginSetting(self.__mainToolName(), "fnis-path") + if os.path.exists(fnisPath): + # We can't directly grab the icon from an executable, but this seems like the simplest alternative. + fin = QFileInfo(fnisPath) + model = QFileSystemModel() + model.setRootPath(fin.path()) + return model.fileIcon(model.index(fin.filePath())) + else: + # Fall back to where the user might have put an icon manually. + return QIcon("plugins/FNIS.ico") + + def setParentWidget(self, widget): + self.__parentWidget = widget + + def display(self): + fnisPath = self.__getFNISPath() + if fnisPath == None: + return + + enabledPatches = self.__loadEnabledPatches() + + availablePatches = self.__loadAvailablePatches() + + dialog = QDialog(self.__parentWidget) + dialog.setWindowTitle(self.tr("Select Patches")) + + label = QLabel(self.tr("Note: Some patches may be automatically enabled or disabled by Fore's New Idles in Skyrim, so don't be surprised if its list differs from this one.")) + label.setWordWrap(True) + + listWidget = ExpandingQListWidget() + for patch in availablePatches.values(): + listItem = patch.asQListWidgetItem() + if patch.patchid in enabledPatches: + listItem.setCheckState(Qt.CheckState.Checked) + else: + listItem.setCheckState(Qt.CheckState.Unchecked) + listWidget.addItem(listItem) + listItem.setHidden(patch.hidden) + + buttonBox = QDialogButtonBox(QDialogButtonBox.StandardButton.Save | QDialogButtonBox.StandardButton.Cancel) + buttonBox.accepted.connect(dialog.accept) + buttonBox.rejected.connect(dialog.reject) + + layout = QVBoxLayout() + layout.addWidget(label) + layout.addWidget(listWidget) + layout.addWidget(buttonBox) + dialog.setLayout(layout) + + result = dialog.exec() + if result == QDialog.DialogCode.Rejected: + # Cancel was pressed + return + + enabledPatches = set() + for i in range(0, listWidget.count()): + listItem = listWidget.item(i) + if listItem.checkState() == Qt.CheckState.Checked: + enabledPatches.add(listItem.data(Qt.ItemDataRole.UserRole)) + self.__saveEnabledPatches(enabledPatches) + + def tr(self, str): + return QCoreApplication.translate("FNISPatches", str) + + @staticmethod + def __mainToolName(): + return FNISTool().name() + + def __getFNISPath(self): + savedPath = self.__organizer.pluginSetting(self.__mainToolName(), "fnis-path") + # FNIS must be installed within the game's data directory, so needs to either be within that or a mod folder + modDirectory = self.__getModDirectory() + gameDataDirectory = pathlib.Path(self.__organizer.managedGame().dataDirectory().absolutePath()) + pathlibPath = pathlib.Path(savedPath) + inGoodLocation = self.__withinDirectory(pathlibPath, modDirectory) + inGoodLocation |= self.__withinDirectory(pathlibPath, gameDataDirectory) + if not pathlibPath.is_file() or not inGoodLocation: + QMessageBox.information(self.__parentWidget, self.tr("Unable to find FNIS"), self.tr("Fore's New Idles in Skyrim can't be found using the location saved in Mod Organizer's settings. Please run the main FNIS integration tool before using this one.")) + return None + return savedPath + + def __getModDirectory(self): + modDirectory = None + modList = self.__organizer.modList().allModsByProfilePriority() + # Get the first managed mod so we can access the mods directory. + for mod in modList: + if (self.__organizer.modList().state(mod) & 0x2) != 0: + modDirectory = pathlib.Path(self.__organizer.modList().getMod(mod).absolutePath()).parent + break + return modDirectory + + @staticmethod + def __withinDirectory(innerPath, outerDir): + for path in innerPath.parents: + if path.samefile(outerDir): + return True + return False + + def __loadEnabledPatches(self, ): + path = pathlib.Path(self.__getFNISPath()).parent + path /= "MyPatches.txt" + if not path.is_file(): + return set() + + enabledPatches = set() + with path.open() as f: + for line in f: + if line != "": + enabledPatches.add(line.strip()) + return enabledPatches + + def __saveEnabledPatches(self, enabledPatches): + path = pathlib.Path(self.__getFNISPath()).parent + path /= "MyPatches.txt" + with path.open('w') as f: + for patchName in enabledPatches: + f.write(patchName) + f.write("\n") + + def __loadAvailablePatches(self): + patchListName = patchListNames[self.__organizer.managedGame().gameName()] + path = pathlib.Path(self.__getFNISPath()).parent + path /= patchListName + availablePatches = {} + # FNIS uses UTF-8 with a BOM, Python assumes everything's using the platform's default encoding + with path.open(encoding="utf-8-sig") as f: + # The first line is a header thing + firstLine = True + for line in f: + if firstLine: + firstLine = False + continue + if line[0] == "'": + continue + patch = Patch(line.strip()) + availablePatches[patch.patchid] = patch + return availablePatches + +def createPlugin(): + return FNISPatches() diff --git a/libs/fnistool/src/FNISTool.py b/libs/fnistool/src/FNISTool.py new file mode 100644 index 0000000..e219bed --- /dev/null +++ b/libs/fnistool/src/FNISTool.py @@ -0,0 +1,342 @@ +# This Mod Organizer plugin is released to the pubic under the terms of the GNU GPL version 3, which is accessible from the Free Software Foundation here: https://www.gnu.org/licenses/gpl-3.0-standalone.html + +# To use this plugin, place it in the plugins directory of your Mod Organizer install. You will then find a 'Run FNIS' option under the tools menu. + +# Intended behaviour: +# * Adds button to tools menu. +# * If FNIS' location isn't known (or isn't valid, e.g. FNIS isn't actually there) when the button is pressed, a file chooser is displayed to find FNIS. +# * `GenerateFNISforUsers.exe RedirectFiles="<some mod path>" InstantExecute=1` is then run within the VFS, with the RedirectFiles option being controlled by other settings (which the user is prompted to fill in if they have not yet been specified). +# * When it exits, if necessary, its return code is used to generate a helpful popup saying whether or not it worked. + +# Future behaviour: +# * As in Vortex's FNIS integration, keeps track of mod files which affect FNIS. +# * If they don't match what was there when the last FNIS output was created, uses IPluginDiagnose interface to display a warning +# * This may already be handled by MO's built-in (but disabled) FNIS checker plugin +import os +import pathlib +import sys + +from PyQt6.QtCore import QCoreApplication, qCritical, QFileInfo +from PyQt6.QtGui import QIcon, QFileSystemModel +from PyQt6.QtWidgets import QFileDialog, QMessageBox + +import mobase + +class FNISMissingException(Exception): + """Thrown if GenerateFNISforUsers.exe path can't be found""" + pass + +class FNISInactiveException(Exception): + """Thrown if GenerateFNISforUsers.exe is installed to an inactive mod""" + pass + +class UnknownOutputPreferenceException(Exception): + """Thrown if the user hasn't specified whether to output to a separate mod""" + pass + +class FNISTool(mobase.IPluginTool): + + def __init__(self): + super(FNISTool, self).__init__() + self.__organizer = None + self.__parentWidget = None + + def init(self, organizer): + self.__organizer = organizer + if sys.version_info < (3, 0): + qCritical(self.tr("FNISTool plugin requires a Python 3 interpreter, but is running on a Python 2 interpreter.")) + QMessageBox.critical(self.__parentWidget, self.tr("Incompatible Python version."), self.tr("This version of the FNIS Integration plugin requires a Python 3 interpreter, but Mod Organizer has provided a Python 2 interpreter. You should check for an updated version, including in the Mod Organizer 2 Development Discord Server.")) + return False + return True + + def name(self): + return "FNIS Integration Tool" + + def localizedName(self): + return self.tr("FNIS Integration Tool") + + def author(self): + return "AnyOldName3" + + def description(self): + return self.tr("Runs GenerateFNISforUsers.exe so the game can load custom animations.") + + def version(self): + return mobase.VersionInfo(1, 2, 0, 0) + + def requirements(self): + return [ + mobase.PluginRequirementFactory.gameDependency({ + "Skyrim", + "Skyrim Special Edition", + "Skyrim VR" + }) + ] + + def settings(self): + return [ + mobase.PluginSetting("fnis-path", self.tr("Path to GenerateFNISforUsers.exe"), ""), + mobase.PluginSetting("output-to-mod", self.tr("Whether or not to direct the FNIS output to a mod folder."), True), + mobase.PluginSetting("output-path", self.tr("When output-to-mod is enabled, the path to the mod to use."), ""), + mobase.PluginSetting("initialised", self.tr("Settings have been initialised. Set to False to reinitialise them."), False), + mobase.PluginSetting("output-logs-to-mod", self.tr("Whether or not to direct any new FNIS logs to a mod folder."), True), + mobase.PluginSetting("output-logs-path", self.tr("When output-logs-to-mod is enabled, the path to the mod to use."), ""), + ] + + def displayName(self): + return self.tr("FNIS/Run FNIS") + + def tooltip(self): + return self.tr("Runs GenerateFNISforUsers.exe so the game can load custom animations.") + + def icon(self): + fnisPath = self.__organizer.pluginSetting(self.name(), "fnis-path") + if os.path.exists(fnisPath): + # We can't directly grab the icon from an executable, but this seems like the simplest alternative. + fin = QFileInfo(fnisPath) + model = QFileSystemModel() + model.setRootPath(fin.path()) + return model.fileIcon(model.index(fin.filePath())) + else: + # Fall back to where the user might have put an icon manually. + return QIcon("plugins/FNIS.ico") + + def setParentWidget(self, widget): + self.__parentWidget = widget + + def display(self): + args = [] + redirectOutput = True + outputModName = None + logOutputModName = "" + + if not bool(self.__organizer.pluginSetting(self.name(), "initialised")): + self.__organizer.setPluginSetting(self.name(), "fnis-path", "") + self.__organizer.setPluginSetting(self.name(), "output-path", "") + self.__organizer.setPluginSetting(self.name(), "output-to-mod", True) + self.__organizer.setPluginSetting(self.name(), "output-logs-path", "") + self.__organizer.setPluginSetting(self.name(), "output-logs-to-mod", True) + + try: + redirectOutput = self.__getRedirectOutput() + except UnknownOutputPreferenceException: + QMessageBox.critical(self.__parentWidget, self.tr("Output preference not set"), self.tr("Whether or not to output to a mod was not specified. The tool will now exit.")) + return + if redirectOutput: + try: + outputPath = self.__getOutputPath() + args.append('RedirectFiles="' + outputPath + '"') + outputModName = pathlib.Path(outputPath).name + except UnknownOutputPreferenceException: + QMessageBox.critical(self.__parentWidget, self.tr("Output mod not set"), self.tr("The mod to output to was not specified. The tool will now exit.")) + return + args.append('InstantExecute=1') + + if redirectOutput: + try: + redirectLogs = self.__getRedirectLogs() + except UnknownOutputPreferenceException: + QMessageBox.critical(self.__parentWidget, self.tr("Output preference not set"), self.tr("Whether or not to output to a mod was not specified. The tool will now exit.")) + return + if redirectLogs: + try: + outputPath = self.__getLogOutputPath() + logOutputModName = pathlib.Path(outputPath).name + except UnknownOutputPreferenceException: + QMessageBox.critical(self.__parentWidget, self.tr("Output mod not set"), self.tr("The mod to output to was not specified. The tool will now exit.")) + return + + try: + executable = self.__getFNISPath() + except FNISMissingException: + QMessageBox.critical(self.__parentWidget, self.tr("FNIS path not specified"), self.tr("The path to GenerateFNISforUsers.exe wasn't specified. The tool will now exit.")) + return + except FNISInactiveException: + # Error has already been displayed, just quit + return + + self.__organizer.setPluginSetting(self.name(), "initialised", True) + + if redirectOutput: + # Disable the output mod as USVFS isn't designed to cope with its input directories being modified + self.__organizer.modList().setActive(outputModName, False) + + if redirectLogs: + # Enable the log output mod + self.__organizer.modList().setActive(logOutputModName, True) + + + handle = self.__organizer.startApplication(executable, args, forcedCustomOverwrite=logOutputModName, ignoreCustomOverwrite=not bool(logOutputModName)) + result, exitCode = self.__organizer.waitForApplication(handle) + + if redirectOutput: + # Enable the output mod + self.__organizer.modList().setActive(outputModName, True) + # Ensure the 'No valid game data' message goes away + self.__organizer.modDataChanged(self.__organizer.getMod(outputModName)) + + if redirectLogs: + self.__organizer.modDataChanged(self.__organizer.getMod(logOutputModName)) + + def tr(self, str): + return QCoreApplication.translate("FNISTool", str) + + def __getRedirectOutput(self): + redirectOutput = bool(self.__organizer.pluginSetting(self.name(), "output-to-mod")) + initialised = bool(self.__organizer.pluginSetting(self.name(), "initialised")) + if not initialised: + result = QMessageBox.question(self.__parentWidget, self.tr("Output to a mod?"), self.tr("Fore's New Idles in Skyrim can output either to Mod Organizer's VFS (potentially overwriting files from multiple mods) or to a separate mod. Would you like FNIS to output to a separate mod? This setting can be updated in the Plugins tab of the Mod Organizer Settings menu."), QMessageBox.StandardButton(QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No | QMessageBox.StandardButton.Cancel)) + if result == QMessageBox.StandardButton.Yes: + redirectOutput = True + elif result == QMessageBox.StandardButton.No: + redirectOutput = False + else: + # the user pressed cancel + raise UnknownOutputPreferenceException + + self.__organizer.setPluginSetting(self.name(), "output-to-mod", redirectOutput) + return redirectOutput + + def __getRedirectLogs(self): + redirectLogs = bool(self.__organizer.pluginSetting(self.name(), "output-logs-to-mod")) + initialised = bool(self.__organizer.pluginSetting(self.name(), "initialised")) + if not initialised: + result = QMessageBox.question(self.__parentWidget, self.tr("Output logs to a mod?"), self.tr("Any new logs generated when running FNIS will end up in Mod Organizer's overwrite folder. Would you like these logs to be output to a separate mod? This setting can be updated in the Plugins tab of the Mod Organizer Settings menu."), QMessageBox.StandardButton(QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No | QMessageBox.StandardButton.Cancel)) + if result == QMessageBox.StandardButton.Yes: + redirectLogs = True + elif result == QMessageBox.StandardButton.No: + redirectLogs = False + else: + # the user pressed cancel + raise UnknownOutputPreferenceException + + self.__organizer.setPluginSetting(self.name(), "output-logs-to-mod", redirectLogs) + return redirectLogs + + def __getOutputPath(self): + path = self.__organizer.pluginSetting(self.name(), "output-path") + pathlibPath = pathlib.Path(path) + modDirectory = self.__getModDirectory() + isAMod = pathlibPath.parent.samefile(modDirectory) + if not pathlibPath.is_dir() or not isAMod: + QMessageBox.information(self.__parentWidget, self.tr("Choose an output mod"), self.tr("Please choose an output mod for Fore's New Idles in Skyrim. This must be a directory in Mod Organizer's mods directory, and you can create one if you do not have one already. This mod will not be available to the VFS when FNIS is run, so do not choose a mod you use for anything else. This setting can be updated in the Plugins tab of the Mod Organizer Settings menu.")) + while not pathlibPath.is_dir() or not isAMod: + path = QFileDialog.getExistingDirectory(self.__parentWidget, self.tr("Choose an output mod"), str(modDirectory), QFileDialog.Option.ShowDirsOnly) + if not path: + # cancel was pressed + raise UnknownOutputPreferenceException + pathlibPath = pathlib.Path(path) + isAMod = pathlibPath.parent.samefile(modDirectory) + if not isAMod: + QMessageBox.information(self.__parentWidget, self.tr("Not a mod..."), self.tr("The selected directory is not a Mod Organizer managed mod. Please choose a directory within the mods directory.")) + continue + empty = True + for item in pathlibPath.iterdir(): + if item.name != "meta.ini": + empty = False + break + if not empty: + if QMessageBox.question(self.__parentWidget, self.tr("Mod not empty"), self.tr("The selected mod already contains files. Are you sure want to use it as the output mod?"), QMessageBox.StandardButton(QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No)) == QMessageBox.StandardButton.Yes: + # Proceed normally - the user is happy + pass + else: + # Restart outer loop - the user wants to pick again + isAMod = False + # The user may have created a new mod in the MO mods directory, so we must trigger a refresh + self.__organizer.refreshModList() + self.__organizer.setPluginSetting(self.name(), "output-path", path) + return path + + def __getLogOutputPath(self): + path = self.__organizer.pluginSetting(self.name(), "output-logs-path") + pathlibPath = pathlib.Path(path) + modDirectory = self.__getModDirectory() + fnisOutputPath = pathlib.Path(self.__getOutputPath()) + isAMod = pathlibPath.parent.samefile(modDirectory) + isSameAsFnisOutput = pathlibPath.samefile(fnisOutputPath) + if not pathlibPath.is_dir() or not isAMod or isSameAsFnisOutput: + QMessageBox.information(self.__parentWidget, self.tr("Choose an output mod"), self.tr("Please choose an output mod for logs for Fore's New Idles in Skyrim. This must be a directory in Mod Organizer's mods directory, must not be the same as the FNIS output mod, and you can create one if you do not have one already. This setting can be updated in the Plugins tab of the Mod Organizer Settings menu.")) + while not pathlibPath.is_dir() or not isAMod or isSameAsFnisOutput: + path = QFileDialog.getExistingDirectory(self.__parentWidget, self.tr("Choose a log output mod"), str(modDirectory), QFileDialog.Option.ShowDirsOnly) + if not path: + # cancel was pressed + raise UnknownOutputPreferenceException + pathlibPath = pathlib.Path(path) + isAMod = pathlibPath.parent.samefile(modDirectory) + if not isAMod: + QMessageBox.information(self.__parentWidget, self.tr("Not a mod..."), self.tr("The selected directory is not a Mod Organizer managed mod. Please choose a directory within the mods directory.")) + continue + isSameAsFnisOutput = pathlibPath.samefile(fnisOutputPath) + if isSameAsFnisOutput: + QMessageBox.information(self.__parentWidget, self.tr("Same as FNIS output"), self.tr("The selected mod is the same as the FNIS output mod. Please choose a different mod.")) + continue + empty = True + for item in pathlibPath.iterdir(): + if item.name != "meta.ini": + empty = False + break + if not empty: + if QMessageBox.question(self.__parentWidget, self.tr("Mod not empty"), self.tr("The selected mod already contains files. Are you sure want to use it as the output mod?"), QMessageBox.StandardButton(QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No)) == QMessageBox.StandardButton.Yes: + # Proceed normally - the user is happy + pass + else: + # Restart outer loop - the user wants to pick again + isAMod = False + + # The user may have created a new mod in the MO mods directory, so we must trigger a refresh + self.__organizer.refreshModList() + self.__organizer.setPluginSetting(self.name(), "output-logs-path", path) + return path + + def __getFNISPath(self): + savedPath = self.__organizer.pluginSetting(self.name(), "fnis-path") + # FNIS must be installed within the game's data directory, so needs to either be within that or a mod folder + modDirectory = self.__getModDirectory() + gameDataDirectory = pathlib.Path(self.__organizer.managedGame().dataDirectory().absolutePath()) + pathlibPath = pathlib.Path(savedPath) + inGoodLocation = self.__withinDirectory(pathlibPath, modDirectory) + inGoodLocation |= self.__withinDirectory(pathlibPath, gameDataDirectory) + if not pathlibPath.is_file() or not inGoodLocation: + QMessageBox.information(self.__parentWidget, self.tr("Find FNIS"), self.tr("Fore's New Idles in Skyrim can't be found using the location saved in Mod Organizer's settings. Please find GenerateFNISforUsers.exe in the file picker. FNIS must be visible within the VFS, so choose an installation either within the game's data directory or within a mod folder. This setting can be updated in the Plugins tab of the Mod Organizer Settings menu.")) + while True: + path = QFileDialog.getOpenFileName(self.__parentWidget, self.tr("Locate GenerateFNISforUsers.exe"), str(modDirectory), "FNIS (GenerateFNISforUsers.exe)")[0] + if path == "": + # Cancel was pressed + raise FNISMissingException + pathlibPath = pathlib.Path(path) + inGoodLocation = self.__withinDirectory(pathlibPath, modDirectory) + inGoodLocation |= self.__withinDirectory(pathlibPath, gameDataDirectory) + if pathlibPath.is_file() and inGoodLocation: + self.__organizer.setPluginSetting(self.name(), "fnis-path", path) + savedPath = path + break + else: + QMessageBox.information(self.__parentWidget, self.tr("Not a compatible location..."), self.tr("Fore's New Idles in Skyrim only works when within the VFS, so must be installed to the game's data directory or within a mod folder. Please select a different FNIS installation.")) + # Check the mod is actually enabled + if self.__withinDirectory(pathlibPath, modDirectory): + fnisModName = None + for path in pathlibPath.parents: + if path.parent.samefile(modDirectory): + fnisModName = path.name + break + if (self.__organizer.modList().state(fnisModName) & mobase.ModState.active) == 0: + # FNIS is installed to an inactive mod + result = QMessageBox.question(self.__parentWidget, self.tr("FNIS mod deactivated"), self.tr("Fore's New Idles in Skyrim is installed to an inactive mod. Press OK to activate it or Cancel to quit the tool"), QMessageBox.StandardButton(QMessageBox.StandardButton.Ok | QMessageBox.StandardButton.Cancel)) + if result == QMessageBox.StandardButton.Ok: + self.__organizer.modList().setActive(fnisModName, True) + else: + raise FNISInactiveException + return savedPath + + def __getModDirectory(self): + return self.__organizer.modsPath() + + @staticmethod + def __withinDirectory(innerPath, outerDir): + for path in innerPath.parents: + if path.samefile(outerDir): + return True + return False + +def createPlugin(): + return FNISTool() diff --git a/libs/fnistool/src/FNISToolReset.py b/libs/fnistool/src/FNISToolReset.py new file mode 100644 index 0000000..d1f4bc9 --- /dev/null +++ b/libs/fnistool/src/FNISToolReset.py @@ -0,0 +1,76 @@ +import os +import sys + +from FNISTool import FNISTool +from PyQt6.QtCore import QFileInfo, QCoreApplication +from PyQt6.QtGui import QFileSystemModel, QIcon +from PyQt6.QtWidgets import QMessageBox + +import mobase + +class FNISToolReset(mobase.IPluginTool): + def __init__(self): + super(FNISToolReset, self).__init__() + self.__organizer = None + self.__parentWidget = None + + def init(self, organizer): + self.__organizer = organizer + return True + + def name(self): + return "FNIS Integration Tool Reset" + + def localizedName(self): + return self.tr("FNIS Integration Tool Reset") + + def author(self): + return "LostDragonist" + + def description(self): + return self.tr("Provides an easier way to reset the FNIS integration tool settings when needed.") + + def version(self): + return mobase.VersionInfo(1, 0, 0, 0) + + def master(self): + return "FNIS Integration Tool" + + def settings(self): + return [] + + def displayName(self): + return self.tr("FNIS/Reset FNIS Settings") + + def tooltip(self): + return self.description() + + def icon(self): + fnisPath = self.__organizer.pluginSetting(self.__mainToolName(), "fnis-path") + if os.path.exists(fnisPath): + # We can't directly grab the icon from an executable, but this seems like the simplest alternative. + fin = QFileInfo(fnisPath) + model = QFileSystemModel() + model.setRootPath(fin.path()) + return model.fileIcon(model.index(fin.filePath())) + else: + # Fall back to where the user might have put an icon manually. + return QIcon("plugins/FNIS.ico") + + def setParentWidget(self, widget): + self.__parentWidget = widget + + def display(self): + result = QMessageBox.question(self.__parentWidget, self.tr("Reset settings?"), self.tr("Would you like to reset the options that pop up when you first ran \"{}\"?").format(self.__mainToolName())) + if result == QMessageBox.StandardButton.Yes: + self.__organizer.setPluginSetting(self.__mainToolName(), "initialised", False) + + def tr(self, str): + return QCoreApplication.translate("FNISToolReset", str) + + @staticmethod + def __mainToolName(): + return FNISTool().name() + +def createPlugin(): + return FNISToolReset() diff --git a/libs/fnistool/src/FNISTool_en.ts b/libs/fnistool/src/FNISTool_en.ts new file mode 100644 index 0000000..9ccdbee --- /dev/null +++ b/libs/fnistool/src/FNISTool_en.ts @@ -0,0 +1,295 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE TS> +<TS version="2.0"> + <context> + <name>FNISPatches</name> + <message> + <location filename="FNISPatches.py" line="73" /> + <source>FNISPatches plugin requires a Python 3 interpreter, but is running on a Python 2 interpreter.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISPatches.py" line="74" /> + <source>Incompatible Python version.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISPatches.py" line="74" /> + <source>This version of the FNIS Patches plugin requires a Python 3 interpreter, but Mod Organizer has provided a Python 2 interpreter. You should check for an updated version, including in the Mod Organizer 2 Development Discord Server.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISPatches.py" line="82" /> + <source>FNIS Patches Tool</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISPatches.py" line="103" /> + <location filename="FNISPatches.py" line="88" /> + <source>Configures the patches which FNIS applies to the game.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISPatches.py" line="100" /> + <source>FNIS/Configure FNIS Patches</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISPatches.py" line="130" /> + <source>Select Patches</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISPatches.py" line="132" /> + <source>Note: Some patches may be automatically enabled or disabled by Fore's New Idles in Skyrim, so don't be surprised if its list differs from this one.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISPatches.py" line="183" /> + <source>Unable to find FNIS</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISPatches.py" line="183" /> + <source>Fore's New Idles in Skyrim can't be found using the location saved in Mod Organizer's settings. Please run the main FNIS integration tool before using this one.</source> + <translation type="unfinished" /> + </message> + </context> + <context> + <name>FNISTool</name> + <message> + <location filename="FNISTool.py" line="47" /> + <source>FNISTool plugin requires a Python 3 interpreter, but is running on a Python 2 interpreter.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="48" /> + <source>Incompatible Python version.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="48" /> + <source>This version of the FNIS Integration plugin requires a Python 3 interpreter, but Mod Organizer has provided a Python 2 interpreter. You should check for an updated version, including in the Mod Organizer 2 Development Discord Server.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="56" /> + <source>FNIS Integration Tool</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="90" /> + <location filename="FNISTool.py" line="62" /> + <source>Runs GenerateFNISforUsers.exe so the game can load custom animations.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="78" /> + <source>Path to GenerateFNISforUsers.exe</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="79" /> + <source>Whether or not to direct the FNIS output to a mod folder.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="80" /> + <source>When output-to-mod is enabled, the path to the mod to use.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="81" /> + <source>Settings have been initialised. Set to False to reinitialise them.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="82" /> + <source>Whether or not to direct any new FNIS logs to a mod folder.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="83" /> + <source>When output-logs-to-mod is enabled, the path to the mod to use.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="87" /> + <source>FNIS/Run FNIS</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="139" /> + <location filename="FNISTool.py" line="123" /> + <source>Output preference not set</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="139" /> + <location filename="FNISTool.py" line="123" /> + <source>Whether or not to output to a mod was not specified. The tool will now exit.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="146" /> + <location filename="FNISTool.py" line="131" /> + <source>Output mod not set</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="146" /> + <location filename="FNISTool.py" line="131" /> + <source>The mod to output to was not specified. The tool will now exit.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="152" /> + <source>FNIS path not specified</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="152" /> + <source>The path to GenerateFNISforUsers.exe wasn't specified. The tool will now exit.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="188" /> + <source>Output to a mod?</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="188" /> + <source>Fore's New Idles in Skyrim can output either to Mod Organizer's VFS (potentially overwriting files from multiple mods) or to a separate mod. Would you like FNIS to output to a separate mod? This setting can be updated in the Plugins tab of the Mod Organizer Settings menu.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="204" /> + <source>Output logs to a mod?</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="204" /> + <source>Any new logs generated when running FNIS will end up in Mod Organizer's overwrite folder. Would you like these logs to be output to a separate mod? This setting can be updated in the Plugins tab of the Mod Organizer Settings menu.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="258" /> + <location filename="FNISTool.py" line="224" /> + <location filename="FNISTool.py" line="222" /> + <source>Choose an output mod</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="222" /> + <source>Please choose an output mod for Fore's New Idles in Skyrim. This must be a directory in Mod Organizer's mods directory, and you can create one if you do not have one already. This mod will not be available to the VFS when FNIS is run, so do not choose a mod you use for anything else. This setting can be updated in the Plugins tab of the Mod Organizer Settings menu.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="267" /> + <location filename="FNISTool.py" line="231" /> + <source>Not a mod...</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="267" /> + <location filename="FNISTool.py" line="231" /> + <source>The selected directory is not a Mod Organizer managed mod. Please choose a directory within the mods directory.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="279" /> + <location filename="FNISTool.py" line="239" /> + <source>Mod not empty</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="279" /> + <location filename="FNISTool.py" line="239" /> + <source>The selected mod already contains files. Are you sure want to use it as the output mod?</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="258" /> + <source>Please choose an output mod for logs for Fore's New Idles in Skyrim. This must be a directory in Mod Organizer's mods directory, must not be the same as the FNIS output mod, and you can create one if you do not have one already. This setting can be updated in the Plugins tab of the Mod Organizer Settings menu.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="260" /> + <source>Choose a log output mod</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="271" /> + <source>Same as FNIS output</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="271" /> + <source>The selected mod is the same as the FNIS output mod. Please choose a different mod.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="300" /> + <source>Find FNIS</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="300" /> + <source>Fore's New Idles in Skyrim can't be found using the location saved in Mod Organizer's settings. Please find GenerateFNISforUsers.exe in the file picker. FNIS must be visible within the VFS, so choose an installation either within the game's data directory or within a mod folder. This setting can be updated in the Plugins tab of the Mod Organizer Settings menu.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="302" /> + <source>Locate GenerateFNISforUsers.exe</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="314" /> + <source>Not a compatible location...</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="314" /> + <source>Fore's New Idles in Skyrim only works when within the VFS, so must be installed to the game's data directory or within a mod folder. Please select a different FNIS installation.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="324" /> + <source>FNIS mod deactivated</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISTool.py" line="324" /> + <source>Fore's New Idles in Skyrim is installed to an inactive mod. Press OK to activate it or Cancel to quit the tool</source> + <translation type="unfinished" /> + </message> + </context> + <context> + <name>FNISToolReset</name> + <message> + <location filename="FNISToolReset.py" line="25" /> + <source>FNIS Integration Tool Reset</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISToolReset.py" line="31" /> + <source>Provides an easier way to reset the FNIS integration tool settings when needed.</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISToolReset.py" line="43" /> + <source>FNIS/Reset FNIS Settings</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISToolReset.py" line="64" /> + <source>Reset settings?</source> + <translation type="unfinished" /> + </message> + <message> + <location filename="FNISToolReset.py" line="64" /> + <source>Would you like to reset the options that pop up when you first ran "{}"?</source> + <translation type="unfinished" /> + </message> + </context> +</TS> diff --git a/libs/fnistool/vcpkg.json b/libs/fnistool/vcpkg.json new file mode 100644 index 0000000..7627c1f --- /dev/null +++ b/libs/fnistool/vcpkg.json @@ -0,0 +1,15 @@ +{ + "features": { + "standalone": { + "description": "Build Standalone.", + "dependencies": ["mo2-cmake"] + } + }, + "vcpkg-configuration": { + "default-registry": { + "kind": "git", + "repository": "https://github.com/ModOrganizer2/vcpkg-registry", + "baseline": "c55e3ab33eb170aefb1904ded8809cb88df6bb48" + } + } +} |