Trace:

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
plugin:get_started [2022/09/16 13:57] – created shedanielplugin:get_started [2024/05/02 11:52] (current) – Use new generator website shedaniel
Line 1: Line 1:
 ====== Get Started With Architectury ====== ====== Get Started With Architectury ======
 +To get started, you can either:
 +  - Go to [[https://generate.architectury.dev]] and download it as a Gradle project, there should be options for Architectury API, package names, etc.
  
-To get started, download templates from [[https://github.com/architectury/architectury-templates/releases/|Architectury Templates]] and import it as a Gradle project. 
  
-You will want to **change every reference** of examplemod to your mod, this includes ''gradle.properies'', ''fabric.mod.json'', ''META-INF/mods.toml'', ''quilt.mod.json'' (If Applicable), and relocate the classes. You will also need to change the access widener file name in ''common/build.gradle''.+==== ...ParchmentMC? ====
  
-==== I don't want Architectury API... ====+Basically, follow [[https://parchmentmc.org/docs/getting-started|their instructions]] according to Fabric/Loom, with the exception that the **Parchment repository** block is placed in ''allprojects''... 
 +<code diff> 
 +allprojects { 
 +    apply plugin: "java" 
 +    apply plugin: "architectury-plugin" 
 +    apply plugin: "maven-publish"
  
-Remove lines related to Architectury API in each of the ''build.gradle'' in ''common/'', ''fabric/'', and ''forge/''. They should look at this:+    archivesBaseName = rootProject.archives_base_name 
 +    version = rootProject.mod_version 
 +    group = rootProject.maven_group
  
-<code diff> +    repositories { 
-dependencies { +-       // Add repositories to retrieve artifacts from in here. 
-    // We depend on fabric loader here to use the fabric @Environment annotations and get the mixin dependencies +-       // You should only use this when depending on other mods because 
-    // Do NOT use other classes from fabric loader +-       // Loom adds the essential maven repositories to download Minecraft and libraries from automatically. 
-    modImplementation "net.fabricmc:fabric-loader:${rootProject.fabric_loader_version}" +-       // See https://docs.gradle.org/current/userguide/declaring_repositories.html 
-    // Remove the next line if you don't want to depend on the API +-       // for more information about repositories. 
--   modApi "dev.architectury:architectury:${rootProject.architectury_version}" ++       maven { 
-}++           name = 'ParchmentMC' 
 ++           url = 'https://maven.parchmentmc.org' 
 ++       } 
 +    }
 </code> </code>
- +... and the **mappings dependency** in ''subprojects'':
-==== I want Yarn instead... ==== +
- +
-Replace the line for the default Mojang Mappings in the root ''build.gradle'', with one that references Yarn instead: +
 <code diff> <code diff>
 subprojects { subprojects {
Line 33: Line 40:
     dependencies {     dependencies {
         minecraft "com.mojang:minecraft:${rootProject.minecraft_version}"         minecraft "com.mojang:minecraft:${rootProject.minecraft_version}"
--       // The following line declares the mojmap mappings, you may use other mappings as well+        // The following line declares the mojmap mappings, you may use other mappings as well
 -       mappings loom.officialMojangMappings() -       mappings loom.officialMojangMappings()
-        // The following line declares the yarn mappings you may select this one as well.++       // Use mojmap with ParchmentMC 
 ++ mappings loom.layered() { 
 ++           officialMojangMappings() 
 ++           parchment("org.parchmentmc.data:parchment-${rootProject.minecraft_version}:@PARCHMENTMC_MAPPINGS_YY.MM.DD@zip") 
 ++       } 
 +-       // The following line declares the yarn mappings you may select this one as well.
 -       // mappings "net.fabricmc:yarn:@YARN_MAPPINGS@:v2" -       // mappings "net.fabricmc:yarn:@YARN_MAPPINGS@:v2"
-+       mappings "net.fabricmc:yarn:@YARN_MAPPINGS@:v2" 
     }     }
 } }
 </code> </code>
 +This is all performed in the root build.gradle script.
 +
 +====== Next steps ======
 +
 +You can learn about:
 +  - Additional [[plugin:gradle_configurations|gradle configurations]] for e.g. using libraries or depending on other mods;
 +  - The [[loom:introduction|Loom]] build plugin, used as a replacement to ForgeGradle;
 +  - Get coding with the [[api:introduction|Architectury API]]; or
 +  - [[:start|Head back to the top]].