Skip to content

Commit

Permalink
Initialize 1.19.2
Browse files Browse the repository at this point in the history
  • Loading branch information
DadamaldaDad authored Aug 12, 2024
0 parents commit b3ec56b
Show file tree
Hide file tree
Showing 34 changed files with 1,298 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: build
on: [ pull_request, push ]

jobs:
build:
strategy:
matrix:
java: [ 17 ]
runs-on: ubuntu-latest
steps:

- name: checkout repository
uses: actions/checkout@v2

- name: setup jdk ${{ matrix.java }}
uses: actions/setup-java@v1
with:
java-version: ${{ matrix.java }}

- uses: actions/cache@v2
with:
path: |
~/.gradle/caches
~/.gradle/loom-cache
~/.gradle/wrapper
key: ${{ runner.os }}-gradle-${{ hashFiles('**/gradle-wrapper.properties') }}
restore-keys: ${{ runner.os }}-gradle

- name: make gradle wrapper executable
run: chmod +x ./gradlew

- name: build
run: ./gradlew build

- name: capture build artifacts
uses: actions/upload-artifact@v2
with:
name: Artifacts
path: build/libs/
19 changes: 19 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
build/
*.ipr
run/
*.iws
out/
*.iml
.gradle/
output/
bin/
libs/

.classpath
.project
.idea/
classes/
.metadata
.vscode
.settings
*.launch
121 changes: 121 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
Creative Commons Legal Code

CC0 1.0 Universal

CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
HEREUNDER.

Statement of Purpose

The laws of most jurisdictions throughout the world automatically confer
exclusive Copyright and Related Rights (defined below) upon the creator
and subsequent owner(s) (each and all, an "owner") of an original work of
authorship and/or a database (each, a "Work").

Certain owners wish to permanently relinquish those rights to a Work for
the purpose of contributing to a commons of creative, cultural and
scientific works ("Commons") that the public can reliably and without fear
of later claims of infringement build upon, modify, incorporate in other
works, reuse and redistribute as freely as possible in any form whatsoever
and for any purposes, including without limitation commercial purposes.
These owners may contribute to the Commons to promote the ideal of a free
culture and the further production of creative, cultural and scientific
works, or to gain reputation or greater distribution for their Work in
part through the use and efforts of others.

For these and/or other purposes and motivations, and without any
expectation of additional consideration or compensation, the person
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
is an owner of Copyright and Related Rights in the Work, voluntarily
elects to apply CC0 to the Work and publicly distribute the Work under its
terms, with knowledge of his or her Copyright and Related Rights in the
Work and the meaning and intended legal effect of CC0 on those rights.

1. Copyright and Related Rights. A Work made available under CC0 may be
protected by copyright and related or neighboring rights ("Copyright and
Related Rights"). Copyright and Related Rights include, but are not
limited to, the following:

i. the right to reproduce, adapt, distribute, perform, display,
communicate, and translate a Work;
ii. moral rights retained by the original author(s) and/or performer(s);
iii. publicity and privacy rights pertaining to a person's image or
likeness depicted in a Work;
iv. rights protecting against unfair competition in regards to a Work,
subject to the limitations in paragraph 4(a), below;
v. rights protecting the extraction, dissemination, use and reuse of data
in a Work;
vi. database rights (such as those arising under Directive 96/9/EC of the
European Parliament and of the Council of 11 March 1996 on the legal
protection of databases, and under any national implementation
thereof, including any amended or successor version of such
directive); and
vii. other similar, equivalent or corresponding rights throughout the
world based on applicable law or treaty, and any national
implementations thereof.

2. Waiver. To the greatest extent permitted by, but not in contravention
of, applicable law, Affirmer hereby overtly, fully, permanently,
irrevocably and unconditionally waives, abandons, and surrenders all of
Affirmer's Copyright and Related Rights and associated claims and causes
of action, whether now known or unknown (including existing as well as
future claims and causes of action), in the Work (i) in all territories
worldwide, (ii) for the maximum duration provided by applicable law or
treaty (including future time extensions), (iii) in any current or future
medium and for any number of copies, and (iv) for any purpose whatsoever,
including without limitation commercial, advertising or promotional
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
member of the public at large and to the detriment of Affirmer's heirs and
successors, fully intending that such Waiver shall not be subject to
revocation, rescission, cancellation, termination, or any other legal or
equitable action to disrupt the quiet enjoyment of the Work by the public
as contemplated by Affirmer's express Statement of Purpose.

3. Public License Fallback. Should any part of the Waiver for any reason
be judged legally invalid or ineffective under applicable law, then the
Waiver shall be preserved to the maximum extent permitted taking into
account Affirmer's express Statement of Purpose. In addition, to the
extent the Waiver is so judged Affirmer hereby grants to each affected
person a royalty-free, non transferable, non sublicensable, non exclusive,
irrevocable and unconditional license to exercise Affirmer's Copyright and
Related Rights in the Work (i) in all territories worldwide, (ii) for the
maximum duration provided by applicable law or treaty (including future
time extensions), (iii) in any current or future medium and for any number
of copies, and (iv) for any purpose whatsoever, including without
limitation commercial, advertising or promotional purposes (the
"License"). The License shall be deemed effective as of the date CC0 was
applied by Affirmer to the Work. Should any part of the License for any
reason be judged legally invalid or ineffective under applicable law, such
partial invalidity or ineffectiveness shall not invalidate the remainder
of the License, and in such case Affirmer hereby affirms that he or she
will not (i) exercise any of his or her remaining Copyright and Related
Rights in the Work or (ii) assert any associated claims and causes of
action with respect to the Work, in either case contrary to Affirmer's
express Statement of Purpose.

4. Limitations and Disclaimers.

a. No trademark or patent rights held by Affirmer are waived, abandoned,
surrendered, licensed or otherwise affected by this document.
b. Affirmer offers the Work as-is and makes no representations or
warranties of any kind concerning the Work, express, implied,
statutory or otherwise, including without limitation warranties of
title, merchantability, fitness for a particular purpose, non
infringement, or the absence of latent or other defects, accuracy, or
the present or absence of errors, whether or not discoverable, all to
the greatest extent permissible under applicable law.
c. Affirmer disclaims responsibility for clearing rights of other persons
that may apply to the Work or any use thereof, including without
limitation any person's Copyright and Related Rights in the Work.
Further, Affirmer disclaims responsibility for obtaining any necessary
consents, permissions or other rights required for any use of the
Work.
d. Affirmer understands and acknowledges that Creative Commons is not a
party to this document and has no duty or obligation with respect to
this CC0 or use of the Work.
92 changes: 92 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Create Multi-Loader Addon Template
A template based on Architectury for creating addons for Create on Forge, Fabric, and Quilt, simultaneously.

## How does it work?
This template is powered by the [Architectury](https://github.com/architectury) toolchain.
Architectury allows developers to create the majority of their mod in common, loader-agnostic code that
only touches Minecraft itself. This can be found in the [common](common) subproject. Each loader target
also has its own subproject: those being [forge](forge) and [fabric](fabric). (Quilt support: you
shouldn't need anything special and the Fabric version should work fine, but it is possible to add a
`quilt` subproject if needed.) These loader-specific projects bridge between their respective loaders
and the common code.

This system can be extended to work with Create as well as plain Minecraft. The common project gives
access to most of Create, Registrate, and Flywheel.

## Limitations
Minecraft has a lot of differences across loaders. You'll need to manage these differences using
abstractions. Architectury does provide an [API](https://github.com/architectury/architectury-api)
which you may use if desired, but it means you have another dependency to worry about.

This also applies to Create, which underwent significant changes in porting to Fabric. This means a lot
of it will be different between loaders. The `common` project is only capable of referencing the code
on one loader (Fabric in this template), so you should be careful to not reference things that don't
exist on the other one. Test often, and check the code on both loaders. When you do need to use these
changed things, that leads us to...

## Solutions
There's a bunch of ways to work around the differences.

First is Architectury API. It provides cross-loader abstractions that can be used in common code for
a decent amount of Minecraft. However, it means you need to worry about another dependency. It also
doesn't really help with Create.

Next is the `@ExpectPlatform` annotation. It allows the implementation of a method to be replaced
at compile time per-loader, letting you make your own abstractions. It is part of the Architectury
plugin and does not cause an extra dependency. However, it can only be placed on static methods. See
[ExampleExpectPlatform](common/src/main/java/net/examplemod/ExampleExpectPlatform.java) in common
for an example.

Finally, simply have a common interface with implementation based on the loader. You might have a
`PlatformHelper` common interface, with a static instance somewhere. On Fabric, set it to a
`FabricPlatformHelper`, and a `ForgePlatformHelper` on Forge. The implementation is kept as a detail
so you can use your helper from common code.

## Features
- Access to Create and all of its dependencies on both loaders
- Mojang Mappings base, with Quilt Mappings and Parchment providing Javadoc and parameters
- VineFlower decompiler for high quality Minecraft sources: `gradlew genSourcesWithVineflower`
- GitHub Actions automatic build workflow
- Machete Gradle plugin to shrink jar file sizes
- Developer QOL: Mod Menu, LazyDFU, JEI

## Use
Ready to get started? First you'll want to create a new repository using this template. You can do it
through GitHub with the big green button near the top that says `Use this template`.

Once you've got your repository set up, you'll want to change all the branding to your mod instead
of the template. Every `examplemod`, every placeholder.

You're free to change your license: CC0 lets you do whatever you want. Base Create is MIT, for reference.

Replace this README with information about your addon. Give it an icon and change the metadata in the
[fabric.mod.json](fabric/src/main/resources/fabric.mod.json) and the
[mods.toml](forge/src/main/resources/META-INF/mods.toml).

Configure your dependencies. Each subproject `build.gradle` has optional dependencies commented.
Either remove them or uncomment them. For Fabric, set your preferred recipe viewer with
`fabric_recipe_viewer` in the root [gradle.properties](gradle.properties).

Remember to remove any example code you don't need anymore.

Get modding!

## Notes
- Architectury does not merge jars; When you build, you get separate jars for each loader.
There is an independent project that can merge these into one if desired called
[Forgix](https://github.com/PacifistMC/Forgix).
- The file names and versions of jars are configured in the root [build.gradle](build.gradle). Feel
free to change the format if desired, but make sure it follows SemVer to work well on Fabric.
- When publishing, you should always let GitHub Actions build your release jars. These builds will
have build number metadata, and will be compressed by the Machete plugin.

## Other Templates
- [Fabric-only template](https://github.com/Fabricators-of-Create/create-fabric-addon-template)
- [Forge-only template](https://github.com/kotakotik22/CreateAddonTemplate)

## Help
Questions? Join us in the #devchat channel of the [Create Discord](https://discord.com/invite/hmaD7Se).

## License

This template is available under the CC0 license. Feel free to do as you wish with it.
79 changes: 79 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
plugins {
id "architectury-plugin" version "3.4-SNAPSHOT"
id "dev.architectury.loom" version "1.5-SNAPSHOT" apply false
id "io.github.p03w.machete" version "1.+" // automatic jar compressing on build
}

architectury {
minecraft = rootProject.minecraft_version
}

subprojects {
apply plugin: "dev.architectury.loom"

loom {
silentMojangMappingsLicense()
}

repositories {
mavenCentral()
maven { url = "https://maven.shedaniel.me/" } // Cloth Config, REI
maven { url = "https://maven.blamejared.com/" } // JEI
maven { url = "https://maven.parchmentmc.org" } // Parchment mappings
maven { url = "https://maven.quiltmc.org/repository/release" } // Quilt Mappings
maven { // Flywheel
url = "https://maven.tterrag.com/"
content {
// need to be specific here due to version overlaps
includeGroup("com.jozufozu.flywheel")
}
}
}

dependencies {
minecraft "com.mojang:minecraft:${minecraft_version}"
// layered mappings - Mojmap names, parchment and QM docs and parameters
mappings(loom.layered {
it.mappings("org.quiltmc:quilt-mappings:${minecraft_version}+build.${qm_version}:intermediary-v2")
it.parchment("org.parchmentmc.data:parchment-${minecraft_version}:${parchment_version}@zip")
it.officialMojangMappings { nameSyntheticMembers = false }
})

// see each subproject for dependencies.
}
}

allprojects {
apply plugin: "java"
apply plugin: "architectury-plugin"
apply plugin: "maven-publish"

archivesBaseName = rootProject.archives_base_name
group = rootProject.maven_group

// Formats the mod version to include the loader, Minecraft version, and build number (if present)
// example: 1.0.0+fabric-1.18.2-100
String buildNumber = System.getenv("GITHUB_RUN_NUMBER")
version = "${mod_version}+${project.name}-${minecraft_version}" + (buildNumber != null ? "-${buildNumber}" : "")

repositories {
// Add repositories to retrieve artifacts from in here.
// You should only use this when depending on other mods because
// Loom adds the essential maven repositories to download Minecraft and libraries from automatically.
// See https://docs.gradle.org/current/userguide/declaring_repositories.html
// for more information about repositories.
}

tasks.withType(JavaCompile) {
options.encoding = "UTF-8"
}

java {
withSourcesJar()
}

machete {
// disable machete locally for faster builds
enabled = buildNumber != null
}
}
Loading

0 comments on commit b3ec56b

Please sign in to comment.