diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..4356e65 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,30 @@ +# Managed by CleanroomMC/Conventions. Do not edit locally. +# Change it there and bump the convention plugin version instead. +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = space +indent_size = 4 +max_line_length = 160 + +[*.{java,gradle,groovy,kt,kts}] +indent_size = 4 + +[*.{json,json5,yml,yaml,toml,xml}] +indent_size = 2 + +[*.md] +trim_trailing_whitespace = false + +[{Makefile,*.mk}] +indent_style = tab + +[*.{bat,cmd}] +end_of_line = crlf + +[gradlew] +end_of_line = lf diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f67fcb7 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,45 @@ +# Managed by CleanroomMC/Conventions. Do not edit locally. +# Change it there and bump the convention plugin version instead. + +# Normalise on commit, check out LF everywhere. Windows contributors included. +* text=auto eol=lf + +*.bat text eol=crlf +*.cmd text eol=crlf +gradlew text eol=lf +*.sh text eol=lf + +*.java text +*.gradle text +*.groovy text +*.kt text +*.kts text +*.scala text +*.properties text +*.json text +*.json5 text +*.toml text +*.xml text +*.yml text +*.yaml text +*.md text + +*.jar binary +*.zip binary +*.png binary +*.jpg binary +*.jpeg binary +*.gif binary +*.ogg binary +*.wav binary +*.nbt binary +*.dat binary +*.class binary +*.ttf binary +*.otf binary +*.so binary +*.dll binary +*.dylib binary + +# Keep the wrapper jar out of diffs, it is verified by checksum +**/gradle/wrapper/gradle-wrapper.jar binary linguist-vendored linguist-generated diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index 0cb8c99..0000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,31 +0,0 @@ -name: Build mod jar - -on: - [workflow_dispatch, push] - -permissions: - contents: read - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v7 - - name: Set up JDK - uses: actions/setup-java@v5 - with: - java-version: '25' - distribution: 'temurin' - - uses: gradle/actions/setup-gradle@v6 - name: Set up Gradle - - name: Add permission - run: chmod +x ./gradlew - - name: Execute Gradle build - run: ./gradlew build - - - name: Upload a Build Artifact - uses: actions/upload-artifact@v7 - with: - path: build/libs diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..911e3ba --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,19 @@ +name: CI + +on: + push: + branches: + - main + - 'develop/**' + pull_request: + types: [opened, synchronize, reopened, ready_for_review, review_requested] + workflow_dispatch: + +permissions: + contents: read + +jobs: + build: + uses: CleanroomMC/Conventions/.github/workflows/build.yml@1.4.0 + with: + release-branch: main diff --git a/.github/workflows/release-to-cf-mr.yml b/.github/workflows/release-to-cf-mr.yml deleted file mode 100644 index 61b2139..0000000 --- a/.github/workflows/release-to-cf-mr.yml +++ /dev/null @@ -1,56 +0,0 @@ -name: Releases to CurseForge and/or Modrinth - -on: - workflow_dispatch: - -jobs: - build: - runs-on: ubuntu-latest - permissions: - contents: write - steps: - - name: Checkout - uses: actions/checkout@v7 - with: - fetch-depth: 0 - - - name: Set up JDK - uses: actions/setup-java@v5 - with: - java-version: '25' - distribution: 'temurin' - - - uses: gradle/actions/setup-gradle@v6 - name: Set up Gradle - - - name: Add permission - run: chmod +x ./gradlew - - - name: Execute Gradle build - run: ./gradlew build - - - name: Get Changes between Tags - id: changes - uses: simbo/changes-between-tags-action@v1 - - - uses: Kir-Antipov/mc-publish@v3 - with: - # Only include this section if you wish to publish - # your assets on Modrinth. - modrinth-id: placeholder - modrinth-token: ${{ secrets.MODRINTH_TOKEN }} - - # Only include this section if you wish to publish - # your assets on CurseForge. - curseforge-id: placeholder - curseforge-token: ${{ secrets.CURSEFORGE_TOKEN }} - - files: | - build/libs/!(*-@(dev|sources|javadoc)).jar - build/libs/*-@(dev|sources|javadoc).jar - loaders: forge - game-versions: 1.12.2 - java: | - 25 - version: ${{ steps.changes.outputs.tag }} - changelog: ${{ steps.changes.outputs.changes }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f009a98..f49b930 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,30 +1,22 @@ -name: Releases +name: Release on: push: tags: - - "*" + - '[0-9]+.[0-9]+.[0-9]+' + - '[0-9]+.[0-9]+.[0-9]+-*' + workflow_dispatch: -jobs: - build: - runs-on: ubuntu-latest - permissions: - contents: write - steps: - - uses: actions/checkout@v7 - - name: Set up JDK - uses: actions/setup-java@v5 - with: - java-version: '25' - distribution: 'temurin' - - uses: gradle/actions/setup-gradle@v6 - name: Set up Gradle - - name: Add permission - run: chmod +x ./gradlew - - name: Execute Gradle build - run: ./gradlew build +permissions: + contents: write + issues: read + pull-requests: read - - uses: ncipollo/release-action@v1 - with: - artifacts: "build/libs/*" - generateReleaseNotes: true +jobs: + release: + uses: CleanroomMC/Conventions/.github/workflows/release.yml@1.4.0 + with: + publish-maven: false + # Needs curseforge_project_id or modrinth_project_id in gradle.properties, and the matching token secret + publish-mods: true + secrets: inherit diff --git a/.gitignore b/.gitignore index 6633c2d..3a07c35 100644 --- a/.gitignore +++ b/.gitignore @@ -1,27 +1,126 @@ -.gradle -**/build/ -!src/**/build/ -run/ +# >>> cleanroom-conventions +# Managed by CleanroomMC/Conventions. Do not edit the marked region locally. +# Change it there and bump the convention plugin version instead. +# Project-specific ignores go below the closing marker. +# +# Scope: JVM projects. Java, Kotlin, Groovy, Scala, and the build tools around them. + +# Build output +build/ +!**/src/**/build/ out/ +!**/src/**/out/ +bin/ +!**/src/**/bin/ +target/ +!**/src/**/target/ +classes/ +!**/src/**/classes/ +dist/ +!**/src/**/dist/ +*.class +*.tasty -# Ignore Gradle GUI config +# Gradle +.gradle/ gradle-app.setting +.gradletasknamecache +local.properties +!**/gradle/wrapper/gradle-wrapper.jar -# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) -!gradle-wrapper.jar +# Maven +.mvn/timing.properties +.mvn/wrapper/maven-wrapper.jar +release.properties +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +pom.xml.next +dependency-reduced-pom.xml +buildNumber.properties +.flattened-pom.xml -# Avoid ignore Gradle wrappper properties -!gradle-wrapper.properties +# sbt and Scala +.bsp/ +.bloop/ +.metals/ +.scala-build/ +project/project/ +project/target/ +.scala_dependencies +.worksheet -# Cache of project -.gradletasknamecache +# Kotlin +.kotlin/ +*.kotlin_module +.kotlin_native/ -# Eclipse Gradle plugin generated files -# Eclipse Core -.project -# JDT-specific (Eclipse Java Development Tools) +# IntelliJ IDEA +# The code style is convention-owned and must stay tracked +.idea/* +!.idea/codeStyles/ +!.idea/codeStyles/** +*.iml +*.ipr +*.iws +.idea_modules/ +atlassian-ide-plugin.xml + +# Eclipse .classpath +.project +.settings/ +.metadata/ +.apt_generated/ +.apt_generated_tests/ +.factorypath +.springBeans +.sts4-cache/ + +# NetBeans +nbproject/private/ +nbbuild/ +nbdist/ +.nb-gradle/ + +# Visual Studio Code +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json + +# JVM crash and profiling output +hs_err_pid* +replay_pid* +*.hprof +*.jfr +*.log + +# Minecraft Development +run/ +!**/src/**/run/ +logs/ +!**/src/**/logs/ +crash-reports/ +.mixin.out/ + +# OS noise +.DS_Store +.AppleDouble +.LSOverride +._* +Thumbs.db +Desktop.ini +$RECYCLE.BIN/ -# IDEA config -.idea +# Editors and temporary files +*.swp +*.swo +*~ +*.bak +*.orig +*.rej +# <<< cleanroom-conventions +runs diff --git a/HEADER b/HEADER new file mode 100644 index 0000000..ca91c06 --- /dev/null +++ b/HEADER @@ -0,0 +1,2 @@ +Copyright (c) 2026 CleanroomMC contributors +SPDX-License-Identifier: LGPL-3.0-only diff --git a/LICENSE b/LICENSE index a00e084..0ed0a38 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,840 @@ -MIT License - -Copyright (c) 2025 kappa-maintainer - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + GNU LESSER 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. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + 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 that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU 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 as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. + + 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 index 7444fa0..dfc3f0e 100644 --- a/README.md +++ b/README.md @@ -1,78 +1,19 @@ # CleanroomModTemplate -Mod development template for Cleanroom, uses a custom [Unimined fork](https://github.com/kappa-maintainer/Unimined) ([original](https://github.com/unimined/Unimined)) -### WARNING: Custom Unimined Fork -May have issues, report here or [here](https://github.com/kappa-maintainer/Unimined) when you encountered impossible field names or impossible Scala compiler errors. +A mod development template for Cleanroom. Requires Cleanroom 0.7.0 or above. Uses [CleanroomGradle](https://github.com/CleanroomMC/CleanroomGradle) and [Conventions](https://github.com/CleanroomMC/Conventions). -## DOs and DON'Ts -### Choose Branch -Choose mixin branch if you want to use Mixin. +## Getting Started -Use scala and kotlin branch if you want to use those languages. +1. Set `root_package`, `mod_id` and `mod_name` in `gradle.properties`, and move the sources to match. +2. Set `conventions.license`, then run `./gradlew extractConventions applyLicenseHeader`. +3. Run `./gradlew runClient`. -There are 4 branches available: -- main -- mixin -- scala -- kotlin +Every other option is documented next to its property in `gradle.properties`. -If you want to use non-main branches, after clicked *Create a new repository* under *Use this template*, check the *Include all branches* checkbox. +## Versioning -### Adding Mod Dependencies -You can find dependencies block in `gradle/scripts/dependencies.gradle`. +The version is computed from git tags. Tag `1.0.0` on `main` to release it, `./gradlew -q printVersion` prints the current value. -No more `rfg.deobf()` or `fg.deobf`. You **MUST** add mods by using `modImplementation` or `modRuntimeOnly`, or the game will crash when running. +## Tokens -Use `modLibrary` for libs/mods that you don't want to remap. - -### Non-Mod Dependencies -Two new configuration types `contain` and `shadow` are available, check more details in `dependencies.gradle`. - -### gradle.properties -Edit gradle.properties and set your modid, mod version, mod name, package, etc. - -If you are writing a coremod, remember to set related settings to true. - -### Reference Class -There will be a `Reference` class under your top package. - -This is used to store mod version so you can fill it to `@Mod` annotation. - -You should change its location to fit your new package name. - -You can find its template under `src/main/java-templates`. - -### Mixin -1. Rename json config file to use your modid. -2. Add **all** your mixin classes there. -3. Use `IMixinConfigPlugin` to control if certain mixin should be enabled. -4. mixin classes will be passed to the plugin only when target class is loading, so you don't need to call `Loader.isModLoaded()` -5. Don't worry about refmap, Unimined will handle it automatically. You can still `disableRefmap()` manually though - -### Access Transformer -You **MUST** write AT file in MCP name. It will be remapped back to SRG name in artifact jar. - -Rename AT file name to your modid before using it. There's an example entry in AT file, remove it if you want to use AT. - -### Vanilla Source Code with Comments -Run `genSources` task in gradle. If it didn't work, run again until a file with `-sources.jar` suffix appeared. - -If you want to `find usage` from vanilla like RFG, just change the scope in IntelliJ settings. - -### GitHub Action -This template comes with three workflows. - -`build.yml` will build and upload artifact for every commit. Useful when you want to provide test builds for debugging. - -`release.yml` will make a GitHub release if you pushed a git tag. - -`release-to-cf-mr.yml` can publish your mod to CurseForge and/or Modrinth. - -You need to fill in your project IDs and configure your tokens in GitHub repository first. - -By default, you will need to manually trigger the workflow in web page, but you can also enable tag triggering by merging the third yml into `release.yml`. - -### Credit -Thanks @Karnatour for fixing shadow plugin - -Thanks @ghostflyby for making kotlin branch \ No newline at end of file +`@{NAME}` markers in classes and resources are replaced at build time. `tokens.properties` declares them. diff --git a/build.gradle b/build.gradle index a5d7e1a..018dee1 100644 --- a/build.gradle +++ b/build.gradle @@ -1,235 +1,96 @@ plugins { id 'java' - id 'java-library' - id 'maven-publish' - id 'com.gradleup.shadow' version '9.6.1' - id 'org.jetbrains.gradle.plugin.idea-ext' version '1.4.1' - id 'xyz.wagyourtail.unimined' version '1.4.43-kappa' - id 'net.kyori.blossom' version '2.2.0' + id 'com.cleanroommc.cleanroomgradle' + id 'com.cleanroommc.conventions' version '1.4.0' } -import org.jetbrains.gradle.ext.Gradle - -ext { - //noinspection GroovyAssignabilityCheck - access_transformer_locations = "${mod_id}_at.cfg" -} - -version = mod_version group = root_package base { archivesName = mod_id } -java { - toolchain { - languageVersion = JavaLanguageVersion.of(25) - } - if (generate_sources_jar.toBoolean()) { - withSourcesJar() - } - if (generate_javadocs_jar.toBoolean()) { - withJavadocJar() - } -} - -configurations { - contain - implementation.extendsFrom(contain) - modCompileOnly - compileOnly.extendsFrom(modCompileOnly) - modRuntimeOnly - runtimeOnly.extendsFrom(modRuntimeOnly) -} - -def remapTaskName = enable_shadow.toBoolean() ? "remapShadowJar" : "remapJar" - -//noinspection GroovyAssignabilityCheck -unimined.minecraft { - version "1.12.2" +def accessTransformerNames = access_transformers.tokenize() - mappings { - mcp("stable", "39-1.12") +conventions { + if (mod_authors) { + author = mod_authors } - - cleanroom { - if (use_access_transformer.toBoolean()) { - accessTransformer "${rootProject.projectDir}/src/main/resources/$access_transformer_locations" + mods { + if (curseforge_project_id) { + curseforge = curseforge_project_id } - loader "0.6.13-alpha" - runs.all { - args += ['--username', minecraft_username] - def extraArgs = extra_jvm_args - if (extraArgs != null && !extraArgs.trim().isEmpty()) { - jvmArgs += extraArgs.split { "\\s+" }.toList() - } - if (enable_foundation_debug.toBoolean()) { - systemProperty("foundation.dump", "true") - systemProperty("foundation.verbose", "true") - } - if (is_coremod.toBoolean()) { - systemProperty("fml.coreMods.load", coremod_plugin_class_name) - } - return + if (modrinth_project_id) { + modrinth = modrinth_project_id } } - - defaultRemapJar = false - - String jarTaskName = enable_shadow.toBoolean() ? "shadowJar" : "jar" - - remap(tasks.named(jarTaskName).get()) - - mods { - remap(configurations.modCompileOnly) - remap(configurations.modRuntimeOnly) - } } -// Remove the annoying blue icon by Unimined -tasks.matching { it.name == 'genIntellijRuns' }.configureEach { - enabled = false +repositories { + exclusiveContent { + forRepository { + maven { + name 'CurseMaven' + url 'https://curse.cleanroommc.com' + } + } + filter { + includeGroup 'curse.maven' + } + } } dependencies { - if (use_asset_mover.toBoolean()) { - implementation "com.cleanroommc:assetmover:${asset_mover_version}" - } - if (enable_junit_testing.toBoolean()) { - testImplementation 'org.junit.jupiter:junit-jupiter:6.0.3' - testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + implementation cleanroom.userdev(cleanroom_version) { + accessTransformers.from(accessTransformerNames.collect { "src/main/resources/META-INF/$it" }) } } -apply from: 'gradle/scripts/dependencies.gradle' - -processResources { - rename '(.+_at.cfg)', 'META-INF/$1' -} - -sourceSets { - main { - blossom { - javaSources { - property('mod_id', mod_id) - property('mod_name', mod_name) - property('mod_version', mod_version) - property('package', "${root_package}.${mod_id}") - } - resources { - property('mod_id', mod_id) - property('mod_name', mod_name) - property('mod_version', mod_version) - property('mod_description', mod_description) - property('mod_authors', mod_authors.toString().split(',').findAll { !it.isBlank() }.collect { "\"${it.strip()}\"" }.join(', ')) - property('mod_credits', mod_credits) - property('mod_url', mod_url) - property('mod_update_json', mod_update_json) - property('mod_logo_path', mod_logo_path) - property('mod_issue_tracker', mod_issue_tracker) +cleanroom { + runs { + client { + configure { + username = minecraft_username + jvmArgs extra_jvm_args.tokenize() } } - } -} - -idea { - module { - inheritOutputDirs = true - } - project { - settings { - runConfigurations { - '1. Build'(Gradle) { - taskNames = ["build"] - } - '2. Run Client'(Gradle) { - taskNames = ["runClient"] - } - '3. Run Server'(Gradle) { - taskNames = ["runServer"] - } - } - compiler.javac { - afterEvaluate { - javacAdditionalOptions = '-encoding utf8' - moduleJavacAdditionalOptions = [ - (project.name + '.main'): tasks.compileJava.options.compilerArgs.collect { "\"${it}\"" }.join(' ') - ] - } - } - taskTriggers { - beforeSync tasks.named("genSources") + server { + configure { + jvmArgs extra_jvm_args.tokenize() } } } } -if (!enable_shadow.toBoolean()) { - shadowJar.enabled = false -} - -compileJava { - sourceCompatibility = targetCompatibility = JavaVersion.VERSION_25 +tokenEnvoy { + set 'MOD_VERSION', project.version + set 'MOD_AUTHORS', mod_authors.tokenize(',')*.trim().join('", "') + set file('tokens.properties') } jar { - archiveClassifier = 'dev' - duplicatesStrategy = DuplicatesStrategy.EXCLUDE - if (configurations.contain.size() > 0) { - into('/') { - from configurations.contain + manifest { + if (accessTransformerNames) { + attributes 'FMLAT': accessTransformerNames.join(' ') } - } - doFirst { - manifest { - def attribute_map = [:] - attribute_map['ModType'] = "CRL" - if (configurations.contain.size() > 0) { - attribute_map['ContainedDeps'] = configurations.contain.collect { it.name }.join(' ') - attribute_map['NonModDeps'] = true - } - if (is_coremod.toBoolean()) { - attribute_map['FMLCorePlugin'] = coremod_plugin_class_name - if (coremod_includes_mod.toBoolean()) { - attribute_map['FMLCorePluginContainsFMLMod'] = true - } - } - if (use_access_transformer.toBoolean()) { - attribute_map['FMLAT'] = access_transformer_locations + if (coremod_plugin_class) { + attributes 'FMLCorePlugin': coremod_plugin_class + if (coremod_includes_mod.toBoolean()) { + attributes 'FMLCorePluginContainsFMLMod': true, 'ForceLoadAsMod': true } - attributes(attribute_map) } } - finalizedBy(tasks.named(remapTaskName).get()) } - -shadowJar { - //noinspection GroovyAssignabilityCheck,GroovyAccessibility - configurations = [project.configurations.shadow] - archiveClassifier = "shadow" -} - -compileTestJava { - sourceCompatibility = targetCompatibility = JavaVersion.VERSION_25 +tasks.withType(Checkstyle).configureEach { + enabled = enable_checkstyle.toBoolean() } -test { - useJUnitPlatform() - javaLauncher.set(javaToolchains.launcherFor { - languageVersion = JavaLanguageVersion.of(25) - }) - if (show_testing_output.toBoolean()) { - testLogging { - showStandardStreams = true - } - } +tasks.matching { it.name in ['clearSkiesCheck', 'formatJavaCheck'] }.configureEach { + enabled = enable_formatting.toBoolean() } -tasks.withType(JavaCompile).configureEach { - options.encoding = 'UTF-8' +// TODO: fundamental Foundation issue +tasks.withType(JavaExec).configureEach { + systemProperty 'foundation.loadsall', 'true' } - -apply from: 'gradle/scripts/publishing.gradle' -apply from: 'gradle/scripts/extra.gradle' diff --git a/checkstyle.xml b/checkstyle.xml new file mode 100644 index 0000000..f16e2ac --- /dev/null +++ b/checkstyle.xml @@ -0,0 +1,190 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..8b74ea0 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,190 @@ +# git-cliff configuration. Managed by CleanroomMC/Conventions. Do not edit locally. +# +# The shared release workflow runs this twice: once with --latest for the GitHub +# Release body, once over the full history for CHANGELOG.md committed to the repository. + +# GitHub usernames come from the API. The workflow supplies GITHUB_TOKEN +# and GITHUB_REPO. Commits whose email is not linked to a GitHub account +# have an empty username. The first-time contributor section skips those, +# the GitHub owner (often an organization), bot accounts, and the founder +# on the first release. Bot logins end in [bot], except the Copilot coding +# agent, which the API reports as plain Copilot. +# +# Set CLIFF_INCLUDE_DATE=1 when generating CHANGELOG.md +# Each entry has a date for version heading, GitHub links for commits. + +[changelog] +header = """ +# Changelog +""" +body = """ +{%- macro remote_url() -%} +https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }} +{%- endmacro -%} +{%- macro author(username) -%} +{%- if get_env(name="CLIFF_INCLUDE_DATE", default="") != "" -%} +[@{{ username }}](https://github.com/{{ username }}) +{%- else -%} +@{{ username }} +{%- endif -%} +{%- endmacro -%} +{%- macro issue_ref(hit) -%} +{{ hit | replace_regex(from="(?i)^(?:close[sd]?|fix(?:e[sd])?|resolve[sd]?):?\\s+", to="") }} +{%- endmacro -%} +{%- macro coauthors(commit, commits) -%} +{%- for footer in commit.footers | default(value=[]) -%} +{%- if footer.token == "Co-authored-by" -%} +{%- set name = footer.value | replace_regex(from="\\s*<[^>]*>", to="") | trim -%} +{%- if name != "" and name != commit.author.name -%} +, {{ name }} +{%- endif -%} +{%- endif -%} +{%- endfor -%} +{%- for other in commits -%} +{%- if other.id == commit.id and other.group is containing("Co-authors") -%} +{%- set name = other.message | split(pat="\n") | first | replace_regex(from="\\s*<[^>]*>", to="") | trim -%} +{%- if name != "" and name != commit.author.name -%} +, {{ name }} +{%- endif -%} +{%- endif -%} +{%- endfor -%} +{%- endmacro -%} +{%- macro print_commit(commit, commits) -%} +- {% if commit.scope %}**{{ commit.scope }}**: {% endif -%} +{{ commit.message | split(pat="\f") | first | trim | upper_first -}} +{%- if commit.remote.pr_number %} *[PR by {% if commit.remote.username %}{{ self::author(username=commit.remote.username) }}{% else %}{{ commit.author.name }}{% endif %}{{ self::coauthors(commit=commit, commits=commits) }} in {% if get_env(name="CLIFF_INCLUDE_DATE", default="") != "" %}[#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}){% else %}#{{ commit.remote.pr_number }}{% endif %}]* +{%- elif commit.remote.username %} *[commit by {{ self::author(username=commit.remote.username) }}{{ self::coauthors(commit=commit, commits=commits) }} in {% if get_env(name="CLIFF_INCLUDE_DATE", default="") != "" %}[{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}){% else %}{{ commit.id | truncate(length=7, end="") }}{% endif %}]* +{%- elif commit.author.name %} *[commit by {{ commit.author.name }}{{ self::coauthors(commit=commit, commits=commits) }} in {% if get_env(name="CLIFF_INCLUDE_DATE", default="") != "" %}[{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}){% else %}{{ commit.id | truncate(length=7, end="") }}{% endif %}]* +{%- endif -%} +{%- if commit.breaking -%} +{# split_commits folds the body into breaking_description, so pull the footer text back out. #} +{%- set breaking_note = commit.breaking_description | default(value="") | find_regex(pat="(?is)BREAKING[ -]CHANGE:.*") -%} +{%- if breaking_note | length > 0 %} +{{ " - " }}{{ breaking_note | first | replace_regex(from="(?is)^BREAKING[ -]CHANGE:\\s*", to="") | replace(from="\f", to=" ") | trim | upper_first }} +{%- endif -%} +{%- endif -%} +{%- for hit in commit.raw_message | default(value="") | find_regex(pat="(?i)(?:close[sd]?|fix(?:e[sd])?|resolve[sd]?):?\\s+(?:[\\w.-]+/[\\w.-]+)?#\\d+") %} +{{ " " }}*[Fixes issue {{ self::issue_ref(hit=hit) }}]* +{%- endfor %} +{%- endmacro -%} +{%- set include_date = get_env(name="CLIFF_INCLUDE_DATE", default="") -%} +{%- if include_date -%} +## {% if version %}{{ version }} - {{ timestamp | date(format="%Y-%m-%d") }}{% else %}Unreleased{% endif %} +{%- endif %} +{% if version and previous.version -%} +{% if version | split(pat=".") | first != previous.version | split(pat=".") | first %} +> [!IMPORTANT] +> This is a new major version ({{ previous.version | split(pat=".") | first }}.x → {{ version | split(pat=".") | first }}.x). +{% endif -%} +{% endif -%} +{% set founder = commits | last -%} +{% set all_commits = commits -%} +{% if commits | filter(attribute="breaking", value=true) | length != 0 %} +> [!WARNING] +> This version has breaking changes! More details below. +{% endif -%} +{% if commits | filter(attribute="breaking", value=true) | length != 0 %} +##{% if include_date %}#{% endif %} Breaking Changes + +{% for commit in commits | filter(attribute="breaking", value=true) -%} +{{ self::print_commit(commit=commit, commits=all_commits) }} +{% endfor -%} +{% endif -%} +{% for group, commits in commits | group_by(attribute="group") -%} +{% if group | striptags | trim == "Co-authors" %}{% continue %}{% endif -%} +{% set_global shown = false -%} +{% for commit in commits -%} +{% if commit.breaking %}{% continue %}{% endif -%} +{% if not shown %} +##{% if include_date %}#{% endif %} {{ group | striptags | trim }} + +{% set_global shown = true -%} +{% endif -%} +{{ self::print_commit(commit=commit, commits=all_commits) }} +{% endfor -%} +{% endfor -%} +{% set_global first_timer_heading = false -%} +{% if github and github.contributors -%} +{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) -%} +{% if not contributor.username %}{% continue %}{% endif -%} +{% if contributor.username == remote.github.owner %}{% continue %}{% endif -%} +{% if contributor.username is ending_with("[bot]") %}{% continue %}{% endif -%} +{% if contributor.username == "Copilot" %}{% continue %}{% endif -%} +{% if not previous.version and founder.remote.username == contributor.username %}{% continue %}{% endif -%} +{% if not previous.version and founder.author.name == contributor.username %}{% continue %}{% endif -%} +{% if not first_timer_heading %} +##{% if include_date %}#{% endif %} First-time Contributors + +{% set_global first_timer_heading = true -%} +{% endif -%} +- **{{ self::author(username=contributor.username) }} made their first contribution!** +{% endfor -%} +{% endif -%} +{% if version and previous.version and remote.github.owner %} +**Full Changelog**: {{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }} +{% endif %} +""" +footer = "" +# trim would strip the blank line between releases in CHANGELOG.md. +trim = false + +[git] +conventional_commits = true +filter_unconventional = false +split_commits = true +# Split before parsers so a pack: subject cannot swallow its nested lines. +processing_order = [ + "commit_preprocessors", + "split_commits", + "conventional_commits", + "commit_parsers", + "link_parsers", +] +protect_breaking_commits = true +filter_commits = false +recurse_submodules = true +use_branch_tags = true +topo_order = false +sort_commits = "newest" + +# GitHub squash-merge appends "(#123)" to the subject. Strip it so the +# changelog line stays the commit message, with the hash in the byline. +# +# pack: is the opt-in multi-change squash type. Nested body lines are +# often GitHub bullets; strip those so they parse as conventional commits. +# split_commits is global, so non-pack bodies are collapsed onto the subject +# line with FF, which git-cliff's lines() does not split on. Co-authored-by +# lines keep their newline so they split off into the Co-authors group, which +# the template folds back into the byline. FF and not CR because git-conventional +# treats a lone CR as a line ending and then fails to parse the commit, which +# loses the type, scope and breaking flag. +# Rust's regex crate has no look-ahead, so the pattern only gates on the +# message being multi-line and the pack check lives in the awk program. +commit_preprocessors = [ + { pattern = '\s*\((\w+\s)?#([0-9]+)\)', replace = "" }, + { pattern = '(?m)^[ \t]*[-*][ \t]+', replace = "" }, + { pattern = '(?s)^.*\n', replace_command = '''awk 'NR==1 && /^pack[(!:]/ {pack=1} {printf "%s%s", (NR==1 ? "" : (pack || tolower($0) ~ /^co-authored-by:/ ? "\n" : "\f")), $0}' ''' }, +] + +# HTML comments force group order; Tera's group_by is alphabetical otherwise. +# The template strips them with striptags. +# pack: lands in Comprehensive. Nested feat/fix/… lines keep their groups. +commit_parsers = [ + { message = "^pack(?:\\(|:|!)", group = "Comprehensive" }, + { message = "^feat", group = "Feature" }, + { message = "^fix", group = "Bug Fix" }, + { message = "^perf", group = "Performance" }, + { message = "^refactor", group = "Refactor" }, + { message = "^doc", group = "Documentation" }, + { message = "^test", group = "Testing" }, + { message = "^build", group = "Build and Dependencies" }, + { message = "^chore\\(deps\\)", group = "Build and Dependencies" }, + { message = "^ci", group = "CI" }, + { message = "^chore", skip = true }, + { message = "^style", skip = true }, + { message = "^Merge", skip = true }, + { message = "^revert", skip = true }, + { message = "^Signed-off-by", skip = true }, + { message = "^Co-authored-by", group = "Co-authors" }, + { message = ".*", group = "Other" } +] diff --git a/formatj.toml b/formatj.toml new file mode 100644 index 0000000..a7dd9b5 --- /dev/null +++ b/formatj.toml @@ -0,0 +1,259 @@ +# Managed by CleanroomMC/Conventions. Do not edit locally. +# +# This is the single source of truth for Java layout in this organization. +# +# Rules are spelled out even where they match FormatJ's built-in default. + +[file] +# .editorconfig fixes the line ending and the final newline for every file in the repository, +# so those two follow it rather than the old profile (which never added a final newline). +line-ending = "lf" +final-newline = true +trim-trailing-whitespace = true +charset = "UTF-8" +tab-width = 4 + +[indent] +size = 4 +use-tabs = false +continuation = 4 +chained-call = 4 +array-initializer = 4 +ternary = 4 +throws-clause = 4 +switch-case-labels = true +switch-case-body = true +blank-lines = false + +[wrapping] +max-line-length = 120 +method-parameters = "wrap-if-long" +method-arguments = "wrap-if-long" +chained-calls = "break-all-when-too-long" +chain-threshold = 2 +binary-operators = "wrap-if-long" +operator-position = "after-operator" +method-reference = "never" +method-reference-operator-position = "before-operator" +instanceof = "preserve" +instanceof-operator-position = "after-operator" +multicatch = "never" +multicatch-separator-position = "before-operator" +intersection-types = "never" +intersection-separator-position = "before-operator" +ternary = "wrap-if-long" +assignment = "never" +assignment-break = "inside-value" +hug-sole-argument = true +array-initializers = "chop-down-if-long" +extends-implements = "never" +throws-clause = "wrap-if-long" +type-parameters = "never" +annotation-arguments = "wrap-if-long" +closing-delimiter = "own-line" +break-after-open-paren = false +enum-constants = "chop-down-always" +require-enum-constant-semicolon = false +for-statement = "chop-down-if-long" +try-resources = "never" +keep-simple-methods-on-one-line = false +keep-simple-classes-on-one-line = false +keep-simple-lambdas-on-one-line = false + +[braces] +class-placement = "end-of-line" +method-placement = "end-of-line" +control-placement = "end-of-line" +lambda-placement = "end-of-line" +if-else = "always" +for-loop = "always" +while-loop = "always" +else-on-new-line = false +catch-on-new-line = false +finally-on-new-line = false +empty-class-body = "spaced" +empty-method-body = "spaced" +empty-control-body = "expanded" + +[spacing] +before-method-declaration-parenthesis = false +before-method-call-parenthesis = false +before-if-parenthesis = true +before-for-parenthesis = true +before-while-parenthesis = true +before-switch-parenthesis = true +before-catch-parenthesis = true +before-synchronized-parenthesis = true +within-parentheses = false +within-brackets = false +within-array-initializer-braces = true +within-angle-brackets = false +around-assignment-operators = true +around-binary-operators = true +around-unary-operators = false +around-lambda-arrow = true +around-ternary-operators = true +around-method-reference-operator = false +around-multicatch-separator = true +around-intersection-separator = true +after-comma = true +before-comma = false +after-semicolon-in-for = true +before-semicolon = false +after-type-cast = true +before-colon-in-enhanced-for = true +after-colon-in-enhanced-for = true +before-colon-in-case-label = false +around-case-arrow = true +before-annotation-parenthesis = false +before-array-brackets = false +after-varargs-ellipsis = true + +[blank-lines] +max-consecutive = 1 +after-package = 1 +after-imports = 1 +before-class = 1 +before-method = 1 +before-field = 0 +after-class-opening-brace = 1 +before-class-closing-brace = 1 +strip-at-brace-edges = false +around-initializer-block = 1 +before-record-compact-constructor = 1 +after-enum-constants = 0 +before-first-enum-constant = 1 +between-switch-cases = 0 +between-member-groups = 1 + +[alignment] +consecutive-fields = "none" +consecutive-variables = "none" +consecutive-assignments = "none" +method-chains = "none" +annotation-values = "none" +switch-arrows = "none" +ternary-branches = "none" +trailing-comments = "none" + +[annotations] +declaration-placement = "new-line" +parameter-placement = "same-line" +field-placement = "same-line" +single-marker-inline = false + +[imports] +order = "ascending" +# Groups descend from the code we own to the platforms we sit on. The longest matching prefix wins, +# so a prefix that no file uses costs nothing. +groups = [ + # Ours + ["com.cleanroommc", "zone.rong", "top.outlands"], + # Third-party + "*", + # Gradle + "org.gradle", + # Coremods and bytecode + ["org.spongepowered", "com.llamalad7", "org.objectweb.asm"], + # The game + ["net.minecraft", "net.minecraftforge", "mcp", "com.mojang", "org.lwjgl"], + # JDK + ["javax", "java"], +] +static-placement = "last" +blank-line-between-groups = true +module-imports-first = true +remove-unused = false + +[modifiers] +order = "canonical" +remove-redundant = true + +[module] +brace-placement = "inherit" +empty-body = "inherit" +blank-lines-after-opening-brace = "inherit" +blank-lines-before-closing-brace = "inherit" +blank-lines-between-directive-groups = 0 +exports-opens-target-list-wrapping = "never" +provides-implementation-list-wrapping = "never" + +[comments] +reflow = "preserve" +block-comment-star-alignment = true +trailing-comment-min-spaces = 1 +trailing-comment-column = 0 +keep-first-column-comments = false +indent-with-code = true +honour-formatter-off = true +off-marker = "@formatter:off" +on-marker = "@formatter:on" + +[javadoc] +wrap = false +tag-order = "preserve" +blank-line-before-tags = true +align-tag-descriptions = false +add-paragraph-tags = false +keep-single-line = false +tag-continuation-indent = 0 +closing-tag-form = "preserve" +opening-tag-position = "preserve" + +[switch] +case-style = "arrow" +arrow-case-braces = "when-multi-statement" +yield-style = "expression-when-possible" +multi-label-wrapping = "wrap-if-long" +null-default-on-one-line = true +guard-on-same-line = true +arrow-body-on-new-line-when-long = true + +[records] +component-wrapping = "chop-down-if-long" +single-line-empty-body = false +compact-constructor-blank-line = false +with-style = "inline-when-short" +space-before-with-block = true + +[patterns] +deconstruction-wrapping = "wrap-if-long" +keep-simple-pattern-inline = true +nested-indent = 4 + +[sealed] +permits-wrapping = "wrap-if-long" +permits-order = "preserve" +permits-on-new-line = false + +[lambdas] +parameter-style = "omit-when-possible" +body-braces = "when-multi-statement" +keep-single-expression-inline = true + +[text-blocks] +indent-policy = "preserve" +closing-delimiter-on-own-line = false +escape-trailing-spaces = false + +[literals] +long-suffix = "upper" +hex-digits = "upper" + +[semicolons] +remove-redundant = true + +[preservation] +keep-author-blank-lines = true +max-preserved-blank-lines = 1 +keep-line-break-after-open-paren = false +keep-simple-blocks-inline = false +keep-array-initializer-layout = false +respect-existing-chain-breaks = false +never-join-lines = false + +[arrays] +c-style-brackets = "java" + +[members] +order = "intellij" diff --git a/gradle.properties b/gradle.properties index b3b03d2..bbb0120 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,76 +1,69 @@ -# Gradle Properties -org.gradle.jvmargs = -Xmx3G +org.gradle.configuration-cache = true -# Compilation Options -generate_sources_jar = true -generate_javadocs_jar = false - -# Testing -enable_junit_testing = true -show_testing_output = false - -# Shadow -enable_shadow = false - -# Set this to true if you want to use old LWJGL2 methods. -# WARNING: Using LWJGL2 is no longer recommend, and some methods in LWJGL2 will be unavailable. -# If you are porting an old mod lazily just set this to true. -enable_lwjglx = true +# Cleanroom +# This template only works with Cleanroom 0.7.0 and above +cleanroom_version = 0.7.4-alpha # Mod Information -# HIGHLY RECOMMEND complying with SemVer for mod_version: https://semver.org/ -mod_version = 1.0.0 +# The version is computed from git tags by Versioning, run `gradlew -q printVersion` to see it +# Tag `1.0.0` to release it. A suffix on the tag picks the release type: +# 1.0.0-alpha = alpha +# 1.0.0-beta = beta +# 1.0.0-rc = release candidate, uploaded to CurseForge and Modrinth as beta +# 1.0.0-release = release, same as the bare `1.0.0` +# Untagged builds inherit the type of the highest staged tag in the same major version, +# else beta below 1.0.0 and release from there on root_package = com.example mod_id = modid mod_name = Mod Name # Mod Metadata (Optional) +# Every property in the two sections above and below is a Token Envoy token, see tokens.properties mod_description = mod_url = mod_update_json = -# Delimit authors with commas +# Delimit authors with commas. When set, they also become the copyright holder in LICENSE and HEADER mod_authors = mod_credits = mod_logo_path = -mod_issue_tracker = # Run Configurations -# If multiple arguments/tweak classes are stated, use spaces as the delimiter +# Delimit multiple JVM arguments with spaces minecraft_username = Developer extra_jvm_args = -enable_foundation_debug = false -# Maven Publishing (Provide secret: MAVEN_USER, MAVEN_PASS) -publish_to_maven = false -# Good for debugging artifacts before uploading to remote maven -# GitHub actions won't run if this is true, test this by running the task `publishToMavenLocal` -publish_to_local_maven = false -maven_name = ${mod_name} -maven_url = +# Access Transformers (Optional) +# File names under src/main/resources/META-INF, delimited with spaces, e.g. modid_at.cfg +access_transformers = -# If any properties changes below this line, refresh gradle again to ensure everything is working correctly. -# ---------------------------------------------------------------------------------------------------------------------- +# Coremod (Optional) +# Fully-qualified name of the class implementing IFMLLoadingPlugin +coremod_plugin_class = +# Set to false when the coremod jar has no @Mod class +coremod_includes_mod = true -# Access Transformers -# A way to change visibility of Minecraft's classes, methods and fields -# An example access transformer file is given in the path: `src/main/resources/example_at.cfg` -# AT files should be in the root of src/main/resources with the filename formatted as: `mod_id_at.cfg` -# Use the property `access_transformer_locations` to state custom AT files if you aren't using the default `mod_id_at.cfg` location -# If multiple locations are stated, use spaces as the delimiter -# WARNING: Use MCP name in AT file. Unimined will remap it to srg name when building. -use_access_transformer = true +# Mixin (Optional) +# Name of the refmap the Mixin config points at, e.g. mixins.modid.refmap.json +# Setting it adds the Mixin annotation processors and puts the refmap in both jars +cg.userdev.refmap = -# Coremods -# The most powerful way to change java classes at runtime, it is however very primitive with little documentation. -# Only make a coremod if you are absolutely sure of what you are doing -# Change the property `coremod_includes_mod` to false if your coremod doesn't have a @Mod annotation -# You MUST state a class name for `coremod_plugin_class_name` if you are making a coremod, the class should implement `IFMLLoadingPlugin` -is_coremod = false -coremod_includes_mod = true -coremod_plugin_class_name = +# Publishing (Optional), ran by the release workflow through `publishMods` +# Provide secrets: CURSEFORGE_TOKEN, MODRINTH_TOKEN +# The CurseForge project ID is the numerical ID and not the slug +curseforge_project_id = +modrinth_project_id = + +# Conventions (https://github.com/CleanroomMC/Conventions#configuration) +# One of: free (MIT), open (LGPLv3), visible (CleanroomMC License), none +# Run `gradlew extractConventions applyLicenseHeader` after changing it +conventions.license = open +conventions.javaMajor = 25 +# Code Style +# When true, `gradlew build` fails on a violation. The `Apply` tasks work either way +# Checkstyle, with the rules in checkstyle.xml. It also requires the license header on every Java file +enable_checkstyle = false +# FormatJ and ClearSkies, fix with `gradlew clearSkiesApply formatJavaApply` +enable_formatting = false -# AssetMover -# Convenient way to allow downloading of assets from official vanilla Minecraft servers, CurseForge, or any direct links -# Documentation: https://github.com/CleanroomMC/AssetMover -use_asset_mover = false -asset_mover_version = 2.5 \ No newline at end of file +# The branch release tags are cut from +versioning.releaseBranch = main diff --git a/gradle/scripts/dependencies.gradle b/gradle/scripts/dependencies.gradle deleted file mode 100644 index 590685f..0000000 --- a/gradle/scripts/dependencies.gradle +++ /dev/null @@ -1,59 +0,0 @@ -repositories { - // Other repositories described by default: - // CleanroomMC: https://maven.cleanroommc.com - maven { - name = 'CurseMaven' - url = 'https://cursemaven.com' - } - maven { - name = 'CleanroomCurseMaven' - url = 'https://curse.cleanroommc.com' - } - maven { - name = 'Modrinth' - url = 'https://api.modrinth.com/maven' - } - mavenCentral() - mavenLocal() // Must be last for caching to work -} - -dependencies { - if (enable_lwjglx.toBoolean()) { - compileOnly "com.cleanroommc:lwjglx:1.0.0" - } - - modDevImplementation 'mezz:jei:4.35.0:dev' - - // Example - Dependency descriptor: - // 'com.google.code.gson:gson:2.8.6' << group: com.google.code.gson, name:gson, version:2.8.6 - // 'group:name:version:classifier' where classifier is optional - - // Example - CurseMaven dependencies: - // 'curse.maven:had-enough-items-557549:4543375' << had-enough-items = project slug, 557549 = project id, 4543375 = file id - // Full documentation: https://cursemaven.com/ - - // Example - Modrinth dependencies: - // 'maven.modrinth:jei:4.16.1.1000' << jei = project name, 4.16.1.1000 = file version - // Full documentation: https://docs.modrinth.com/docs/tutorials/maven/ - - // Common dependency types (configuration): - // implementation = dependency available at both compile time and runtime - // runtimeOnly = runtime dependency - // compileOnly = compile time dependency - // annotationProcessor = annotation processing dependencies - // contain = bundle dependency jars into final artifact, will extract them in mod loading. Can be used it as jar-in-jar - // shadow = bundle dependencies into shadow output artifact (relocation configurable in shadowJar task) - // modImplementation = mod dependency available at both compile time and runtime - // modDevImplementation = like modImplementation, but without refmapping - // modCompileOnly = mod dependency available only at compile time - // modRuntimeOnly = mod dependency available only at runtime - // modLibrary = won't be remap but will be forced injected into classpath later - - // Transitive dependencies: - // (Dependencies that your dependency depends on) - // If you wish to exclude transitive dependencies in the described dependencies - // Use a closure as such: - // implementation ('com.google.code.gson:gson:2.8.6') { - // transitive = false - // } -} diff --git a/gradle/scripts/extra.gradle b/gradle/scripts/extra.gradle deleted file mode 100644 index 106911e..0000000 --- a/gradle/scripts/extra.gradle +++ /dev/null @@ -1,5 +0,0 @@ -// You may write any gradle buildscript component in this file -// This file is automatically applied after build.gradle + dependencies.gradle is ran - -// Helper methods (assertProperty, assertSubProperties, setDefaultProperty) are -// defined directly in build.gradle's script scope and exported via ext. diff --git a/gradle/scripts/publishing.gradle b/gradle/scripts/publishing.gradle deleted file mode 100644 index 94a8e45..0000000 --- a/gradle/scripts/publishing.gradle +++ /dev/null @@ -1,25 +0,0 @@ -if (publish_to_maven.toBoolean()) { - publishing { - repositories { - maven { - name = maven_name.replaceAll("\\s", "") - url = maven_url - credentials(PasswordCredentials) - } - } - publications { - mavenJava(MavenPublication) { - from components.java // Publish with standard artifacts - setGroupId(root_package)// Publish with root package as maven group - setArtifactId(mod_id) // Publish artifacts with mod id as the artifact id - - // Custom artifact: - // If you want to publish a different artifact to the one outputted when building normally - // Create a different gradle task (Jar task), in extra.gradle - // Remove the 'from components.java' line above - // Add this line (change the task name): - // artifacts task_name - } - } - } -} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index f8e1ee3..9fa7f28 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 299848b..2e7bb9f 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,7 +1,9 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-9.8.0-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-9.8.1-bin.zip networkTimeout=10000 +retries=0 +retryBackOffMs=500 validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index adff685..249efbb 100755 --- a/gradlew +++ b/gradlew @@ -20,7 +20,7 @@ ############################################################################## # -# Gradle start up script for POSIX generated by Gradle. +# gradlew start up script for POSIX generated by Gradle. # # Important for running: # @@ -29,7 +29,7 @@ # bash, then to run this script, type that shell name before the whole # command line, like: # -# ksh Gradle +# ksh gradlew # # Busybox and similar reduced shells will NOT work, because this script # requires all of these POSIX shell features: @@ -57,7 +57,7 @@ # 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 +# https://github.com/gradle/gradle/blob/3d91ce3b8caaf77ad09f381f43615b715b53f72c/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/. diff --git a/gradlew.bat b/gradlew.bat index e509b2d..3185a43 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,93 +1,112 @@ -@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 - - - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* - -: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 +@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 gradlew startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables, and ensure extensions are enabled +setlocal EnableExtensions + +@rem Catch executions from older scripts and ensure they exit cleanly. +@rem This can be removed once we can be reasonably confident that few people +@rem will be migrating directly to this new wrapper. +goto afterSafetyNet +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: +goto exitWithErrorLevel +:afterSafetyNet + +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 + +1>&2 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. + +"%COMSPEC%" /c exit 1 +goto exitWithErrorLevel + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +1>&2 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. + +"%COMSPEC%" /c exit 1 +goto exitWithErrorLevel + +:execute +@rem Setup the command line + + + +@rem Execute gradlew +@rem endlocal doesn't take effect until after the line is parsed and variables are expanded +@rem which allows us to clear the local environment before executing the java command +endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel & goto exitWithErrorLevel + +@rem This label must not be changed. We rely on old scripts being able to jump to this point. +:exitWithErrorLevel +@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts +"%COMSPEC%" /c exit %ERRORLEVEL% diff --git a/settings.gradle b/settings.gradle index 0191728..3799fca 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,35 +1,12 @@ pluginManagement { repositories { - gradlePluginPortal() { - content { - excludeGroup('org.apache.logging.log4j') - } - } - mavenCentral() - maven { - url = 'https://maven.minecraftforge.net/' - } maven { - url = 'https://maven.fabricmc.net/' - } - maven { - url = 'https://maven.wagyourtail.xyz/releases' - } - maven { - url = 'https://maven.arcseekers.com/releases' - } - - maven { - url = 'https://maven.wagyourtail.xyz/snapshots' + url = 'https://maven.cleanroommc.com' } + gradlePluginPortal() } } plugins { - // Automatic toolchain provisioning - id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0' + id 'com.cleanroommc.cleanroomgradle.settings' version '0.22.0' } - -// Due to an IntelliJ bug, this has to be done -// rootProject.name = archives_base_name -rootProject.name = rootProject.projectDir.getName() diff --git a/src/main/java-templates/com/example/modid/Reference.java b/src/main/java-templates/com/example/modid/Reference.java deleted file mode 100644 index 28b38f1..0000000 --- a/src/main/java-templates/com/example/modid/Reference.java +++ /dev/null @@ -1,13 +0,0 @@ -package {{ package }}; - -/** - * Tags storage class, you can change at will - */ -public class Reference { - private Reference() {} - - public static final String MOD_ID = "{{ mod_id }}"; - public static final String MOD_NAME = "{{ mod_name }}"; - public static final String VERSION = "{{ mod_version }}"; - -} diff --git a/src/main/java/com/example/modid/ExampleMod.java b/src/main/java/com/example/modid/ExampleMod.java index 5cf1b14..3739fc0 100644 --- a/src/main/java/com/example/modid/ExampleMod.java +++ b/src/main/java/com/example/modid/ExampleMod.java @@ -1,20 +1,21 @@ +/* + * Copyright (c) 2026 CleanroomMC contributors + * SPDX-License-Identifier: LGPL-3.0-only + */ + package com.example.modid; -import com.example.modid.proxy.IProxy; -import net.minecraft.client.Minecraft; -import net.minecraftforge.fml.common.Mod; -import net.minecraftforge.fml.common.SidedProxy; -import net.minecraftforge.fml.common.event.FMLPreInitializationEvent; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; -@Mod(modid = Reference.MOD_ID, name = Reference.MOD_NAME, version = Reference.VERSION) +import net.minecraftforge.fml.common.Mod; +import net.minecraftforge.fml.common.event.FMLPreInitializationEvent; + +@Mod(modid = "@{MOD_ID}", name = "@{MOD_NAME}", version = "@{MOD_VERSION}") public class ExampleMod { - public static final Logger LOGGER = LogManager.getLogger(Reference.MOD_NAME); + public static final Logger LOGGER = LogManager.getLogger("@{MOD_NAME}"); - @SidedProxy(modId = Reference.MOD_ID, clientSide = "com.example.modid.proxy.ClientProxy", serverSide = "com.example.modid.proxy.CommonProxy") - public static IProxy proxy; /** * * Take a look at how many FMLStateEvents you can listen to via the @Mod.EventHandler annotation here @@ -22,9 +23,7 @@ public class ExampleMod { */ @Mod.EventHandler public void preInit(FMLPreInitializationEvent event) { - LOGGER.info("Hello From {}!", Reference.MOD_NAME); - LOGGER.info("Proxy is {}", proxy); - LOGGER.info("Language: {}", Minecraft.getMinecraft().getLanguageManager().getCurrentLanguage()); + LOGGER.info("Hello From {}!", "@{MOD_NAME}"); } } diff --git a/src/main/java/com/example/modid/proxy/ClientProxy.java b/src/main/java/com/example/modid/proxy/ClientProxy.java deleted file mode 100644 index e8b612d..0000000 --- a/src/main/java/com/example/modid/proxy/ClientProxy.java +++ /dev/null @@ -1,4 +0,0 @@ -package com.example.modid.proxy; - -public class ClientProxy implements IProxy{ -} diff --git a/src/main/java/com/example/modid/proxy/CommonProxy.java b/src/main/java/com/example/modid/proxy/CommonProxy.java deleted file mode 100644 index 7e5ed51..0000000 --- a/src/main/java/com/example/modid/proxy/CommonProxy.java +++ /dev/null @@ -1,4 +0,0 @@ -package com.example.modid.proxy; - -public class CommonProxy implements IProxy { -} diff --git a/src/main/java/com/example/modid/proxy/IProxy.java b/src/main/java/com/example/modid/proxy/IProxy.java deleted file mode 100644 index af31e09..0000000 --- a/src/main/java/com/example/modid/proxy/IProxy.java +++ /dev/null @@ -1,4 +0,0 @@ -package com.example.modid.proxy; - -public interface IProxy { -} diff --git a/src/main/resource-templates/mcmod.info b/src/main/resource-templates/mcmod.info deleted file mode 100644 index 7845443..0000000 --- a/src/main/resource-templates/mcmod.info +++ /dev/null @@ -1,15 +0,0 @@ -[{ - "modid": "{{ mod_id }}", - "name": "{{ mod_name }}", - "version": "{{ mod_version }}", - "mcversion": "1.12.2", - "description": "{{ mod_description }}", - "authorList": [{{ mod_authors }}], - "credits": "{{ mod_credits }}", - "url": "{{ mod_url }}", - "updateJSON": "{{ mod_update_json }}", - "logoFile": "{{ mod_logo_path }}", - "modProperties": { - "issueTrackerUrl": "{{ mod_issue_tracker }}" - } -}] diff --git a/src/main/resource-templates/pack.mcmeta b/src/main/resource-templates/pack.mcmeta deleted file mode 100644 index 51e635d..0000000 --- a/src/main/resource-templates/pack.mcmeta +++ /dev/null @@ -1,6 +0,0 @@ -{ - "pack": { - "description": "{{ mod_name }} Resources", - "pack_format": 3 - } -} \ No newline at end of file diff --git a/src/main/resources/mcmod.info b/src/main/resources/mcmod.info new file mode 100644 index 0000000..4abdc8a --- /dev/null +++ b/src/main/resources/mcmod.info @@ -0,0 +1,12 @@ +[{ + "modid": "@{MOD_ID}", + "name": "@{MOD_NAME}", + "version": "@{MOD_VERSION}", + "mcversion": "1.12.2", + "description": "@{MOD_DESCRIPTION}", + "authorList": ["@{MOD_AUTHORS}"], + "credits": "@{MOD_CREDITS}", + "url": "@{MOD_URL}", + "updateJSON": "@{MOD_UPDATE_JSON}", + "logoFile": "@{MOD_LOGO_PATH}" +}] diff --git a/src/main/resources/modid_at.cfg b/src/main/resources/modid_at.cfg deleted file mode 100644 index 3d61d66..0000000 --- a/src/main/resources/modid_at.cfg +++ /dev/null @@ -1 +0,0 @@ -public net.minecraft.client.Minecraft fileResourcepacks # Example mcp name AT entry \ No newline at end of file diff --git a/src/main/resources/pack.mcmeta b/src/main/resources/pack.mcmeta new file mode 100644 index 0000000..953babc --- /dev/null +++ b/src/main/resources/pack.mcmeta @@ -0,0 +1,6 @@ +{ + "pack": { + "description": "@{MOD_NAME} Resources", + "pack_format": 3 + } +} diff --git a/tokens.properties b/tokens.properties new file mode 100644 index 0000000..9105945 --- /dev/null +++ b/tokens.properties @@ -0,0 +1,12 @@ +# Token Envoy tokens, written as `@{KEY}` in classes and resources +# Values may reference any gradle property with ${property_name} +# MOD_VERSION and MOD_AUTHORS are declared in build.gradle, since they are computed + +MOD_ID = ${mod_id} +MOD_NAME = ${mod_name} +MOD_DESCRIPTION = ${mod_description} +MOD_URL = ${mod_url} +MOD_UPDATE_JSON = ${mod_update_json} +MOD_CREDITS = ${mod_credits} +MOD_LOGO_PATH = ${mod_logo_path} +CLEANROOM_VERSION = ${cleanroom_version}