You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: public/wiki/chenille.md
+45-7
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,8 @@ Chenille applies the `quilt-loom` plugin to your project, unless `fabric-loom` w
34
34
Chenille can setup publishing to various platforms :
35
35
36
36
```gradle
37
+
version = ... // Must be set before chenille configuration
38
+
37
39
chenille {
38
40
configurePublishing {
39
41
mainArtifact = remapStandaloneJar.archiveFile
@@ -48,14 +50,50 @@ chenille {
48
50
The `mainArtifact` option determines the main jar to upload.
49
51
If left unspecified, it will default to `remapJar.archiveFile`.
50
52
51
-
-[Artifactory](https://jfrog.com/artifactory/)\[`withArtifactory`] publishing requires the `artifactory_user` and `artifactory_api_key` user-level gradle properties
52
-
- This method is now deprecated as Jfrog ended their free tier for Open Source projects
53
-
-[Curseforge](https://curseforge.com/)\[`withCurseforgeRelease`] publishing requires the `curseforge_api_key` user-level property and the `curseforge_id` project-level property
54
-
-[Github](https://github.com)\[`withGithubRelease`] publishing requires the `github_api_key` user-level property
55
-
-[Ladysnake Maven](https://maven.ladysnake.org)\[`withLadysnakeMaven`] publishing requires the `ladysnake_maven_username` and `ladysnake_maven_password` user-level property
56
-
-[Modrinth](https://modrinth.com)\[`withModrinthRelease`] publishing requires the `modrinth_api_key` user-level property and the `modrinth_id` project-level property
53
+
#### Modrinth
54
+
55
+
[Modrinth](https://modrinth.com)\[`withModrinthRelease`] publishing requires the `modrinth_api_key` user-level property and the following project-level properties:
|`modrinth_id`| required | the ID or slug of the project (the ID can be obtained in the modrinth interface by clicking the three dots in the upper right corner) |
60
+
|`release_type`| required |`alpha`, `beta`, or `release`|
61
+
|`mr_requirements`| optional | the semicolon-separated list of Modrinth projects required by your mod |
62
+
|`mr_optionals`| optional | the semicolon-separated list of Modrinth projects with which your mod has optional compatibility features |
63
+
|`mr_embeddeds`| optional | the semicolon-separated list of Modrinth projects that are embedded (Jar-in-Jar'ed) in your mod |
64
+
|`mr_incompatibles`| optional | the semicolon-separated list of Modrinth projects that are incompatible with your mod |
65
+
66
+
The loader setting will be set to `fabric`**and**`quilt` if `fabric-loom` is applied, otherwise it will be set to just `quilt`.
67
+
68
+
#### Curseforge
69
+
70
+
[Curseforge](https://curseforge.com/)\[`withCurseforgeRelease`] publishing requires the `curseforge_api_key` user-level property and the following project-level properties:
|`curseforge_id`| required | the ID of the project on Curseforge |
75
+
|`release_type`| required |`alpha`, `beta`, or `release`|
76
+
|`cf_requirements`| optional | the semicolon-separated list of Curseforge projects required by your mod |
77
+
|`cf_optionals`| optional | the semicolon-separated list of Curseforge projects with which your mod has optional compatibility features |
78
+
|`cf_embeddeds`| optional | the semicolon-separated list of Curseforge projects that are embedded (Jar-in-Jar'ed) in your mod |
79
+
|`cf_incompatibles`| optional | the semicolon-separated list of Curseforge projects that are incompatible with your mod |
80
+
81
+
Just like for Modrinth, the loader setting will be set to `fabric`**and**`quilt` if `fabric-loom` is applied, otherwise it will be set to just `quilt`.
82
+
83
+
#### GitHub
84
+
85
+
[GitHub](https://github.com)\[`withGithubRelease`] publishing requires the `github_api_key` user-level property.
86
+
87
+
#### Ladysnake Maven
88
+
89
+
[Ladysnake Maven](https://maven.ladysnake.org)\[`withLadysnakeMaven`] publishing requires the `ladysnake_maven_username` and `ladysnake_maven_password` user-level property.
90
+
91
+
#### Artifactory
92
+
93
+
[Artifactory](https://jfrog.com/artifactory/)\[`withArtifactory`] publishing requires the `artifactory_user` and `artifactory_api_key` user-level gradle properties.
94
+
This method is now deprecated as Jfrog ended their free tier for Open Source projects.
57
95
58
-
On Curseforge and Modrinth, the loader setting will be set to `fabric`**and**`quilt` if `fabric-loom` is applied, otherwise it will be set to just `quilt`.
96
+
#### The `release` task
59
97
60
98
Setting up at least one publication method with Chenille will trigger the creation of a `release` task, which will :
0 commit comments