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..04b8b60 --- /dev/null +++ b/README.md @@ -0,0 +1,198 @@ +# TC KubeJS Bridge (tckubejsbridge) + +将 **神秘时代4(Thaumcraft 4 移植版)** 的配方系统桥接到 **KubeJS**,让整合包作者/服务器管理员 +可以在 KubeJS 脚本中直接注册 TC 的注魔、炼金、奥术合成配方以及物品固有要素,并支持**替换原有配方**。 + +作者:AlkSur | 许可证:GPL-3.0 + +## 依赖 + +| Mod | 版本 | 关系 | +|---|---|---| +| NeoForge | 21.1.234 | 必需 | +| Minecraft | 1.21.1 | 必需 | +| Thaumcraft (TC4 移植版) | 0.2.2.34-port.1 | 必需 | +| KubeJS (NeoForge) | 2101.7.x | 必需(插件依赖其 API) | + +> 本 mod 与 KubeJS 为**可选依赖关系**(mods.toml 中 `kubejs` 标记为 optional): +> 未安装 KubeJS 时本 mod 不加载插件部分,不影响游戏启动。 + +## 构建 + +工程位于 `modules/tc-kubejs-bridge`,属多 module Gradle 工程: + +```bash +# 在仓库根目录执行 +gradle :tckubejsbridge:build +``` + +产物:`modules/tc-kubejs-bridge/build/libs/KubeJS Thaumcraft-+.jar` +(例:`KubeJS Thaumcraft-1.0.0+21.1.234.jar`) + +编译依赖(本地 jar,路径在 `build.gradle` 中可改): +- KubeJS:`F:/downloads/kubejs-neoforge-2101.7.2-build.368.jar` +- Rhino:`F:/downloads/rhino-2101.2.7-build.81.jar`(KubeJS 的脚本引擎) +- Thaumcraft:`modules/thaumicenergistics-neo/library/thaumcraft-0.2.2.34-port.1.jar` + +> 若本地路径不同,请修改 `build.gradle` 中 `dependencies` 的 `files(...)` 路径。 + +## 脚本用法 + +将脚本放入 `kubejs/server_scripts/`,**重启游戏生效**(见"注意事项"第 1 条)。 + +### 1. 注魔配方 + +```js +ServerEvents.recipes(event => { + event.recipes.thaumcraft.infusion( + 'MY_INFUSION', // research 键(全局唯一,用于魔导手册/去重) + 'minecraft:diamond', // 输出 + 3, // 不稳定性 + ['ignis 64', 'potentia 32'],// 源质:要素 tag + 数量 + 'minecraft:golden_apple', // 中心物品 + 'minecraft:blaze_rod', // 祭品(可多个) + 'minecraft:ender_pearl' + ); +}); +``` + +### 2. 坩埚炼金配方 + +```js +ServerEvents.recipes(event => { + event.recipes.thaumcraft.crucible( + 'MY_CRUCIBLE', + 'minecraft:diamond', + 'minecraft:coal', // 催化剂 + { aer: 16, ignis: 8 } // 对象写法 + ); +}); +``` + +### 3. 奥术有序合成配方 + +```js +ServerEvents.recipes(event => { + event.recipes.thaumcraft.arcane( + 'MY_ARCANE', + 'minecraft:diamond_sword', + ['ignis 16', 'ordo 8'], + [' I ', ' I ', ' S '], // pattern:最多 3 行 + { I: 'minecraft:iron_ingot', S: 'minecraft:stick' } + ); +}); +``` + +### 4. 奥术无序合成配方 + +```js +ServerEvents.recipes(event => { + event.recipes.thaumcraft.arcane_shapeless( + 'MY_SHAPELESS', + 'minecraft:diamond_helmet', + ['aer 8', 'aqua 8'], + 'minecraft:leather_helmet', + 'minecraft:diamond', + 'minecraft:diamond', + 'minecraft:diamond' + ); +}); +``` + +### 5. 物品固有要素 + +```js +ServerEvents.recipes(event => { + event.thaumcraft.addObjectTag('minecraft:stick', { aer: 1, ignis: 2 }); +}); +``` + +### 6. 替换(先删后注册)已有配方 + +```js +ServerEvents.recipes(event => { + // 注意:thaumcraft 是顶层绑定,不是 event.thaumcraft + thaumcraft.removeInfusion('INFUSIONPROVIDER'); // 按 research 键删除 TC 注魔配方 + // thaumcraft.removeArcane('RESEARCH_KEY'); // 按 research 键删除奥术配方 + + // 然后注册新配方,实现真正替换 + event.recipes.thaumcraft.infusion( + 'INFUSIONPROVIDER', + 'thaumicenergistics:infusion_provider', + 0, + ['auram 10'], + 'ae2:interface', + 'minecraft:oak_planks' + ); +}); +``` + +## 要素 tag 参考(TC4 移植版实际值) + +**注意:移植版的要素 tag 是拉丁文原名,不是 TC4 汉化/英文名。** + +| 要素 | tag | 要素 | tag | +|---|---|---|---| +| 风 AIR | `aer` | 土 EARTH | `terra` | +| 火 FIRE | `ignis` | 水 WATER | `aqua` | +| 秩序 ORDER | `ordo` | 混沌 ENTROPY | `perditio` | +| 虚空 VOID | `vacuos` | 光 LIGHT | `lux` | +| 天气 WEATHER | `tempestas` | 运动 MOTION | `motus` | +| 水晶 CRYSTAL | `vitreus` | 生命 LIFE | `victus` | +| 能量 ENERGY | `potentia` | 交换 EXCHANGE | `permutatio` | +| 死亡 DEATH | `mortuus` | 黑暗 DARKNESS | `tenebrae` | +| 灵魂 SOUL | `spiritus` | 异域 ELDRITCH | `alienis` | +| 魔法 MAGIC | `praecantatio` | 灵气 AURA | `auram` | +| 粘液 SLIME | `limus` | 植物 PLANT | `herba` | +| 树 TREE | `arbor` | 野兽 BEAST | `bestia` | +| 肉体 FLESH | `corpus` | 亡灵 UNDEAD | `exanimis` | +| 心智 MIND | `cognitio` | 感知 SENSES | `sensus` | +| 人类 MAN | `humanus` | 工具 TOOL | `instrumentum` | +| 贪婪 GREED | `lucrum` | 工艺 CRAFT | `fabrico` | +| 布料 CLOTH | `pannus` | 机制 MECHANISM | `machina` | + +## 注意事项 + +1. **改脚本后必须重启**,`/reload` 不生效: + - TC 配方在 `ThaumcraftApi.getCraftingRecipes()` 内存列表,KubeJS `/reload` 不清空它 + - 本 mod 的去重集合(按 research 键)也不随 `/reload` 清空 + - 若将来需要 `/reload` 支持,可在脚本中调用 `thaumcraft.clearRegistered()` 清空去重集合 +2. **research 键全局唯一**:重复键会被跳过(防止重复注册)。如需同名配方,请改键。 +3. **配方不进原版 RecipeManager**:TC 注魔/炼金/奥术配方是 TC 自己的内存列表。 + 本桥接在脚本执行时直接调用 TC API 注册,并对 KubeJS 输出无害占位配方, + 不影响其他 mod 的配方操作(schema 的 `typeOverride` 指向 `minecraft:crafting_shapeless` 以满足 KubeJS 的 serializer 查找)。 +4. **源质列表两种写法**:数组 `['ignis 64']` 或对象 `{ignis: 64}` 均可。 +5. **物品参数**:支持物品 id 字符串(`minecraft:xxx` / `ae2:xxx`)、`Item.of(...)`、物品 tag(`#minecraft:planks`)。 +6. **AE2 物品命名空间是 `ae2`**:如 AE2 接口是 `ae2:interface`,不是 `appliedenergistics2:interface`。 +7. **KubeJS 版本兼容**:桥接层基于 KubeJS 2101.7.x 的 RecipeSchema API(标注 + `@ApiStatus.Experimental`),升级 KubeJS 小版本后如遇编译错误,可能需要同步调整。 + +## 排障 + +| 现象 | 原因 | +|---|---| +| 日志 `Serializer for type thaumcraft:infusion is not found` | 缺 `typeOverride`(已内置修复,重新构建即可) | +| 日志 `Unknown aspect 'xxx'` | 要素 tag 写错,对照上面要素表 | +| 日志 `Item with ID xxx does not exist` | 物品 id 错误,注意 `ae2:` 命名空间 | +| 日志无任何 `TC-KubeJS-Bridge` 输出 | mod 未装入 mods、或脚本未放入 `server_scripts` | +| 脚本报 `event.thaumcraft is undefined` | 顶层绑定用 `thaumcraft.xxx`,不要写 `event.thaumcraft.xxx` | + +## 项目结构 + +``` +src/main/java/tckubejsbridge/ +├── TCKubeJSBridge.java // @Mod 主类 +└── kubejs/ + ├── TCKubeJSPlugin.java // KubeJS 插件:注册 schema + bindings + ├── TCRecipeKJS.java // 自定义 KubeRecipe 基类(桥接 + 占位序列化) + ├── TCRecipeBridge.java // TC API 调用 + 去重 + 移除 + 占位 JSON + ├── AspectListComponent.java // 源质列表 RecipeComponent + ├── InfusionRecipeKJS.java // 注魔配方 + ├── CrucibleRecipeKJS.java // 坩埚炼金配方 + ├── ShapedArcaneRecipeKJS.java // 奥术有序配方 + └── ShapelessArcaneRecipeKJS.java // 奥术无序配方 +src/main/resources/ +├── kubejs.plugins.txt // 插件发现文件 +└── META-INF/neoforge.mods.toml +example/infusion_example.js // 示例脚本 +``` diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 0000000..6df33b7 --- /dev/null +++ b/README_EN.md @@ -0,0 +1,207 @@ +# TC KubeJS Bridge (tckubejsbridge) + +Bridges the **Thaumcraft 4 (port)** recipe system to **KubeJS**, allowing modpack authors and +server admins to register TC infusion, crucible, arcane crafting recipes and item aspect tags +directly from KubeJS scripts — including **replacing existing recipes**. + +Author: AlkSur | License: GPL-3.0 + +## Requirements + +| Mod | Version | Relation | +|---|---|---| +| NeoForge | 21.1.234 | Required | +| Minecraft | 1.21.1 | Required | +| Thaumcraft (TC4 port) | 0.2.2.34-port.1 | Required | +| KubeJS (NeoForge) | 2101.7.x | Required (plugin depends on its API) | + +> KubeJS is declared **optional** in `neoforge.mods.toml`: without KubeJS the plugin part +> simply does not load, and the game still starts. + +## Building + +The project lives at `modules/tc-kubejs-bridge` inside a multi-module Gradle build: + +```bash +# Run from the repository root +gradle :tckubejsbridge:build +``` + +Artifact: `modules/tc-kubejs-bridge/build/libs/KubeJS Thaumcraft-+.jar` +(e.g. `KubeJS Thaumcraft-1.0.0+21.1.234.jar`) + +Compile dependencies (local jars, paths editable in `build.gradle`): +- KubeJS: `F:/downloads/kubejs-neoforge-2101.7.2-build.368.jar` +- Rhino: `F:/downloads/rhino-2101.2.7-build.81.jar` (KubeJS script engine) +- Thaumcraft: `modules/thaumicenergistics-neo/library/thaumcraft-0.2.2.34-port.1.jar` + +> Adjust the `files(...)` paths in the `dependencies` block if your local layout differs. + +## Script Usage + +Put scripts into `kubejs/server_scripts/` and **restart the game** (see Note #1). + +### 1. Infusion Recipe + +```js +ServerEvents.recipes(event => { + event.recipes.thaumcraft.infusion( + 'MY_INFUSION', // research key (globally unique; used by Thaumonomicon/dedup) + 'minecraft:diamond', // result + 3, // instability + ['ignis 64', 'potentia 32'],// aspects: aspect tag + amount + 'minecraft:golden_apple', // central item + 'minecraft:blaze_rod', // components (one or more) + 'minecraft:ender_pearl' + ); +}); +``` + +### 2. Crucible Recipe + +```js +ServerEvents.recipes(event => { + event.recipes.thaumcraft.crucible( + 'MY_CRUCIBLE', + 'minecraft:diamond', + 'minecraft:coal', // catalyst + { aer: 16, ignis: 8 } // object syntax also works + ); +}); +``` + +### 3. Shaped Arcane Recipe + +```js +ServerEvents.recipes(event => { + event.recipes.thaumcraft.arcane( + 'MY_ARCANE', + 'minecraft:diamond_sword', + ['ignis 16', 'ordo 8'], + [' I ', ' I ', ' S '], // pattern: up to 3 rows + { I: 'minecraft:iron_ingot', S: 'minecraft:stick' } + ); +}); +``` + +### 4. Shapeless Arcane Recipe + +```js +ServerEvents.recipes(event => { + event.recipes.thaumcraft.arcane_shapeless( + 'MY_SHAPELESS', + 'minecraft:diamond_helmet', + ['aer 8', 'aqua 8'], + 'minecraft:leather_helmet', + 'minecraft:diamond', + 'minecraft:diamond', + 'minecraft:diamond' + ); +}); +``` + +### 5. Item Aspect Tags + +```js +ServerEvents.recipes(event => { + event.thaumcraft.addObjectTag('minecraft:stick', { aer: 1, ignis: 2 }); +}); +``` + +### 6. Replacing an Existing Recipe (remove first, then register) + +```js +ServerEvents.recipes(event => { + // NOTE: thaumcraft is a TOP-LEVEL binding, not event.thaumcraft + thaumcraft.removeInfusion('INFUSIONPROVIDER'); // remove TC infusion recipes by research key + // thaumcraft.removeArcane('RESEARCH_KEY'); // remove arcane recipes by research key + + // then register the new recipe for a true replacement + event.recipes.thaumcraft.infusion( + 'INFUSIONPROVIDER', + 'thaumicenergistics:infusion_provider', + 0, + ['auram 10'], + 'ae2:interface', + 'minecraft:oak_planks' + ); +}); +``` + +## Aspect Tag Reference (actual values in the TC4 port) + +**Important: the port uses the original Latin tags, not the TC4 English/localized names.** + +| Aspect | Tag | Aspect | Tag | +|---|---|---|---| +| Air | `aer` | Earth | `terra` | +| Fire | `ignis` | Water | `aqua` | +| Order | `ordo` | Entropy | `perditio` | +| Void | `vacuos` | Light | `lux` | +| Weather | `tempestas` | Motion | `motus` | +| Crystal | `vitreus` | Life | `victus` | +| Energy | `potentia` | Exchange | `permutatio` | +| Death | `mortuus` | Darkness | `tenebrae` | +| Soul | `spiritus` | Eldritch | `alienis` | +| Magic | `praecantatio` | Aura | `auram` | +| Slime | `limus` | Plant | `herba` | +| Tree | `arbor` | Beast | `bestia` | +| Flesh | `corpus` | Undead | `exanimis` | +| Mind | `cognitio` | Senses | `sensus` | +| Man | `humanus` | Tool | `instrumentum` | +| Greed | `lucrum` | Craft | `fabrico` | +| Cloth | `pannus` | Mechanism | `machina` | + +## Notes + +1. **Restart after editing scripts — `/reload` does NOT work**: + - TC recipes live in the `ThaumcraftApi.getCraftingRecipes()` in-memory list, which KubeJS + `/reload` never clears. + - This mod's dedup set (keyed by research) is also not cleared on `/reload`. + - If you need `/reload` support later, call `thaumcraft.clearRegistered()` in the script + to reset the dedup set. +2. **Research keys are globally unique**: duplicate keys are skipped (prevents double + registration). Use a different key for same-name recipes. +3. **Recipes do NOT go into the vanilla RecipeManager**: TC infusion/crucible/arcane recipes + live in TC's own in-memory list. The bridge calls the TC API directly during script + execution and emits a harmless placeholder recipe to KubeJS, so it does not affect other + mods' recipe operations. (The schema uses `typeOverride = minecraft:crafting_shapeless` + so KubeJS can find a serializer.) +4. **Aspect lists accept two syntaxes**: array `['ignis 64']` or object `{ignis: 64}`. +5. **Item arguments** accept: item id strings (`minecraft:xxx` / `ae2:xxx`), `Item.of(...)`, + and item tags (`#minecraft:planks`). +6. **AE2's namespace is `ae2`**: e.g. the AE2 interface is `ae2:interface`, + NOT `appliedenergistics2:interface`. +7. **KubeJS version compatibility**: the bridge is built on KubeJS 2101.7.x RecipeSchema API + (marked `@ApiStatus.Experimental`). Upgrading KubeJS to another patch version may require + adjustments to the bridge layer. + +## Troubleshooting + +| Symptom | Cause | +|---|---| +| Log shows `Serializer for type thaumcraft:infusion is not found` | Missing `typeOverride` (already fixed in code; rebuild) | +| Log shows `Unknown aspect 'xxx'` | Wrong aspect tag — check the aspect table above | +| Log shows `Item with ID xxx does not exist` | Wrong item id — remember the `ae2:` namespace | +| No `TC-KubeJS-Bridge` lines in the log at all | Mod not installed, or script not in `server_scripts` | +| Script reports `event.thaumcraft is undefined` | Use the top-level `thaumcraft.xxx`, not `event.thaumcraft.xxx` | + +## Project Layout + +``` +src/main/java/tckubejsbridge/ +├── TCKubeJSBridge.java // @Mod main class +└── kubejs/ + ├── TCKubeJSPlugin.java // KubeJS plugin: schemas + bindings + ├── TCRecipeKJS.java // Custom KubeRecipe base (bridge + placeholder serialization) + ├── TCRecipeBridge.java // TC API calls + dedup + removal + placeholder JSON + ├── AspectListComponent.java // Aspect list RecipeComponent + ├── InfusionRecipeKJS.java // Infusion recipe + ├── CrucibleRecipeKJS.java // Crucible recipe + ├── ShapedArcaneRecipeKJS.java // Shaped arcane recipe + └── ShapelessArcaneRecipeKJS.java // Shapeless arcane recipe +src/main/resources/ +├── kubejs.plugins.txt // Plugin discovery file +└── META-INF/neoforge.mods.toml +example/infusion_example.js // Example script +``` diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..91d642c --- /dev/null +++ b/build.gradle @@ -0,0 +1,60 @@ +plugins { + id 'net.neoforged.moddev' version '2.0.78' +} + +repositories { + mavenCentral() + def localRepository = mavenLocal() + remove(localRepository) + add(0, localRepository) + // KubeJS / Rhino 官方 maven(备用,当前用本地 jar) + maven { url = 'https://maven.latvian.dev/releases' } +} + +version = "${mod_version}+${neoforge_version}" +group = mod_group + +base { archivesName = "KubeJS Thaumcraft" } + +java { + toolchain.languageVersion = JavaLanguageVersion.of(21) +} + +neoForge { + version = neoforge_version + runs { + client { client() } + server { server() } + } + mods { "${mod_id}" { sourceSet sourceSets.main } } +} + +dependencies { + // KubeJS 本地 jar(compileOnly:仅编译期引用,运行时由 KubeJS mod 提供) + compileOnly files('library/kubejs-neoforge-2101.7.2-build.368.jar') + // Rhino(KubeJS 依赖脚本引擎,2101.7.2 对应 2101.2.7-build.81) + compileOnly files('library/rhino-2101.2.7-build.81.jar') + // Thaumcraft 移植版(本地 jar) + compileOnly files('library/thaumcraft-0.2.2.34-port.1.jar') +} + +tasks.withType(JavaCompile).configureEach { + it.options.encoding = 'UTF-8' + it.options.release = 21 +} + +def loaderRange = project.findProperty('loader_version_range') ?: '[4,)' +def neoforgeRange = project.findProperty('neoforge_version_range') ?: '[21,)' +def mcRange = project.findProperty('minecraft_version_range') ?: '[1.21.1,1.22)' +def modVersion = mod_version + +processResources { + filesMatching('META-INF/neoforge.mods.toml') { + expand([ + 'version': modVersion, 'loader_version_range': loaderRange, + 'neoforge_version_range': neoforgeRange, 'minecraft_version_range': mcRange + ]) + } +} + +jar { duplicatesStrategy = DuplicatesStrategy.EXCLUDE } diff --git a/example/infusion_example.js b/example/infusion_example.js new file mode 100644 index 0000000..d35f840 --- /dev/null +++ b/example/infusion_example.js @@ -0,0 +1,93 @@ +// ============================================================ +// TC KubeJS Bridge — 示例脚本 +// 放置到 kubejs/server_scripts/ 目录后【重启游戏】生效(/reload 不生效) +// +// 依赖:thaumcraft(TC4 移植版)、kubejs、tckubejsbridge +// ============================================================ + +// ---------- 1. 注魔配方 ---------- +// event.recipes.thaumcraft.infusion(research, result, instability, aspects, central, ...components) +ServerEvents.recipes(event => { + event.recipes.thaumcraft.infusion( + 'EXAMPLE_INFUSION', // research 键(用于魔导手册展示/去重) + 'minecraft:diamond', // 输出物品 + 3, // 不稳定性 + ['ignis 64', 'potentia 32'], // 所需源质(要素 tag + 数量,见 README 要素表) + 'minecraft:golden_apple', // 中心物品 + 'minecraft:blaze_rod', // 祭品 1 + 'minecraft:nether_star', // 祭品 2 + 'minecraft:ender_pearl' // 祭品 3 + ); +}); + +// ---------- 2. 坩埚炼金配方 ---------- +// event.recipes.thaumcraft.crucible(research, result, catalyst, aspects) +ServerEvents.recipes(event => { + event.recipes.thaumcraft.crucible( + 'EXAMPLE_CRUCIBLE', + 'minecraft:diamond', + 'minecraft:coal', // 催化剂(物品 id) + { aer: 16, ignis: 8 } // 对象写法也可 + ); +}); + +// ---------- 3. 奥术有序合成配方 ---------- +// event.recipes.thaumcraft.arcane(research, result, aspects, pattern, key) +ServerEvents.recipes(event => { + event.recipes.thaumcraft.arcane( + 'EXAMPLE_ARCANE', + 'minecraft:diamond_sword', + ['ignis 16', 'ordo 8'], + [' I ', ' I ', ' S '], // pattern:3 行字符串 + { + I: 'minecraft:iron_ingot', + S: 'minecraft:stick' + } + ); +}); + +// ---------- 4. 奥术无序合成配方 ---------- +// event.recipes.thaumcraft.arcane_shapeless(research, result, aspects, ...ingredients) +ServerEvents.recipes(event => { + event.recipes.thaumcraft.arcane_shapeless( + 'EXAMPLE_ARCANE_SHAPELESS', + 'minecraft:diamond_helmet', + ['aer 8', 'aqua 8'], + 'minecraft:leather_helmet', + 'minecraft:diamond', + 'minecraft:diamond', + 'minecraft:diamond' + ); +}); + +// ---------- 5. 物品固有要素 ---------- +// event.thaumcraft.addObjectTag(item, aspects) +ServerEvents.recipes(event => { + event.thaumcraft.addObjectTag( + 'minecraft:stick', + { aer: 1, ignis: 2 } + ); +}); + +// ---------- 6. 替换已有配方(先删后注册) ---------- +// 例:简化"注魔供应器"配方 —— 中心 AE2 接口 + 10 灵气 + 1 橡木木板 +// 注意:thaumcraft 是顶层绑定,不要写 event.thaumcraft +ServerEvents.recipes(event => { + thaumcraft.removeInfusion('INFUSIONPROVIDER'); // 删除原配方(8 祭品复杂版) + + event.recipes.thaumcraft.infusion( + 'INFUSIONPROVIDER', + 'thaumicenergistics:infusion_provider', + 0, + ['auram 10'], + 'ae2:interface', + 'minecraft:oak_planks' + ); +}); + +// ---------- 提示 ---------- +// - research 键全局唯一:重复键会被跳过(防止重复注册) +// - 要素 tag 用 TC4 移植版的拉丁文原名(aer/ignis/aqua/terra/ordo/perditio/vacuos/lux/motus/potentia/auram 等), +// 完整表见 README +// - 物品 id 支持 AE2 命名空间 ae2:xxx(如 ae2:interface) +// - 改脚本后必须重启游戏,/reload 不生效(TC 配方在内存列表) diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..58aac27 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,30 @@ +# Project +mod_version=1.0.0 +mod_group=tckubejsbridge + +# Mod +mod_name=KubeJS Thaumcraft +mod_id=tckubejsbridge +mod_author=AlkSur + +# Shared (must match root gradle.properties) +minecraft_version=1.21.1 +neoforge_version=21.1.234 + +# Dependency versions +thaumcraft_version=0.2.2.34-port.1 +kubejs_version=2101.7.2 +rhino_version=2101.2.7-build.81 +org.gradle.jvmargs=-Xmx2G +org.gradle.daemon=true +org.gradle.parallel=true +org.gradle.caching=true +org.gradle.configuration-cache=true +minecraft_version_range=[1.21.1,1.22) +neoforge_version_range=[21,) +loader_version_range=[4,) +systemProp.http.proxyHost=127.0.0.1 +systemProp.http.proxyPort=7890 +systemProp.https.proxyHost=127.0.0.1 +systemProp.https.proxyPort=7890 +systemProp.http.nonProxyHosts=localhost|127.* diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..a4b76b9 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..e18bc25 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..f3b75f3 --- /dev/null +++ b/gradlew @@ -0,0 +1,251 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..9d21a21 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..0aacb99 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,9 @@ +pluginManagement { + repositories { + mavenLocal() + gradlePluginPortal() + maven { url = 'https://maven.neoforged.net/releases' } + } +} + +rootProject.name = "tc-kubejs-bridge" diff --git a/src/main/java/tckubejsbridge/TCKubeJSBridge.java b/src/main/java/tckubejsbridge/TCKubeJSBridge.java new file mode 100644 index 0000000..9b42993 --- /dev/null +++ b/src/main/java/tckubejsbridge/TCKubeJSBridge.java @@ -0,0 +1,20 @@ +package tckubejsbridge; + +import net.neoforged.fml.common.Mod; + +/** + * TC KubeJS Bridge — 将神秘时代4(Thaumcraft 4 移植版)的配方系统桥接到 KubeJS。 + * + * 提供 KubeJS 脚本可调用的: + * - event.recipes.thaumcraft.infusion(...) 注魔配方 + * - event.recipes.thaumcraft.crucible(...) 坩埚炼金配方 + * - event.recipes.thaumcraft.arcane(...) 奥术有序合成配方 + * - event.recipes.thaumcraft.arcane_shapeless(...) 奥术无序合成配方 + * - event.thaumcraft.addObjectTag(...) 物品固有要素 + * + * 实际注册逻辑在 {@link tckubejsbridge.kubejs.TCKubeJSPlugin}(KubeJS 插件)。 + */ +@Mod(TCKubeJSBridge.MODID) +public final class TCKubeJSBridge { + public static final String MODID = "tckubejsbridge"; +} diff --git a/src/main/java/tckubejsbridge/kubejs/AspectListComponent.java b/src/main/java/tckubejsbridge/kubejs/AspectListComponent.java new file mode 100644 index 0000000..098e325 --- /dev/null +++ b/src/main/java/tckubejsbridge/kubejs/AspectListComponent.java @@ -0,0 +1,179 @@ +package tckubejsbridge.kubejs; + +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonPrimitive; +import com.mojang.serialization.Codec; +import com.mojang.serialization.DataResult; +import dev.latvian.mods.kubejs.recipe.KubeRecipe; +import dev.latvian.mods.kubejs.recipe.RecipeKey; +import dev.latvian.mods.kubejs.recipe.component.ComponentRole; +import dev.latvian.mods.kubejs.recipe.component.RecipeComponent; +import dev.latvian.mods.kubejs.recipe.component.RecipeComponentType; +import dev.latvian.mods.kubejs.recipe.component.RecipeComponentValue; +import dev.latvian.mods.kubejs.recipe.component.SimpleRecipeComponent; +import dev.latvian.mods.kubejs.recipe.component.RecipeComponentWithCodec; +import dev.latvian.mods.kubejs.script.ConsoleJS; +import dev.latvian.mods.rhino.type.TypeInfo; +import net.minecraft.resources.ResourceLocation; +import thaumcraft.api.aspects.Aspect; +import thaumcraft.api.aspects.AspectList; + +import java.util.Map; + +/** + * 将脚本中的源质列表转换为 Thaumcraft {@link AspectList}。 + * + * 支持两种脚本写法: + *
{@code
+ * ['ignis 64', 'potentia 32']        // 字符串数组:"要素名 数量"
+ * { ignis: 64, potentia: 32 }        // 对象:{ 要素名: 数量 }
+ * }
+ */ +public final class AspectListComponent implements RecipeComponent { + + public static final AspectListComponent INSTANCE = new AspectListComponent(); + + private static final RecipeComponentType TYPE = RecipeComponentType.unit( + ResourceLocation.fromNamespaceAndPath("tckubejsbridge", "aspect_list"), + AspectListComponent.INSTANCE); + + /** 要素名 → 数量 的对象/数组 编解码(仅作序列化展示,桥接时直接读值) */ + private static final Codec CODEC = Codec.unboundedMap(Codec.STRING, Codec.INT) + .flatXmap( + map -> { + try { + return DataResult.success(fromMap(map)); + } catch (Exception e) { + return DataResult.error(() -> "Invalid aspect list: " + e.getMessage()); + } + }, + list -> { + try { + return DataResult.success(toMap(list)); + } catch (Exception e) { + return DataResult.error(() -> "Invalid aspect list: " + e.getMessage()); + } + }); + + private AspectListComponent() { + } + + @Override + public RecipeComponentType type() { + return TYPE; + } + + @Override + public Codec codec() { + return CODEC; + } + + @Override + public TypeInfo typeInfo() { + return TypeInfo.of(Object.class); + } + + @Override + public AspectList wrap(dev.latvian.mods.kubejs.recipe.RecipeScriptContext cx, Object from) { + if (from instanceof AspectList list) { + return list; + } + if (from instanceof String s) { + return parseString(s); + } + if (from instanceof java.util.List list) { + AspectList result = new AspectList(); + for (Object o : list) { + if (o instanceof String s) { + result.add(parseString(s)); + } else if (o instanceof AspectList al) { + result.add(al); + } + } + return result; + } + if (from instanceof Map map) { + return fromMap(map); + } + // 兜底:尝试从 JSON 元素解析 + if (from instanceof JsonElement json) { + if (json.isJsonObject()) { + return fromJsonObject(json.getAsJsonObject()); + } + if (json.isJsonArray()) { + AspectList result = new AspectList(); + for (JsonElement e : json.getAsJsonArray()) { + if (e.isJsonPrimitive() && e.getAsJsonPrimitive().isString()) { + result.add(parseString(e.getAsString())); + } + } + return result; + } + } + throw new IllegalArgumentException("Cannot convert " + from + " to AspectList"); + } + + private static AspectList parseString(String s) { + String[] parts = s.trim().split("\\s+"); + Aspect aspect = Aspect.getAspect(parts[0]); + if (aspect == null) { + throw new IllegalArgumentException("Unknown aspect '" + parts[0] + "'"); + } + int amount = parts.length > 1 ? Integer.parseInt(parts[1]) : 1; + return new AspectList().add(aspect, amount); + } + + private static AspectList fromMap(Map map) { + AspectList result = new AspectList(); + for (Map.Entry e : map.entrySet()) { + Aspect aspect = Aspect.getAspect(String.valueOf(e.getKey())); + if (aspect == null) { + throw new IllegalArgumentException("Unknown aspect '" + e.getKey() + "'"); + } + result.add(aspect, ((Number) e.getValue()).intValue()); + } + return result; + } + + private static AspectList fromJsonObject(JsonObject obj) { + AspectList result = new AspectList(); + for (Map.Entry e : obj.entrySet()) { + Aspect aspect = Aspect.getAspect(e.getKey()); + if (aspect == null) { + throw new IllegalArgumentException("Unknown aspect '" + e.getKey() + "'"); + } + result.add(aspect, e.getValue().getAsInt()); + } + return result; + } + + private static Map toMap(AspectList list) { + java.util.LinkedHashMap map = new java.util.LinkedHashMap<>(); + for (Aspect aspect : list.getAspects()) { + if (aspect != null) { + map.put(aspect.getTag(), list.getAmount(aspect)); + } + } + return map; + } + + @Override + public void writeToJson(KubeRecipe recipe, RecipeComponentValue cv, JsonObject json) { + JsonObject obj = new JsonObject(); + for (Aspect aspect : cv.value.getAspects()) { + if (aspect != null) { + obj.add(aspect.getTag(), new JsonPrimitive(cv.value.getAmount(aspect))); + } + } + json.add(cv.key.name, obj); + } + + @Override + public void readFromJson(KubeRecipe recipe, RecipeComponentValue cv, JsonObject json) { + JsonElement v = json.get(cv.key.name); + if (v != null && v.isJsonObject()) { + cv.value = fromJsonObject(v.getAsJsonObject()); + } + } +} diff --git a/src/main/java/tckubejsbridge/kubejs/CrucibleRecipeKJS.java b/src/main/java/tckubejsbridge/kubejs/CrucibleRecipeKJS.java new file mode 100644 index 0000000..a3bd089 --- /dev/null +++ b/src/main/java/tckubejsbridge/kubejs/CrucibleRecipeKJS.java @@ -0,0 +1,23 @@ +package tckubejsbridge.kubejs; + +import net.minecraft.world.item.ItemStack; +import thaumcraft.api.aspects.AspectList; + +/** + * 坩埚炼金配方 KubeRecipe:event.recipes.thaumcraft.crucible(research, result, catalyst, aspects) + */ +public class CrucibleRecipeKJS extends TCRecipeKJS { + + public CrucibleRecipeKJS() { + } + + @Override + protected void bridgeToTC() { + String research = getValue(TCKubeJSPlugin.RESEARCH); + ItemStack result = getValue(TCKubeJSPlugin.RESULT); + Object catalyst = getValue(TCKubeJSPlugin.CATALYST); + AspectList aspects = getValue(TCKubeJSPlugin.ASPECTS); + + TCRecipeBridge.registerCrucible(research, result, catalyst, aspects); + } +} diff --git a/src/main/java/tckubejsbridge/kubejs/InfusionRecipeKJS.java b/src/main/java/tckubejsbridge/kubejs/InfusionRecipeKJS.java new file mode 100644 index 0000000..006446c --- /dev/null +++ b/src/main/java/tckubejsbridge/kubejs/InfusionRecipeKJS.java @@ -0,0 +1,28 @@ +package tckubejsbridge.kubejs; + +import net.minecraft.world.item.ItemStack; +import thaumcraft.api.aspects.AspectList; + +import java.util.List; + +/** + * 注魔配方 KubeRecipe:event.recipes.thaumcraft.infusion(research, result, instability, aspects, central, ...components) + */ +public class InfusionRecipeKJS extends TCRecipeKJS { + + public InfusionRecipeKJS() { + } + + @Override + protected void bridgeToTC() { + String research = getValue(TCKubeJSPlugin.RESEARCH); + ItemStack result = getValue(TCKubeJSPlugin.RESULT); + int instability = getValue(TCKubeJSPlugin.INSTABILITY); + AspectList aspects = getValue(TCKubeJSPlugin.ASPECTS); + ItemStack central = getValue(TCKubeJSPlugin.CENTRAL); + List components = getValue(TCKubeJSPlugin.COMPONENTS); + + TCRecipeBridge.registerInfusion(research, result, instability, aspects, central, + components == null ? new ItemStack[0] : components.toArray(new ItemStack[0])); + } +} diff --git a/src/main/java/tckubejsbridge/kubejs/ShapedArcaneRecipeKJS.java b/src/main/java/tckubejsbridge/kubejs/ShapedArcaneRecipeKJS.java new file mode 100644 index 0000000..3f248a0 --- /dev/null +++ b/src/main/java/tckubejsbridge/kubejs/ShapedArcaneRecipeKJS.java @@ -0,0 +1,44 @@ +package tckubejsbridge.kubejs; + +import net.minecraft.world.item.ItemStack; +import thaumcraft.api.aspects.AspectList; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +/** + * 奥术有序合成配方 KubeRecipe: + * event.recipes.thaumcraft.arcane(research, result, aspects, pattern, key) + * + * 其中 pattern 为行字符串数组(如 ['ABA','BCB','ABA']), + * key 为字符→物品映射(如 {A:'minecraft:iron_ingot', B:Item.of('minecraft:gold_ingot')})。 + */ +public class ShapedArcaneRecipeKJS extends TCRecipeKJS { + + public ShapedArcaneRecipeKJS() { + } + + @Override + protected void bridgeToTC() { + String research = getValue(TCKubeJSPlugin.RESEARCH); + ItemStack result = getValue(TCKubeJSPlugin.RESULT); + AspectList aspects = getValue(TCKubeJSPlugin.ASPECTS); + List pattern = getValue(TCKubeJSPlugin.PATTERN); + dev.latvian.mods.kubejs.util.TinyMap key = getValue(TCKubeJSPlugin.KEY); + + // 组装 TC addArcaneCraftingRecipe 参数:pattern 行 + 字符/物品映射 + List args = new ArrayList<>(); + if (pattern != null) { + args.addAll(pattern); + } + if (key != null) { + for (dev.latvian.mods.kubejs.util.TinyMap.Entry e : key.entries()) { + args.add(e.key()); + args.add(e.value()); + } + } + + TCRecipeBridge.registerArcane(research, result, aspects, args.toArray()); + } +} diff --git a/src/main/java/tckubejsbridge/kubejs/ShapelessArcaneRecipeKJS.java b/src/main/java/tckubejsbridge/kubejs/ShapelessArcaneRecipeKJS.java new file mode 100644 index 0000000..65de1c2 --- /dev/null +++ b/src/main/java/tckubejsbridge/kubejs/ShapelessArcaneRecipeKJS.java @@ -0,0 +1,27 @@ +package tckubejsbridge.kubejs; + +import net.minecraft.world.item.ItemStack; +import thaumcraft.api.aspects.AspectList; + +import java.util.List; + +/** + * 奥术无序合成配方 KubeRecipe: + * event.recipes.thaumcraft.arcane_shapeless(research, result, aspects, ...ingredients) + */ +public class ShapelessArcaneRecipeKJS extends TCRecipeKJS { + + public ShapelessArcaneRecipeKJS() { + } + + @Override + protected void bridgeToTC() { + String research = getValue(TCKubeJSPlugin.RESEARCH); + ItemStack result = getValue(TCKubeJSPlugin.RESULT); + AspectList aspects = getValue(TCKubeJSPlugin.ASPECTS); + List ingredients = getValue(TCKubeJSPlugin.INGREDIENTS); + + TCRecipeBridge.registerArcaneShapeless(research, result, aspects, + ingredients == null ? new ItemStack[0] : ingredients.toArray(new ItemStack[0])); + } +} diff --git a/src/main/java/tckubejsbridge/kubejs/TCKubeJSPlugin.java b/src/main/java/tckubejsbridge/kubejs/TCKubeJSPlugin.java new file mode 100644 index 0000000..f762422 --- /dev/null +++ b/src/main/java/tckubejsbridge/kubejs/TCKubeJSPlugin.java @@ -0,0 +1,154 @@ +package tckubejsbridge.kubejs; + +import dev.latvian.mods.kubejs.plugin.KubeJSPlugin; +import dev.latvian.mods.kubejs.recipe.RecipeKey; +import dev.latvian.mods.kubejs.recipe.component.ComponentRole; +import dev.latvian.mods.kubejs.recipe.component.ItemStackComponent; +import dev.latvian.mods.kubejs.recipe.component.NumberComponent; +import dev.latvian.mods.kubejs.recipe.component.RecipeComponent; +import dev.latvian.mods.kubejs.recipe.component.RecipeComponentType; +import dev.latvian.mods.kubejs.recipe.component.RecipeComponentTypeRegistry; +import dev.latvian.mods.kubejs.recipe.component.StringComponent; +import dev.latvian.mods.kubejs.recipe.schema.KubeRecipeFactory; +import dev.latvian.mods.kubejs.recipe.schema.RecipeSchema; +import dev.latvian.mods.kubejs.recipe.schema.RecipeSchemaRegistry; +import dev.latvian.mods.kubejs.script.BindingRegistry; +import dev.latvian.mods.kubejs.script.ConsoleJS; +import net.minecraft.resources.ResourceLocation; +import net.minecraft.world.item.ItemStack; +import thaumcraft.api.aspects.AspectList; + +import java.util.List; +import java.util.Map; + +/** + * KubeJS 插件:将 Thaumcraft 配方系统桥接到 KubeJS 脚本。 + * + * 提供: + *
    + *
  • event.recipes.thaumcraft.infusion(...) — 注魔配方
  • + *
  • event.recipes.thaumcraft.crucible(...) — 坩埚炼金配方
  • + *
  • event.recipes.thaumcraft.arcane(...) — 奥术有序合成配方
  • + *
  • event.recipes.thaumcraft.arcane_shapeless(...) — 奥术无序合成配方
  • + *
  • event.thaumcraft.addObjectTag(...) — 物品固有要素
  • + *
+ * + * 发现方式:{@code kubejs.plugins.txt} 列出本类全名。 + */ +public class TCKubeJSPlugin implements KubeJSPlugin { + + // ---- 共享 RecipeKey ---- + static final RecipeKey RESEARCH = StringComponent.STRING.instance().otherKey("research").alt("key"); + static final RecipeKey RESULT = ItemStackComponent.ITEM_STACK.instance().outputKey("result"); + static final RecipeKey ASPECTS = AspectListComponent.INSTANCE.otherKey("aspects").alt("aspect"); + static final RecipeKey INSTABILITY = NumberComponent.INT.otherKey("instability"); + + // 注魔 + static final RecipeKey CENTRAL = ItemStackComponent.ITEM_STACK.instance().inputKey("central"); + static final RecipeKey> COMPONENTS = ItemStackComponent.ITEM_STACK.instance().asListOrSelf().inputKey("components"); + + // 坩埚:催化剂接受任意对象(脚本传物品 id 字符串或 ItemStack,由自定义组件解析) + static final RecipeKey CATALYST = ObjectCatalystComponent.INSTANCE.otherKey("catalyst"); + + // 奥术有序 + static final RecipeKey> PATTERN = StringComponent.STRING.instance().asList().otherKey("pattern"); + static final RecipeKey> KEY = + ItemStackComponent.ITEM_STACK.instance().asPatternKey().otherKey("key"); + + // 奥术无序 + static final RecipeKey> INGREDIENTS = ItemStackComponent.ITEM_STACK.instance().asListOrSelf().inputKey("ingredients"); + + /** 坩埚催化剂组件:接受任意脚本对象,桥接时转换为 TC 期望的 Object(ItemStack/TagKey/Ingredient) */ + static final class ObjectCatalystComponent implements RecipeComponent { + static final ObjectCatalystComponent INSTANCE = new ObjectCatalystComponent(); + private static final RecipeComponentType TYPE = RecipeComponentType.unit( + ResourceLocation.fromNamespaceAndPath("tckubejsbridge", "object_catalyst"), INSTANCE); + + @Override public RecipeComponentType type() { return TYPE; } + @Override public com.mojang.serialization.Codec codec() { + return com.mojang.serialization.Codec.STRING.xmap( + s -> s, o -> String.valueOf(o)); + } + @Override public dev.latvian.mods.rhino.type.TypeInfo typeInfo() { + return dev.latvian.mods.rhino.type.TypeInfo.of(Object.class); + } + @Override public Object wrap(dev.latvian.mods.kubejs.recipe.RecipeScriptContext cx, Object from) { + return from; + } + } + + @Override + public void registerRecipeComponents(RecipeComponentTypeRegistry registry) { + registry.register(AspectListComponent.INSTANCE.type()); + registry.register(ObjectCatalystComponent.TYPE); + } + + @Override + public void registerRecipeSchemas(RecipeSchemaRegistry registry) { + var tc = registry.namespace("thaumcraft"); + // typeOverride 指向真实存在的 serializer:TC 配方不走原版 RecipeManager, + // 但 KubeJS 创建配方对象时要求 serializer 存在于 BuiltInRegistries.RECIPE_SERIALIZER, + // 否则抛 "Serializer for type X is not found"。桥接后输出占位 JSON,故用 minecraft:crafting_shapeless。 + var vanillaType = ResourceLocation.withDefaultNamespace("crafting_shapeless"); + + tc.register("infusion", new RecipeSchema( + RESEARCH, RESULT, INSTABILITY, ASPECTS, CENTRAL, COMPONENTS) + .typeOverride(vanillaType) + .factory(new KubeRecipeFactory( + ResourceLocation.fromNamespaceAndPath("tckubejsbridge", "infusion"), + InfusionRecipeKJS.class, InfusionRecipeKJS::new))); + + tc.register("crucible", new RecipeSchema( + RESEARCH, RESULT, CATALYST, ASPECTS) + .typeOverride(vanillaType) + .factory(new KubeRecipeFactory( + ResourceLocation.fromNamespaceAndPath("tckubejsbridge", "crucible"), + CrucibleRecipeKJS.class, CrucibleRecipeKJS::new))); + + tc.register("arcane", new RecipeSchema( + RESEARCH, RESULT, ASPECTS, PATTERN, KEY) + .typeOverride(vanillaType) + .factory(new KubeRecipeFactory( + ResourceLocation.fromNamespaceAndPath("tckubejsbridge", "arcane"), + ShapedArcaneRecipeKJS.class, ShapedArcaneRecipeKJS::new))); + + tc.register("arcane_shapeless", new RecipeSchema( + RESEARCH, RESULT, ASPECTS, INGREDIENTS) + .typeOverride(vanillaType) + .factory(new KubeRecipeFactory( + ResourceLocation.fromNamespaceAndPath("tckubejsbridge", "arcane_shapeless"), + ShapelessArcaneRecipeKJS.class, ShapelessArcaneRecipeKJS::new))); + } + + @Override + public void registerBindings(BindingRegistry bindings) { + bindings.add("thaumcraft", new ThaumcraftBindings()); + } + + /** 脚本侧绑定:event.thaumcraft.addObjectTag(...) / removeInfusion(...) 等 */ + public static final class ThaumcraftBindings { + public void addObjectTag(ItemStack item, AspectList aspects) { + if (item == null || item.isEmpty()) { + ConsoleJS.SERVER.error("TC-KubeJS-Bridge: addObjectTag got empty item"); + return; + } + thaumcraft.api.ThaumcraftApi.registerObjectTag(item, aspects); + ConsoleJS.SERVER.info("TC-KubeJS-Bridge: registered object tag for " + item); + } + + /** 按 research 键移除 TC 已有注魔配方(先删后注册 = 真正替换) */ + public boolean removeInfusion(String research) { + return TCRecipeBridge.removeInfusion(research); + } + + /** 按 research 键移除 TC 已有奥术(有序/无序)配方 */ + public boolean removeArcane(String research) { + return TCRecipeBridge.removeArcane(research); + } + + /** 清空去重集合(/reload 时若需重新注册可调用) */ + public void clearRegistered() { + TCRecipeBridge.clearRegistered(); + } + } +} diff --git a/src/main/java/tckubejsbridge/kubejs/TCRecipeBridge.java b/src/main/java/tckubejsbridge/kubejs/TCRecipeBridge.java new file mode 100644 index 0000000..30331d3 --- /dev/null +++ b/src/main/java/tckubejsbridge/kubejs/TCRecipeBridge.java @@ -0,0 +1,118 @@ +package tckubejsbridge.kubejs; + +import com.google.gson.JsonObject; +import dev.latvian.mods.kubejs.script.ConsoleJS; +import net.minecraft.world.item.ItemStack; +import thaumcraft.api.ThaumcraftApi; +import thaumcraft.api.aspects.AspectList; + +import java.util.HashSet; +import java.util.Set; + +/** + * 桥接工具:将 KubeJS 脚本中解析出的配方参数实际注册到 Thaumcraft。 + * + * 注意:TC 注魔/炼金/奥术配方全部走 {@link ThaumcraftApi#getCraftingRecipes()} 内存列表, + * 不会进入原版 RecipeManager;因此本类在脚本执行时直接调用 TC API 完成注册, + * 并生成一个无害的占位 JSON(避免 KubeJS 把空配方交给 RecipeManager 时报错)。 + */ +public final class TCRecipeBridge { + + private static final Set REGISTERED_RESEARCH = new HashSet<>(); + + private TCRecipeBridge() { + } + + /** 按研究键去重,防止 /reload 重复注册 */ + private static boolean alreadyRegistered(String research) { + return !REGISTERED_RESEARCH.add(research); + } + + /** 清空去重集合(供 KubeJS 事件在 /reload 时调用,允许重新注册) */ + public static void clearRegistered() { + REGISTERED_RESEARCH.clear(); + } + + /** + * 按 research 键从 TC 配方列表中移除已有的注魔配方。 + * 用于脚本"先删原配方,再注册新配方",实现真正替换。 + * + * @return 是否至少移除了一条 + */ + public static boolean removeInfusion(String research) { + boolean removed = ThaumcraftApi.getCraftingRecipes().removeIf(r -> + r instanceof thaumcraft.api.crafting.InfusionRecipe ir && research.equals(ir.research())); + if (removed) { + ConsoleJS.SERVER.info("TC-KubeJS-Bridge: removed infusion recipe(s) for research '" + research + "'"); + } + // 允许该键后续重新注册 + REGISTERED_RESEARCH.remove(research); + return removed; + } + + /** 按 research 键从 TC 配方列表中移除已有的奥术(有序/无序)配方 */ + public static boolean removeArcane(String research) { + boolean removed = ThaumcraftApi.getCraftingRecipes().removeIf(r -> { + if (r instanceof thaumcraft.api.crafting.ShapedArcaneRecipe sr) return research.equals(sr.research); + if (r instanceof thaumcraft.api.crafting.ShapelessArcaneRecipe slr) return research.equals(slr.research); + return false; + }); + if (removed) { + ConsoleJS.SERVER.info("TC-KubeJS-Bridge: removed arcane recipe(s) for research '" + research + "'"); + } + // 允许该键后续重新注册 + REGISTERED_RESEARCH.remove(research); + return removed; + } + + public static void registerInfusion(String research, ItemStack result, int instability, + AspectList aspects, ItemStack central, ItemStack... components) { + if (alreadyRegistered(research)) { + ConsoleJS.SERVER.info("TC-KubeJS-Bridge: infusion recipe '" + research + "' already registered, skipping"); + return; + } + ThaumcraftApi.addInfusionCraftingRecipe(research, result, instability, aspects, central, components); + ConsoleJS.SERVER.info("TC-KubeJS-Bridge: registered infusion recipe '" + research + "'"); + } + + public static void registerCrucible(String research, ItemStack result, Object catalyst, AspectList aspects) { + if (alreadyRegistered(research)) { + ConsoleJS.SERVER.info("TC-KubeJS-Bridge: crucible recipe '" + research + "' already registered, skipping"); + return; + } + ThaumcraftApi.addCrucibleRecipe(research, result, catalyst, aspects); + ConsoleJS.SERVER.info("TC-KubeJS-Bridge: registered crucible recipe '" + research + "'"); + } + + public static void registerArcane(String research, ItemStack result, AspectList aspects, Object... recipe) { + if (alreadyRegistered(research)) { + ConsoleJS.SERVER.info("TC-KubeJS-Bridge: arcane recipe '" + research + "' already registered, skipping"); + return; + } + ThaumcraftApi.addArcaneCraftingRecipe(research, result, aspects, recipe); + ConsoleJS.SERVER.info("TC-KubeJS-Bridge: registered arcane recipe '" + research + "'"); + } + + public static void registerArcaneShapeless(String research, ItemStack result, AspectList aspects, Object... recipe) { + if (alreadyRegistered(research)) { + ConsoleJS.SERVER.info("TC-KubeJS-Bridge: arcane shapeless recipe '" + research + "' already registered, skipping"); + return; + } + ThaumcraftApi.addShapelessArcaneCraftingRecipe(research, result, aspects, recipe); + ConsoleJS.SERVER.info("TC-KubeJS-Bridge: registered arcane shapeless recipe '" + research + "'"); + } + + /** + * 生成无害占位配方 JSON,替换 KubeJS 对自定义配方自动生成的 JSON, + * 使 RecipeManager 能正常解析但不会产生任何实际效果。 + */ + public static JsonObject placeholderRecipe() { + JsonObject json = new JsonObject(); + json.addProperty("type", "minecraft:crafting_shapeless"); + json.add("ingredients", new com.google.gson.JsonArray()); + JsonObject result = new JsonObject(); + result.addProperty("item", "minecraft:air"); + json.add("result", result); + return json; + } +} diff --git a/src/main/java/tckubejsbridge/kubejs/TCRecipeKJS.java b/src/main/java/tckubejsbridge/kubejs/TCRecipeKJS.java new file mode 100644 index 0000000..78adccc --- /dev/null +++ b/src/main/java/tckubejsbridge/kubejs/TCRecipeKJS.java @@ -0,0 +1,30 @@ +package tckubejsbridge.kubejs; + +import com.google.gson.JsonObject; +import dev.latvian.mods.kubejs.recipe.KubeRecipe; + +/** + * TC 配方 KubeRecipe 基类。 + * + * 覆写 {@link #serializeChanges()}:脚本执行完成后(值已全部设置)调用子类实现的 + * {@link #bridgeToTC()} 完成 TC 内存配方注册,并用无害占位 JSON 替换序列化输出, + * 避免 KubeJS 将自定义配方误交给原版 RecipeManager 后产生异常配方。 + */ +public abstract class TCRecipeKJS extends KubeRecipe { + + public TCRecipeKJS() { + } + + /** 由子类实现:读取 RecipeKey 值并调用 TC API 注册配方 */ + protected abstract void bridgeToTC(); + + @Override + public KubeRecipe serializeChanges() { + if (newRecipe || hasChanged()) { + bridgeToTC(); + // 占位 JSON,避免污染 RecipeManager + this.json = TCRecipeBridge.placeholderRecipe(); + } + return this; + } +} diff --git a/src/main/resources/META-INF/neoforge.mods.toml b/src/main/resources/META-INF/neoforge.mods.toml new file mode 100644 index 0000000..7a0b565 --- /dev/null +++ b/src/main/resources/META-INF/neoforge.mods.toml @@ -0,0 +1,39 @@ +modLoader="javafml" +loaderVersion="${loader_version_range}" +license="GPL-3.0" + +[[mods]] +modId="tckubejsbridge" +version="${version}" +displayName="TC KubeJS Bridge" +description="Bridges Thaumcraft 4 recipes to KubeJS: infusion, crucible, arcane crafting and object aspect tags can be registered from KubeJS scripts." +authors="AlkSur" +displayTest="IGNORE_ALL_VERSION" + +[[dependencies.tckubejsbridge]] +modId="neoforge" +type="required" +versionRange="${neoforge_version_range}" +ordering="NONE" +side="BOTH" + +[[dependencies.tckubejsbridge]] +modId="minecraft" +type="required" +versionRange="${minecraft_version_range}" +ordering="NONE" +side="BOTH" + +[[dependencies.tckubejsbridge]] +modId="thaumcraft" +type="required" +versionRange="[0,)" +ordering="AFTER" +side="BOTH" + +[[dependencies.tckubejsbridge]] +modId="kubejs" +type="optional" +versionRange="[2101,)" +ordering="AFTER" +side="BOTH" diff --git a/src/main/resources/kubejs.plugins.txt b/src/main/resources/kubejs.plugins.txt new file mode 100644 index 0000000..e722bd2 --- /dev/null +++ b/src/main/resources/kubejs.plugins.txt @@ -0,0 +1 @@ +tckubejsbridge.kubejs.TCKubeJSPlugin