Skip to content

Commit 6353d47

Browse files
PyrofabPyrofab
committed
Update Chenille documentation again
1 parent 91fa795 commit 6353d47

File tree

1 file changed

+47
-17
lines changed

1 file changed

+47
-17
lines changed

‎public/wiki/chenille.md

+47-17
Original file line numberDiff line numberDiff line change
@@ -54,35 +54,57 @@ If left unspecified, it will default to `remapJar.archiveFile`.
5454

5555
[Modrinth](https://modrinth.com) \[`withModrinthRelease`] publishing requires the `modrinth_api_key` user-level property and the following project-level properties:
5656

57-
| name | required? | description |
58-
|--------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------|
59-
| `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 |
57+
| name | required? | description |
58+
|---------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------|
59+
| `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+
| `modrinth_versions` | required\* | the semicolon-separated list of game versions supported by your mod |
61+
| `release_type` | required | `alpha`, `beta`, or `release` |
62+
| `mr_requirements` | optional | the semicolon-separated list of Modrinth projects required by your mod |
63+
| `mr_optionals` | optional | the semicolon-separated list of Modrinth projects with which your mod has optional compatibility features |
64+
| `mr_embeddeds` | optional | the semicolon-separated list of Modrinth projects that are embedded (Jar-in-Jar'ed) in your mod |
65+
| `mr_incompatibles` | optional | the semicolon-separated list of Modrinth projects that are incompatible with your mod |
66+
67+
\*If `modrinth_versions` if left unspecified, it will fall back to checking `curseforge_versions` and then `minecraft_version`.
68+
However these properties may not actually match Modrinth's version scheme, so you are strongly encouraged to set `modrinth_versions` directly.
6569

6670
The loader setting will be set to `fabric` **and** `quilt` if `fabric-loom` is applied, otherwise it will be set to just `quilt`.
6771

72+
You can further customize the Modrinth publication by using the `modrinth` extension provided by the
73+
[minotaur plugin](https://github.com/modrinth/minotaur), which is automatically applied when you use `withModrinthRelease`:
74+
```groovy
75+
chenille {
76+
configurePublishing {
77+
mainArtifact = remapStandaloneJar.archiveFile
78+
withModrinthRelease()
79+
}
80+
}
81+
82+
modrinth {
83+
// advanced configuration
84+
}
85+
```
86+
6887
#### Curseforge
6988

7089
[Curseforge](https://curseforge.com/) \[`withCurseforgeRelease`] publishing requires the `curseforge_api_key` user-level property and the following project-level properties:
7190

72-
| name | required? | description |
73-
|--------------------|-----------|-------------------------------------------------------------------------------------------------------------|
74-
| `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 |
91+
| name | required? | description |
92+
|-----------------------|-----------|-------------------------------------------------------------------------------------------------------------|
93+
| `curseforge_id` | required | the ID of the project on Curseforge |
94+
| `curseforge_versions` | required | the semicolon-separated list of game versions supported by your mod |
95+
| `release_type` | required | `alpha`, `beta`, or `release` |
96+
| `cf_requirements` | optional | the semicolon-separated list of Curseforge projects required by your mod |
97+
| `cf_optionals` | optional | the semicolon-separated list of Curseforge projects with which your mod has optional compatibility features |
98+
| `cf_embeddeds` | optional | the semicolon-separated list of Curseforge projects that are embedded (Jar-in-Jar'ed) in your mod |
99+
| `cf_incompatibles` | optional | the semicolon-separated list of Curseforge projects that are incompatible with your mod |
80100

81101
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`.
82102

83103
#### GitHub
84104

85105
[GitHub](https://github.com) \[`withGithubRelease`] publishing requires the `github_api_key` user-level property.
106+
You can further customize the GitHub release by using the `githubRelease` extension provided by the
107+
[github-release plugin](https://github.com/BreadMoirai/github-release-gradle-plugin/wiki), which is automatically applied when you use `withGithubRelease`.
86108

87109
#### Ladysnake Maven
88110

@@ -108,7 +130,8 @@ Setting up at least one publication method with Chenille will trigger the creati
108130
#### Changelog
109131

110132
Chenille configures your automated github, curseforge, and modrinth releases to use
111-
a changelog file from your project repository (defaulting to `/changelog.md`). The expected format is as follows :
133+
a changelog file from your project repository (defaulting to `/changelog.md`).
134+
The expected format is as follows :
112135
```md
113136
------------------------------------------------------
114137
Version x.y.2
@@ -122,6 +145,13 @@ Changelog for version x y 1
122145

123146
```
124147

148+
The generated changelog for each version contains a link to the full changelog.
149+
You can customize that link by setting `changelogUrl`.
150+
By default, it guesses the link to the GitHub file as follows:
151+
```groovy
152+
"https://github.com/$owners/$displayName/blob/$modVersion/changelog.md"
153+
```
154+
125155
### Default Repositories
126156
Chenille lets you quickly add some common repositories to your project
127157
by calling the following methods in a `chenille.repositories` block :

0 commit comments

Comments
 (0)