Differences

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

--- plugin:get_started [2023/08/27 15:42] – Give actual location of generating template task in IntelliJ cosmicdan
+++ plugin:get_started [2024/05/02 11:52] (current) – Use new generator website shedaniel
@@ Line 1: / Line 1: @@
 ====== Get Started With Architectury ======
 To get started, you can either:
-  - Download [[https://github.com/architectury/architectury-templates/releases/|Architectury Templates]] and import it as a Gradle project, or;
+  - Go to [[https://generate.architectury.dev]] and download it as a Gradle project, there should be options for Architectury API, package names, etc.
-  - Generate updated templates from the template generator, explained further on //(Updated Templates)//.
-In any case, 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? ====
@@ Line 94: / Line 54: @@
 This is all performed in the root build.gradle script.
-====== Updated templates ======
+====== Next steps ======
-<WRAP #updated_templates/>
-Since the upstream modloaders and API's are regularly updating, it may be ideal to generate an up-to-date template:
+You can learn about:
-  - Download the [[https://github.com/architectury/architectury-templates/archive/refs/heads/master.zip|latest code as a ZIP]]
+  - Additional [[plugin:gradle_configurations|gradle configurations]] for e.g. using libraries or depending on other mods;
-  - Extract it and perform the ''runLocal'' task, e.g. ''gradlew runLocal'', import into IntelliJ (under "Tasks > other > runLocal" folder, etc.
+  - The [[loom:introduction|Loom]] build plugin, used as a replacement to ForgeGradle;
-  - Check freshly generated templates under ''build/templates''.
+  - Get coding with the [[api:introduction|Architectury API]]; or
-<WRAP right round tip 40% lo>
+  - [[:start|Head back to the top]].
-Be aware of different flavours on [[https://github.com/architectury/architectury-templates/releases|Releases]], e.g. fabric-quilt is not recommended.
-</WRAP>
-These updates will generate templates with the latest detected library/loader versions for the applicable Minecraft and flavour config dependencies. This includes Architectury API, Forge, Fabric, Quilt, where applicable.