Trace:

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
plugin:get_started [2023/08/27 15:18] – Add section about using ParchmentMC.org mappings cosmicdanplugin: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''. 
- 
-==== I don't want Architectury API... ==== 
- 
-Remove lines related to Architectury API in each of the ''build.gradle'' in ''common/'', ''fabric/'', and ''forge/''. They should look at this: 
- 
-<code diff> 
-dependencies { 
-    // We depend on fabric loader here to use the fabric @Environment annotations and get the mixin dependencies 
-    // Do NOT use other classes from fabric loader 
-    modImplementation "net.fabricmc:fabric-loader:${rootProject.fabric_loader_version}" 
-    // Remove the next line if you don't want to depend on the API 
--   modApi "dev.architectury:architectury:${rootProject.architectury_version}" 
-} 
-</code> 
- 
-==== 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> 
-subprojects { 
-    apply plugin: "dev.architectury.loom" 
- 
-    loom { 
-        silentMojangMappingsLicense() 
-    } 
- 
-    dependencies { 
-        minecraft "com.mojang:minecraft:${rootProject.minecraft_version}" 
--       // The following line declares the mojmap mappings, you may use other mappings as well 
--       mappings loom.officialMojangMappings() 
-        // 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" 
-    } 
-} 
-</code> 
  
 ==== ...ParchmentMC? ==== ==== ...ParchmentMC? ====
Line 91: Line 53:
 </code> </code>
 This is all performed in the root build.gradle script. 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]].