This repository has been archived on 2023-11-26. You can view files and clone it, but cannot push or open issues or pull requests.
ModUpdater/README.md

67 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2020-06-24 02:04:22 +00:00
# ModUpdater
A simple Minecraft mod updater.
2020-06-24 20:01:56 +00:00
Created For [ModFest 1.16](https://modfest.net/1.16)
2020-06-24 14:02:31 +00:00
**NOTE:** This is only able to scan mods that have opted-in!
2020-06-24 02:04:22 +00:00
## Mod Users
Go to the Mod Menu and click the configure icon for ModUpdater.
## Mod Developers
Place this in your ``fabric.mod.json``:
**Maven**
```json
{
"custom": {
"modupdater": {
"strategy": "maven",
"repository": "https://maven.fabricmc.net",
"group": "net.fabricmc.fabric-api",
"artifact": "fabric-api"
}
}
}
```
**CurseForge**
```json
{
"custom": {
"modupdater": {
"strategy": "curseforge",
"projectID": 306612
}
}
}
```
2020-06-24 18:21:26 +00:00
**GitHub Releases**
```json
{
"custom": {
"modupdater": {
"strategy": "github",
"owner": "Repository Owner",
"repository": "Repository Name"
}
}
}
```
2020-06-24 02:18:36 +00:00
Also replace this in ````build.gradle````:
```gradle
version = project.mod_version
```
with:
```gradle
version = "${project.mod_version}+${project.minecraft_version}"
```
2020-06-24 02:04:22 +00:00
## Changelog
2020-06-24 02:18:36 +00:00
[View Changelog](CHANGELOG.md)
## Credits
2020-06-24 18:21:26 +00:00
- The icon was created by ``ProspectorDev``
- The GitHub Releases strategy was written by ``AppleTheGolden``