Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions on how to export to Modrinth #48

Merged
merged 4 commits into from
May 27, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/tutorials/hosting/modrinth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Publishing to Modrinth

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!

Since this pack format doesn't support side-only mods, packwiz can't create a pack that differs between server and client, and will export a pack for Minecraft clients (containing mods with side `client` or `both`). 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).
cassiancc marked this conversation as resolved.
Show resolved Hide resolved

Be wary of including files that you don't want (the `packwiz` executable, and the modpack zip itself) in the pack!

The Modrinth pack format doesn't really support optional mods. The user won't be prompted for optional mods, and unlike with CurseForge, they'll be included in the modpack file (even if they default to being disabled!)
cassiancc marked this conversation as resolved.
Show resolved Hide resolved

See [the corresponding reference page](../../reference/commands/packwiz/modrinth/export/index.md) for less information. <!-- TODO: add documentation to CLI itself!! -->
1 change: 1 addition & 0 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ nav:
- Installing/distributing a modpack:
- Installing with packwiz-installer: tutorials/installing/packwiz-installer.md
- Publishing to CurseForge: tutorials/hosting/curseforge.md
- Publishing to Modrinth: tutorials/hosting/modrinth.md
# TODO: See below; documentation on how to distribute packwiz packs on several platforms
# - Hosting with HTTP:
# - Your own HTTP server: []
Expand Down