commit 8c468ec78027bf0252dde9920d8d562cfd998e75 Author: lnkosadmin Date: Tue Nov 4 13:49:10 2025 +0800 first commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8000a6f --- /dev/null +++ b/LICENSE @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +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 this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser 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 Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey 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 library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random + Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/README.md b/README.md new file mode 100644 index 0000000..d5b04c4 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# MCEF Android (ARM) Compatibility Patch + +> **注意:这是一个修改版分支** +> +> 此仓库是原始 [CinemaMod/MCEF](https://github.com/CinemaMod/mcef) 项目的一个分支,专门为**安卓端(ARM架构)** 的 Minecraft Java 版提供基础兼容性支持。 + +## 项目概述 + +此分支对原始 MCEF 库进行了最小化修改,主要目标是让 MCEF 及相关模组(如 WebDisplays)能够在安卓平台的 Minecraft Java 版中正常加载和运行,避免因架构不兼容而导致的崩溃问题。 + +### ⚠️ 重要限制 + +- **❌ 无浏览器功能**:由于 Chromium 无法在安卓环境运行,所有与浏览器相关的功能均被禁用 +- **✅ 基础兼容性**:模组可以正常加载,不会因 MCEF 初始化失败而导致游戏崩溃 +- **🎯 最小化修改**:仅修改必要的部分,保持与原始代码的最大兼容性 + +## 技术实现 + +### 修改内容 + +1. **架构检测绕过**:禁用了对安卓(ARM)架构的严格检测 +2. **初始化流程优化**:在检测到安卓平台时跳过 Chromium 相关初始化 +3. **异常处理增强**:提供更友好的错误处理和降级方案 + +### 兼容性状态 + +| 平台 | 状态 | 说明 | +|------|------|------| +| **Android (ARM)** | ✅ 可加载 | 模组正常加载,基础功能可用 | +| **Windows/Linux/macOS** | ⚠️ 可能受影响 | 需要进一步测试,建议使用官方版本 | + +## 快速开始 + +### 环境要求 + +- Minecraft: 1.21.1 +- NeoForge: 对应 1.21.1 的最新版本 +- 安卓设备:支持 ARM 架构的安卓设备 diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..6607693 --- /dev/null +++ b/build.gradle @@ -0,0 +1,88 @@ +plugins { + id 'fabric-loom' version "${fabric_loom_version}" apply false +} + +tasks.register('cloneJcef', Exec) { + commandLine 'git', 'submodule', 'update', '--init', '--recursive', 'common/java-cef' +} + +// https://gist.github.com/JonasGroeger/7620911 +def getCheckedOutGitCommitHash(Project mcefParent) { + def gitFolder = "$mcefParent.projectDir/.git/modules/common/java-cef/" + def takeFromHash = 40 + /* + * '.git/HEAD' contains either + * in case of detached head: the currently checked out commit hash + * otherwise: a reference to a file containing the current commit hash + */ + def gitHeadFile = new File(gitFolder + "HEAD"); + if (gitHeadFile.exists()) { + def head = gitHeadFile.text.split(":") // .git/HEAD + def isCommit = head.length == 1 // e5a7c79edabbf7dd39888442df081b1c9d8e88fd + // def isRef = head.length > 1 // ref: refs/heads/master + + if (isCommit) return head[0].trim().take(takeFromHash) // e5a7c79edabb + + def refHead = new File(gitFolder + head[1].trim()) // .git/refs/heads/master + refHead.text.trim().take takeFromHash + } else { + return "" + } +} + +tasks.register('publishMaven', GradleBuild) { + group = 'mcef' + tasks = [ + ':common:publish', + ':fabric:publish', + ':neoforge:publish' + ] +} + +tasks.register('publishCurseforge', GradleBuild) { + group = 'mcef' + tasks = [ + ':common:clean', + ':neoforge:clean', + ':fabric:clean', + ':neoforge:curseforge', + ':fabric:curseforge' + ] +} + +tasks.register('fabricClient', GradleBuild) { + group = 'mcef' + tasks = [ + ':fabric:runClient' + ] +} + +tasks.register('neoforgeClient', GradleBuild) { + group = 'mcef' + tasks = [ + ':neoforge:runClient' + ] +} + +tasks.register('fabricServer', GradleBuild) { + group = 'mcef' + tasks = [ + ':fabric:runServer' + ] +} + +tasks.register('neoforgeServer', GradleBuild) { + group = 'mcef' + tasks = [ + ':neoforge:runServer' + ] +} + +tasks.register('cleanAll', GradleBuild) { + group = 'mcef' + tasks = [ + ':common:clean', + ':fabric:clean', + ':neoforge:clean', + ] +} diff --git a/fabric/build.gradle b/fabric/build.gradle new file mode 100644 index 0000000..83dab87 --- /dev/null +++ b/fabric/build.gradle @@ -0,0 +1,164 @@ +plugins { + id 'fabric-loom' + id 'com.matthewprenger.cursegradle' version "${cursegradle_version}" + id 'com.github.johnrengelman.shadow' version "${shadow_version}" + id 'maven-publish' +} + +sourceCompatibility = JavaLanguageVersion.of(java_version as int) +targetCompatibility = JavaLanguageVersion.of(java_version as int) + +var mod_version = mcef_version + +archivesBaseName = archives_base_name +version = mod_version +group = maven_group + +repositories { + mavenCentral() + maven { url = 'https://maven.fabricmc.net/' } + maven { url = 'https://oss.sonatype.org/content/repositories/snapshots' } + mavenLocal() +} + +/* + Add the following to ~/.gradle/gradle.properties + systemProp.org.gradle.s3.endpoint=https:// + MCEF_S3_PUBLISH_URL_SNAPSHOT=s3:///repositories/snapshots + MCEF_S3_PUBLISH_URL_RELEASE=s3:///repositories/releases + MCEF_S3_PUBLISH_ACCESS_KEY= + MCEF_S3_PUBLISH_SECRET_KEY= + */ +publishing { + repositories { + maven { + url ((mcef_version.toString().endsWith("SNAPSHOT")) ? findProperty('MCEF_S3_PUBLISH_URL_SNAPSHOT') : findProperty('MCEF_S3_PUBLISH_URL_RELEASE')) + credentials(AwsCredentials) { + accessKey = findProperty('MCEF_S3_PUBLISH_ACCESS_KEY') + secretKey = findProperty('MCEF_S3_PUBLISH_SECRET_KEY') + } + } + } + publications { + mavenJava(MavenPublication) { + from components.java + groupId = 'com.cinemamod' + artifactId = 'mcef-fabric' + version = mcef_version + } + } +} + +dependencies { + minecraft "com.mojang:minecraft:${minecraft_version}" + mappings loom.officialMojangMappings() + modImplementation "net.fabricmc:fabric-loader:${fabric_loader_version}" + + Set apiModules = [ + 'fabric-api-base', + 'fabric-command-api-v2', + 'fabric-lifecycle-events-v1', + 'fabric-networking-api-v1', + 'fabric-resource-loader-v0', + 'fabric-key-binding-api-v1' + ] + + apiModules.forEach { + modImplementation(fabricApi.module(it, fabric_version)) + } + + implementation project(path: ':common', configuration: 'namedElements') +} + +loom { + mixin { + defaultRefmapName = "mcef.refmap.json" + } +} + +tasks.register('generateJava', Copy) { + from project(':common').file('src/template/java') + into "${buildDir}/generated/java" + expand 'compatibility_version': mod_compatibility_version +} +sourceSets.main.java { + srcDir "${buildDir}/generated/java" +} +compileJava.dependsOn generateJava +generateJava.dependsOn('sourcesJar') + +processResources { + filesMatching('fabric.mod.json') { + expand 'mod_id': mod_id, + 'mod_name': mod_name, + 'mod_vendor': mod_vendor, + 'mod_version': mod_version, + 'java_version': java_version, + 'minecraft_dependency': minecraft_dependency, + 'fabric_loader_version': fabric_loader_version, + 'min_fabric_version': min_fabric_version + } + from project(":common").sourceSets.main.resources +} + +tasks.withType(JavaCompile).configureEach { + source(project(':common').sourceSets.main.allSource) + source(project(':common').sourceSets.jcef.allSource) +} + +tasks.withType(JavaCompile).configureEach { + it.options.encoding = 'UTF-8' + it.options.release = java_version as int +} + +java { + withSourcesJar() +} + +jar { + duplicatesStrategy = DuplicatesStrategy.EXCLUDE + manifest { + attributes(['Specification-Title' : mod_name, + 'Specification-Vendor' : mod_vendor, + 'Specification-Version' : "1", + 'Implementation-Title' : mod_name, + 'Implementation-Version' : mod_version, + 'Implementation-Vendor' : mod_vendor, + 'Implementation-Timestamp': new Date().format("yyyy-MM-dd'T'HH:mm:ssZ"), + 'java-cef-commit' : project.parent.getCheckedOutGitCommitHash(project.parent) + ]) + } + from('LICENSE') { + rename { "${it}_${archivesBaseName}" } + } +} + +curseforge { + apiKey = file("${rootDir}/curseforge_api_key.txt").exists() ? file("${rootDir}/curseforge_api_key.txt").text.trim() : '' + project { + id = curse_id + releaseType = release_type + addGameVersion minecraft_version + addGameVersion 'Fabric' + addGameVersion "Java ${java_version}" + mainArtifact(file("${buildDir}/libs/${archivesBaseName}-${version}.jar")) { + displayName = "[FABRIC][${minecraft_version}] ${mod_name} ${mod_version}" + } + afterEvaluate { + uploadTask.dependsOn(remapJar) + } + } + options { + forgeGradleIntegration = false + } +} + +shadowJar { + configurations = [project.configurations.shadow] + archiveClassifier = 'shadow-dev' +} + +remapJar { + dependsOn shadowJar + inputFile = shadowJar.archiveFile.get() +} \ No newline at end of file diff --git a/fabric/gradle.properties b/fabric/gradle.properties new file mode 100644 index 0000000..8c7fd5c --- /dev/null +++ b/fabric/gradle.properties @@ -0,0 +1,15 @@ +org.gradle.jvmargs=-Xmx4G +org.gradle.daemon=false + +minecraft_dependency=1.21.1 +curseforge_minecraft_version=1.21.1 + +fabric_version=0.104.0+1.21.1 +min_fabric_version=0.100.0+1.21 + +maven_group=com.cinemamod +archives_base_name=mcef-fabric + +curse_id=636236 +release_type=release +recommended=true diff --git a/fabric/src/main/java/com/cinemamod/mcef/FabricMCEFClientMod.java b/fabric/src/main/java/com/cinemamod/mcef/FabricMCEFClientMod.java new file mode 100644 index 0000000..8bd5f8b --- /dev/null +++ b/fabric/src/main/java/com/cinemamod/mcef/FabricMCEFClientMod.java @@ -0,0 +1,34 @@ +/* + * MCEF (Minecraft Chromium Embedded Framework) + * Copyright (C) 2023 CinemaMod Group + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + * USA + */ + +package com.cinemamod.mcef; + +import com.cinemamod.mcef.example.MCEFExampleMod; +import net.fabricmc.api.ClientModInitializer; +import net.fabricmc.loader.api.FabricLoader; + +public class FabricMCEFClientMod implements ClientModInitializer { + @Override + public void onInitializeClient() { + if (FabricLoader.getInstance().isDevelopmentEnvironment()) { + new MCEFExampleMod(); + } + } +} diff --git a/fabric/src/main/java/com/cinemamod/mcef/FabricMCEFMod.java b/fabric/src/main/java/com/cinemamod/mcef/FabricMCEFMod.java new file mode 100644 index 0000000..f1c3d54 --- /dev/null +++ b/fabric/src/main/java/com/cinemamod/mcef/FabricMCEFMod.java @@ -0,0 +1,30 @@ +/* + * MCEF (Minecraft Chromium Embedded Framework) + * Copyright (C) 2023 CinemaMod Group + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + * USA + */ + +package com.cinemamod.mcef; + +import net.fabricmc.api.ModInitializer; + +public class FabricMCEFMod implements ModInitializer { + @Override + public void onInitialize() { + // MCEF server-side does nothing + } +} diff --git a/fabric/src/main/java/com/cinemamod/mcef/example/MCEFExampleMod.java b/fabric/src/main/java/com/cinemamod/mcef/example/MCEFExampleMod.java new file mode 100644 index 0000000..e83a544 --- /dev/null +++ b/fabric/src/main/java/com/cinemamod/mcef/example/MCEFExampleMod.java @@ -0,0 +1,51 @@ +/* + * MCEF (Minecraft Chromium Embedded Framework) + * Copyright (C) 2023 CinemaMod Group + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + * USA + */ + +package com.cinemamod.mcef.example; + +import com.mojang.blaze3d.platform.InputConstants; +import net.fabricmc.fabric.api.client.event.lifecycle.v1.ClientTickEvents; +import net.minecraft.client.KeyMapping; +import net.minecraft.client.Minecraft; +import net.minecraft.network.chat.Component; +import org.lwjgl.glfw.GLFW; + +public class MCEFExampleMod { + private static final Minecraft minecraft = Minecraft.getInstance(); + + public static final KeyMapping KEY_MAPPING = new KeyMapping( + "Open Browser", InputConstants.Type.KEYSYM, + GLFW.GLFW_KEY_F10, "key.categories.misc" + ); + + public MCEFExampleMod() { + ClientTickEvents.START_CLIENT_TICK.register((client) -> onTick()); + } + + public void onTick() { + // Check if our key was pressed + if (KEY_MAPPING.isDown() && !(minecraft.screen instanceof ExampleScreen)) { + //Display the web browser UI. + minecraft.setScreen(new ExampleScreen( + Component.literal("Example Screen") + )); + } + } +} diff --git a/fabric/src/main/resources/fabric.mod.json b/fabric/src/main/resources/fabric.mod.json new file mode 100644 index 0000000..5cde382 --- /dev/null +++ b/fabric/src/main/resources/fabric.mod.json @@ -0,0 +1,38 @@ +{ + "schemaVersion": 1, + "id": "${mod_id}", + "version": "${mod_version}", + "name": "${mod_name}", + "description": "A Minecraft mod and library for adding the Chromium web browser into the game (Minecraft Chromium Embedded Framework).", + "authors": [ + "${mod_vendor}" + ], + "contact": { + "homepage": "https://github.com/CinemaMod/mcef", + "issues": "https://github.com/CinemaMod/mcef/issues", + "sources": "https://github.com/CinemaMod/mcef", + "discord": "https://discord.gg/rNrh5kW8Ty" + }, + "license": "LGPL 2.1", + "icon": "icon.png", + "environment": "*", + "entrypoints": { + "client": [ + "com.cinemamod.mcef.FabricMCEFClientMod" + ], + "main": [ + "com.cinemamod.mcef.FabricMCEFMod" + ] + }, + "mixins": [ + "mcef.mixins.json" + ], + "depends": { + "fabricloader": ">=${fabric_loader_version}", + "minecraft": ["1.21", "1.21.1"], + "java": ">=${java_version}" + }, + "breaks": { + "fabric-api": "<${min_fabric_version}" + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..4030d83 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,19 @@ +org.gradle.jvmargs=-Xmx8G +org.gradle.daemon=false + +java_version=21 +minecraft_version=1.21.1 +fabric_loader_version=0.16.5 +mod_compatibility_version=21 + +# For snapshots, append -SNAPSHOT +mcef_version=2.1.6-1.21.1 + +mod_id=mcef +mod_name=MCEF (Minecraft Chromium Embedded Framework) + +mod_vendor=CinemaMod Group + +fabric_loom_version=1.9-SNAPSHOT +cursegradle_version=1.4.0 +shadow_version=8.1.1 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..ff23a68 --- /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.14.2-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..93e3f59 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@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 + +@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. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +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/neoforge/build.gradle b/neoforge/build.gradle new file mode 100644 index 0000000..7c71e01 --- /dev/null +++ b/neoforge/build.gradle @@ -0,0 +1,136 @@ +plugins { + id 'net.neoforged.gradle.userdev' version '7.0.+' + id 'com.matthewprenger.cursegradle' version "${cursegradle_version}" + id 'com.github.johnrengelman.shadow' version "${shadow_version}" + id 'maven-publish' +} + +var mod_version = mcef_version + +archivesBaseName = project.archives_base_name +version = mod_version +group = mod_packagename + +java.toolchain.languageVersion = JavaLanguageVersion.of(java_version as int) + +runs { + client { + workingDirectory project.file('run') + } + server { + workingDirectory project.file('run/server') + } +} + +/* + Add the following to ~/.gradle/gradle.properties + systemProp.org.gradle.s3.endpoint=https:// + MCEF_S3_PUBLISH_URL_SNAPSHOT=s3:///repositories/snapshots + MCEF_S3_PUBLISH_URL_RELEASE=s3:///repositories/releases + MCEF_S3_PUBLISH_ACCESS_KEY= + MCEF_S3_PUBLISH_SECRET_KEY= + */ +publishing { + repositories { + maven { + url ((mcef_version.toString().endsWith("SNAPSHOT")) ? findProperty('MCEF_S3_PUBLISH_URL_SNAPSHOT') : findProperty('MCEF_S3_PUBLISH_URL_RELEASE')) + credentials(AwsCredentials) { + accessKey = findProperty('MCEF_S3_PUBLISH_ACCESS_KEY') + secretKey = findProperty('MCEF_S3_PUBLISH_SECRET_KEY') + } + } + } + publications { + mavenJava(MavenPublication) { + from components.java + groupId = 'com.cinemamod' + artifactId = 'mcef-neoforge' + version = mcef_version + } + } +} + +sourceSets.main.resources { srcDir 'src/generated/resources' } + +configurations { + shadowMc.extendsFrom minecraftLibrary +} + +tasks.register('prepareWorkspace') { + +} + +dependencies { + implementation "net.neoforged:neoforge:${neoforge_version}" + + implementation(project(':common')) { + transitive false + } +} + +tasks.register('generateJava', Copy) { + from project(':common').file('src/template/java') + into "${buildDir}/generated/java" + expand 'compatibility_version': mod_compatibility_version +} +sourceSets.main.java { + srcDir "${buildDir}/generated/java" +} +compileJava.dependsOn generateJava + +processResources { + filesMatching('**/*.toml') { + expand 'mod_id': mod_id, + 'mod_version': mod_version, + 'mod_name': mod_name, + 'neoforge_version': neoforge_version, + 'loader_version': loader_version, + 'neoforge_dependency': 'neoforge_dependency', + 'minecraft_version': minecraft_version + } + from("${project(':common').projectDir}/src/main/resources") +} + +tasks.withType(JavaCompile).configureEach { + source(project(':common').sourceSets.main.allSource) + source(project(':common').sourceSets.jcef.allSource) +} + +tasks.withType(JavaCompile).configureEach { + options.encoding = 'UTF-8' +} + +jar { + duplicatesStrategy = DuplicatesStrategy.EXCLUDE + manifest { + attributes(['Specification-Title' : mod_name, + 'Specification-Vendor' : mod_vendor, + 'Specification-Version' : "1", + 'Implementation-Title' : mod_name, + 'Implementation-Version' : mod_version, + 'Implementation-Vendor' : mod_vendor, + 'Implementation-Timestamp': new Date().format("yyyy-MM-dd'T'HH:mm:ssZ"), + 'java-cef-commit' : project.parent.getCheckedOutGitCommitHash(project.parent) + ]) + } + from configurations.shadow.collect { it.isDirectory() ? it : zipTree(it) } +} + +curseforge { + apiKey = file("${rootDir}/curseforge_api_key.txt").exists() ? file("${rootDir}/curseforge_api_key.txt").text.trim() : '' + project { + id = curse_id + releaseType = release_type + addGameVersion minecraft_version + addGameVersion 'NeoForge' + addGameVersion "Java ${java_version}" + mainArtifact(jar) { + displayName = "[NEOFORGE][${minecraft_version}] ${mod_name} ${mod_version}" + } + } +} + +shadowJar { + configurations = [project.configurations.shadowMc] + archiveClassifier = '' +} diff --git a/neoforge/gradle.properties b/neoforge/gradle.properties new file mode 100644 index 0000000..54a5625 --- /dev/null +++ b/neoforge/gradle.properties @@ -0,0 +1,16 @@ +org.gradle.jvmargs=-Xmx4G +org.gradle.daemon=false + +neoforge_version=21.0.145 +loader_version=[1,) +neoforge_dependency=[21.0.0-beta,) + +mod_packagename=com.cinemamod +archives_base_name=mcef-neoforge + +curse_id=636236 +release_type=release +recommended=true + +neogradle.subsystems.parchment.minecraftVersion=1.21 +neogradle.subsystems.parchment.mappingsVersion=2024.07.28 diff --git a/neoforge/runs/junit/junit_jvm_args.txt b/neoforge/runs/junit/junit_jvm_args.txt new file mode 100644 index 0000000..f5fbaa0 --- /dev/null +++ b/neoforge/runs/junit/junit_jvm_args.txt @@ -0,0 +1,13 @@ +-p +D:\program\gradle-cache\caches\modules-2\files-2.1\cpw.mods\bootstraplauncher\2.0.2\1a2d076cbc33b0520cbacd591224427b2a20047d\bootstraplauncher-2.0.2.jar;D:\program\gradle-cache\caches\modules-2\files-2.1\cpw.mods\securejarhandler\3.0.8\c0ef95cecd8699a0449053ac7d9c160748d902cd\securejarhandler-3.0.8.jar;D:\program\gradle-cache\caches\modules-2\files-2.1\org.ow2.asm\asm-commons\9.5\19ab5b5800a3910d30d3a3e64fdb00fd0cb42de0\asm-commons-9.5.jar;D:\program\gradle-cache\caches\modules-2\files-2.1\org.ow2.asm\asm-util\9.5\64b5a1fc8c1b15ed2efd6a063e976bc8d3dc5ffe\asm-util-9.5.jar;D:\program\gradle-cache\caches\modules-2\files-2.1\org.ow2.asm\asm-analysis\9.5\490bacc77de7cbc0be1a30bb3471072d705be4a4\asm-analysis-9.5.jar;D:\program\gradle-cache\caches\modules-2\files-2.1\org.ow2.asm\asm-tree\9.5\fd33c8b6373abaa675be407082fdfda35021254a\asm-tree-9.5.jar;D:\program\gradle-cache\caches\modules-2\files-2.1\org.ow2.asm\asm\9.5\dc6ea1875f4d64fbc85e1691c95b96a3d8569c90\asm-9.5.jar;D:\program\gradle-cache\caches\modules-2\files-2.1\net.neoforged\JarJarFileSystems\0.4.1\78f59f89defcd032ed788b151ca6a0d40ace796a\JarJarFileSystems-0.4.1.jar +--add-modules +ALL-MODULE-PATH +--add-opens +java.base/java.util.jar=cpw.mods.securejarhandler +--add-opens +java.base/java.lang.invoke=cpw.mods.securejarhandler +--add-exports +java.base/sun.security.util=cpw.mods.securejarhandler +--add-exports +jdk.naming.dns/com.sun.jndi.dns=java.naming +-XX:HeapDumpPath=MojangTricksIntelDriversForPerformance_javaw.exe_minecraft.exe.heapdump diff --git a/neoforge/runs/junit/junit_test_args.txt b/neoforge/runs/junit/junit_test_args.txt new file mode 100644 index 0000000..45d3fc6 --- /dev/null +++ b/neoforge/runs/junit/junit_test_args.txt @@ -0,0 +1,18 @@ +--launchTarget +forgejunituserdev +--version +21.0.145 +--assetIndex +asset-index +--assetsDir +D:\program\gradle-cache\caches\minecraft\assets +--gameDir +. +--fml.neoForgeVersion +21.0.145 +--fml.fmlVersion +4.0.21 +--fml.mcVersion +1.21 +--fml.neoFormVersion +20240613.152323 diff --git a/neoforge/src/main/java/com/cinemamod/mcef/MCEFInitEvent.java b/neoforge/src/main/java/com/cinemamod/mcef/MCEFInitEvent.java new file mode 100644 index 0000000..6756c39 --- /dev/null +++ b/neoforge/src/main/java/com/cinemamod/mcef/MCEFInitEvent.java @@ -0,0 +1,43 @@ +/* + * MCEF (Minecraft Chromium Embedded Framework) + * Copyright (C) 2023 CinemaMod Group + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + * USA + */ + +/* + * little unsure of if I should uncomment this or not + * basically; forge's way of doing this sorta "listening for a thing" is events + * this allows that to be used for MCEF initalization + * + * there is a fabric-equivalent-expectation for this, but it's sorta just what's already in the MCEF class if I'm remembering correctly + */ + +//package com.cinemamod.mcef; +// +//import net.minecraftforge.common.MinecraftForge; +//import net.minecraftforge.eventbus.api.Event; +// +//public class MCEFInitEvent extends Event { +// static { +// MCEF.scheduleForInit(() -> { +// MinecraftForge.EVENT_BUS.post(new MCEFInitEvent()); +// }); +// } +// +// public MCEFInitEvent() { +// } +//} diff --git a/neoforge/src/main/java/com/cinemamod/mcef/NeoForgeMCEFMod.java b/neoforge/src/main/java/com/cinemamod/mcef/NeoForgeMCEFMod.java new file mode 100644 index 0000000..1867003 --- /dev/null +++ b/neoforge/src/main/java/com/cinemamod/mcef/NeoForgeMCEFMod.java @@ -0,0 +1,51 @@ +/* + * MCEF (Minecraft Chromium Embedded Framework) + * Copyright (C) 2023 CinemaMod Group + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + * USA + */ + +package com.cinemamod.mcef; + +import com.cinemamod.mcef.example.MCEFExampleMod; +import com.mojang.logging.LogUtils; +import net.neoforged.bus.api.IEventBus; +import net.neoforged.fml.common.Mod; +import net.neoforged.fml.event.lifecycle.FMLClientSetupEvent; +import net.neoforged.fml.event.lifecycle.FMLDedicatedServerSetupEvent; +import net.neoforged.fml.loading.FMLEnvironment; +import org.slf4j.Logger; + +@Mod(NeoForgeMCEFMod.MODID) +public class NeoForgeMCEFMod { + public static final String MODID = "mcef"; + private static final Logger LOGGER = LogUtils.getLogger(); + + public NeoForgeMCEFMod(IEventBus modEventBus) { + modEventBus.addListener(this::clientSetup); + modEventBus.addListener(this::serverSetup); + } + + private void clientSetup(final FMLClientSetupEvent event) { + if (!FMLEnvironment.production) { + new MCEFExampleMod(); + } + } + + private void serverSetup(final FMLDedicatedServerSetupEvent event) { + // MCEF server-side does nothing + } +} diff --git a/neoforge/src/main/java/com/cinemamod/mcef/example/MCEFExampleMod.java b/neoforge/src/main/java/com/cinemamod/mcef/example/MCEFExampleMod.java new file mode 100644 index 0000000..908c651 --- /dev/null +++ b/neoforge/src/main/java/com/cinemamod/mcef/example/MCEFExampleMod.java @@ -0,0 +1,52 @@ +/* + * MCEF (Minecraft Chromium Embedded Framework) + * Copyright (C) 2023 CinemaMod Group + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library 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 + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + * USA + */ + +package com.cinemamod.mcef.example; + +import com.mojang.blaze3d.platform.InputConstants; +import net.minecraft.client.KeyMapping; +import net.minecraft.client.Minecraft; +import net.minecraft.network.chat.Component; +import net.neoforged.neoforge.client.event.ClientTickEvent; +import net.neoforged.neoforge.common.NeoForge; +import org.lwjgl.glfw.GLFW; + +public class MCEFExampleMod { + private static final Minecraft minecraft = Minecraft.getInstance(); + + public static final KeyMapping KEY_MAPPING = new KeyMapping( + "Open Browser", InputConstants.Type.KEYSYM, + GLFW.GLFW_KEY_F10, "key.categories.misc" + ); + + public MCEFExampleMod() { + NeoForge.EVENT_BUS.addListener(this::onTick); + } + + public void onTick(ClientTickEvent.Post event) { + // Check if our key was pressed and make sure the ExampleScreen isn't already open + if (KEY_MAPPING.isDown() && !(minecraft.screen instanceof ExampleScreen)) { + // Display the ExampleScreen web browser + minecraft.setScreen(new ExampleScreen( + Component.literal("Example Screen") + )); + } + } +} diff --git a/neoforge/src/main/resources/META-INF/neoforge.mods.toml b/neoforge/src/main/resources/META-INF/neoforge.mods.toml new file mode 100644 index 0000000..9685ebc --- /dev/null +++ b/neoforge/src/main/resources/META-INF/neoforge.mods.toml @@ -0,0 +1,29 @@ +modLoader="javafml" +loaderVersion="${loader_version}" +license="LGPL" +issueTrackerURL="https://github.com/CinemaMod/mcef/issues" +displayURL="https://github.com/CinemaMod/mcef" +logoFile="icon.png" +# credits="" +authors="ds58" +[[mixins]] +config="mcef.mixins.json" +[[mods]] +modId="${mod_id}" +version="${mod_version}" +displayName="${mod_name}" +updateJSONURL="" +displayTest="NONE" +description='''A Minecraft mod and library for adding the Chromium web browser into the game (Minecraft Chromium Embedded Framework).''' +[[dependencies.${mod_id}]] + modId="neoforge" + mandatory=true + versionRange="${neoforge_dependency}" + ordering="NONE" + side="BOTH" +[[dependencies.${mod_id}]] + modId="minecraft" + mandatory=true + versionRange="[1.21,)" + ordering="NONE" + side="BOTH" diff --git a/neoforge/src/main/resources/pack.mcmeta b/neoforge/src/main/resources/pack.mcmeta new file mode 100644 index 0000000..de728c5 --- /dev/null +++ b/neoforge/src/main/resources/pack.mcmeta @@ -0,0 +1,6 @@ +{ + "pack": { + "description": "mcef resources", + "pack_format": 13 + } +} diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..5d6046b --- /dev/null +++ b/settings.gradle @@ -0,0 +1,11 @@ +pluginManagement { + repositories { + gradlePluginPortal() + maven { url = 'https://maven.fabricmc.net/' } + maven { url = 'https://maven.neoforged.net/releases' } + mavenCentral() + } +} + +rootProject.name = 'mcef' +include('common', 'fabric', 'neoforge') \ No newline at end of file