Skip to content

Commit 5d45a76

Browse files
cassiancccomp500
andauthored
Add instructions on how to export to Modrinth (#48)
* Add instructions on how to export to Modrinth * Better describe how Modrinth handles optional/sided mods * Tweak grammar --------- Co-authored-by: comp500 <comp500@users.noreply.github.com>
1 parent 09793ac commit 5d45a76

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/tutorials/hosting/modrinth.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Publishing to Modrinth
2+
3+
Exporting a Modrinth pack is as simple as running `packwiz modrinth export` - this gives you a `.mrpack` in your pack folder that you can upload to Modrinth!
4+
5+
Unlike CurseForge, this pack format does support side-only mods. When exporting, packwiz will export a pack with side information provided from Modrinth or as specified in the mod's `mod.pw.toml` file. The official Modrinth launcher will automatically filter out serverside mods, and the pack can be used on the server using tools like [mrpack-install](https://support.modrinth.com/en/articles/8802250-modpacks-on-modrinth) or [packwiz-installer](../../tutorials/installing/packwiz-installer.md). Mods without the necessary Modrinth metadata (such as those installed from CurseForge) will be placed as JARs into the modpack zip; make sure that you have the licenses for these mods [as it is your responsibility as a pack creator to](https://support.modrinth.com/en/articles/8797527-obtaining-modpack-permissions).
6+
7+
Be wary of including files that you don't want (the `packwiz` executable, and the modpack zip itself) in the pack!
8+
9+
Keep in mind that since the official Modrinth app doesn't support optional mods, the user won't be prompted for optional mods. The official launcher will automatically install all optional mods (even if they default to being disabled!). If you'd like to be able to use optional mods, you use Prism Launcher's "Import Instance" section to install the exported .mrpack file. Note that if you use Prism Launcher's "Modrinth" section to install the pack, you will not be prompted for optional mods.
10+
11+
See [the corresponding reference page](../../reference/commands/packwiz/modrinth/export/index.md) for less information. <!-- TODO: add documentation to CLI itself!! -->

mkdocs-base.yml

+1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ nav:
4444
- Installing/distributing a modpack:
4545
- Installing with packwiz-installer: tutorials/installing/packwiz-installer.md
4646
- Publishing to CurseForge: tutorials/hosting/curseforge.md
47+
- Publishing to Modrinth: tutorials/hosting/modrinth.md
4748
# TODO: See below; documentation on how to distribute packwiz packs on several platforms
4849
# - Hosting with HTTP:
4950
# - Your own HTTP server: []

0 commit comments

Comments
 (0)