Fabric Wiki

User Tools

Site Tools

Trace:
tutorial:minotaur

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
tutorial:minotaur [2020/12/27 18:13] – [Basic] calum6541tutorial:minotaur [2022/10/22 23:48] (current) – More appropriate heading changes budavissza
Line 1: Line 1:
-====== Publishing your mod on Modrinth using Minotaur. ======+====== Publishing your mod on Modrinth using Minotaur ======
  
-Minotaur is a gradle plugin similar to CurseGradle. +Minotaur is a Gradle plugin similar to CurseGradle. 
-This page only goes through the basics of Minotaur, you should [[https://github.com/modrinth/minotaur|checkout its GitHub documentation for a further understanding.]]+This page only goes through the basics of Minotaur, and you should [[https://github.com/modrinth/minotaur|check out its GitHub documentation for further information]].
  
-===== Basic =====+===== Basic Implementation =====
  
 +First of all, add the Minotaur plugin to your plugins list in your ''build.gradle'' file as so:
  
-First of all, add the minotaur plugin to your plugins list in your ''build.gradle'' file as so: +<code groovy>
- +
-<code java>+
 plugins { plugins {
-    id "com.modrinth.minotaur" version "1.1.0"+    id "com.modrinth.minotaur" version "2.+"
 } }
 </code> </code>
  
-Now you can create a new gradle task for uploading to modrinth.+Minotaur registers a ''modrinth'' task for you. Configuration is done through the ''modrinth {...}'' block.
  
 Here is a basic example. Here is a basic example.
  
-<code java> +<code groovy> 
-import com.modrinth.minotaur.TaskModrinthUpload+import com.modrinth.minotaur.dependencies.ModDependency
  
-task publishModrinth (type: TaskModrinthUpload){ +modrinth { 
- +    token = 'mySecretToken' // Please use an environment variable for this! The default is `$MODRINTH_TOKEN`. 
-    token = 'mySecretToken' // Use an environment property if releasing your source code on github! +    projectId = 'AABBCCDD' // The ID of your Modrinth project. Slugs will not work. 
-    projectId = 'modrinthModID' // The ID of your modrinth project, slugs will not work. +    versionNumber = '1.0.0' // The (preferably SemVer) version of the mod. If not specified, it'll use the `version` declaration 
-    versionNumber = '1.0.0' // The version of the mod to upload. +    versionName = 'My awesome release' // The version title. If not specified, it'll use the version number 
-    uploadFile = remapJar // This links to a task that builds your mod jar and sets "uploadFile" to the mod jar. +    uploadFile = remapJar // Tells Minotaur to use the remapped jar 
-    addGameVersion('1.16.2') // Any minecraft version. +    gameVersions = ['1.18', '1.18.1', '1.18.2'] // An array of game versions the version supports 
-    addLoader('fabric') // Can be fabric or forge. Modrinth will support liteloader and rift at a later date.+    loaders = ['fabric'] // Self-explanatory. 
 +    dependencies = [ 
 +            new ModDependency('P7dR8mSH', 'required') // Creates a new required dependency on Fabric API 
 +    ]
 } }
 </code> </code>
  
-Get your modrinth [[https://modrinth.com/dashboard/settings|token from here.]] You can use this token to access the Modrinth API and alongside Minotaur+Get your Modrinth [[https://modrinth.com/dashboard/settings|token from here.]] You can use this token to access the Modrinth API alongside Minotaur.
  
-Now when you run ''gradle publishModrinth'' you should see that your mod has been compiled and uploaded to modrinth, like so:+Now, when you run ''gradle modrinth'', you should see that your mod has been compiled and uploaded to Modrinth, like so:
  
 {{https://iili.io/KYUDq7.png}} {{https://iili.io/KYUDq7.png}}
  
-However, this can be limiting and sometimes repetitive to upload, you would need to edit the values every time you want to release a version.+However, this can be limiting and sometimes repetitive to upload, as you would need to edit the values every time you want to release a version.
 This is where Java ''stout'' and ''stin'' come in. This is where Java ''stout'' and ''stin'' come in.
  
-===== Advanced =====+===== Dynamic Implementation =====
  
-So, you have a basic implementation. Lets make it dynamic, allowing you to input values through the command line when the task is ran.+So, you have a basic implementation. Let's make it dynamic, allowing you to input values through the command line when the task is ran. Typically this is not done for Gradle tasks, and an environment variable or similar static source can be used for these values, but the tutorial is kept for posterity:
  
-First of all, we would need to create a ''BufferedReader''. Why a ''BufferedReader'' instead of ''System.out.readLine()''? ''System.out.readLine()'' only works on command terminals, and doesn't work on normal IDE terminals such as Eclipse, IntelliJ Idea and Visual Studio Code. Since gradle tasks are most commonly ran in the IDE, it would be better to use BufferedReader as it supports in-IDE terminals.+First of all, we would need to create a ''BufferedReader''. Why a ''BufferedReader'' instead of ''System.out.readLine()''? ''System.out.readLine()'' only works on command terminals, and doesn't work on normal IDE terminals such as Eclipse, IntelliJ Idea and Visual Studio Code. Since Gradle tasks are most commonly ran in the IDE, it would be better to use ''BufferedReader'' as it supports in-IDE terminals.
  
-Add a new ''BufferedReader'' collecting a buffer from ''System.in'' to the top of your modrinth task.+Add a new ''BufferedReader'' collecting a buffer from ''System.in'' to the top of your Modrinth task.
 <code Java> <code Java>
 BufferedReader br = new BufferedReader(new InputStreamReader(System.in)); BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
 </code> </code>
  
-Now, you can collect user input by simply calling the method: ''br.readLine()''+Now you can collect user input by simply calling the method: ''br.readLine()''.
  
-Lets add this to our task shall we? We'll also add some more data, such as a markdown changelog and make the version name different from the sematic versioning number. +Let's add this to our task, shall we? We'll also add some more data, such as a Markdown changelog and make the version name different from the semantic versioning number.
- +
-<code Java> +
-import com.modrinth.minotaur.TaskModrinthUpload +
- +
-task publishModrinth (type: TaskModrinthUpload){+
  
 +<code groovy>
 +modrinth {
     BufferedReader br = new BufferedReader(new InputStreamReader(System.in));     BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
-    System.out.println("Enter a Github Access Token: "); +    System.out.println("Enter a Modrinth token: "); 
-    token = br.readLine(); // Get the GitHub Access Token you got from the basics part of this tutorial. +    token = br.readLine(); // Enter the token you got from the basics part of this tutorial. 
-    projectId = '' // Enter your modrinth mod ID here.+    projectId = "" // Enter your Modrinth project ID here.
     System.out.println("Enter the version number:");     System.out.println("Enter the version number:");
     versionNumber = br.readLine();     versionNumber = br.readLine();
     System.out.println("Enter the version name:");     System.out.println("Enter the version name:");
     versionName = br.readLine();     versionName = br.readLine();
-    uploadFile = remapJar // This links to a task that builds your mod jar and sets "uploadFile" to the mod jar.+    uploadFile = remapJar
     System.out.println("Enter the game version number: (See minotaur docs for valids)");     System.out.println("Enter the game version number: (See minotaur docs for valids)");
-    addGameVersion(br.readLine());+    gameVersions = [br.readLine()];
     System.out.println("Enter changelog:");     System.out.println("Enter changelog:");
     changelog = br.readLine();     changelog = br.readLine();
-    addLoader('fabric') +    loaders = ["fabric"]
 } }
 </code> </code>
  
-Now, when ''gradle publishModrinth'' is ran, it asks you for some sweet user input. Hell you could even go as far as using Swing or JavaFX to make a GUI!+Now, when ''gradle modrinth'' is ran, it asks you for some sweet user input. Hell, you could even go as far as using Swing or JavaFX to make a GUI!
  
-Minotaur is great alongside cursegradle. You can merge both of the tasks together. Calling your cursegradle task after the modrinth one is complete:+Minotaur is great alongside CurseGradle. You can merge both of the tasks together. Creating a new task to run both Minotaur and CurseGradle publishing tasks in one:
  
-<code java> +<code groovy> 
-task publishModrinth (type: TaskModrinthUpload){ +task publishToModSites { 
-    // ... Modrinth Upload Stuff +    publishToModSites.dependsOn modrinth 
-    curseforge<id> // Begin the cursegradle task. Replacing ID with the id you set on the cursegradle config.+    publishToModSites.dependsOn curseforge
 } }
 </code> </code>
  
 +===== Updating from Minotaur 1.x to 2.x =====
 +
 +Minotaur 2.x introduced a few breaking changes to how your buildscript is formatted.
 +
 +First, instead of registering your own ''publishModrinth'' task, Minotaur now automatically creates a ''modrinth'' task. As such, you can replace the ''task publishModrinth(type: TaskModrinthUpload) {'' line with just ''modrinth {''.
  
 +To declare supported Minecraft versions and mod loaders, the ''gameVersions'' and ''loaders'' arrays must now be used. The syntax for these are pretty self-explanatory.
  
 +Instead of using ''releaseType'', you must now use ''versionType''. This was actually changed in v1.2.0, but very few buildscripts have moved on from v1.1.0.
  
 +Finally, dependencies are also an array which take ''ModDependency'' and/or ''VersionDependency'' (might need to be imported from ''com.modrinth.minotaur.dependencies'' package). The first parameter is the project or version ID as a string, and the second parameter is the dependency type: one of ''required'', ''optional'', or ''unsupported''.
tutorial/minotaur.1609092788.txt.gz · Last modified: 2020/12/27 18:13 by calum6541