From 287f86fa82df4819eff120d9e00f858847779b51 Mon Sep 17 00:00:00 2001 From: Cassian Godsted Date: Tue, 12 Mar 2024 21:26:02 -0400 Subject: [PATCH 1/3] Add instructions on how to export to Modrinth --- docs/tutorials/hosting/modrinth.md | 11 +++++++++++ mkdocs-base.yml | 1 + 2 files changed, 12 insertions(+) create mode 100644 docs/tutorials/hosting/modrinth.md diff --git a/docs/tutorials/hosting/modrinth.md b/docs/tutorials/hosting/modrinth.md new file mode 100644 index 0000000..178ad16 --- /dev/null +++ b/docs/tutorials/hosting/modrinth.md @@ -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). + +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!) + +See [the corresponding reference page](../../reference/commands/packwiz/modrinth/export/index.md) for less information. \ No newline at end of file diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 12abd61..fa90c48 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -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: [] From 96153ddddf74b01caec0025109226781a1f0f466 Mon Sep 17 00:00:00 2001 From: Cassian Godsted Date: Sun, 21 Apr 2024 13:39:59 -0400 Subject: [PATCH 2/3] Better describe how Modrinth handles optional/sided mods --- docs/tutorials/hosting/modrinth.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tutorials/hosting/modrinth.md b/docs/tutorials/hosting/modrinth.md index 178ad16..1493c1a 100644 --- a/docs/tutorials/hosting/modrinth.md +++ b/docs/tutorials/hosting/modrinth.md @@ -2,10 +2,10 @@ 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). +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 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 [the 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). 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!) +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. See [the corresponding reference page](../../reference/commands/packwiz/modrinth/export/index.md) for less information. \ No newline at end of file From 34732fd66f3eea120c42268d5d8bd7c0f75a32b2 Mon Sep 17 00:00:00 2001 From: comp500 Date: Mon, 27 May 2024 18:56:52 +0100 Subject: [PATCH 3/3] Tweak grammar --- docs/tutorials/hosting/modrinth.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tutorials/hosting/modrinth.md b/docs/tutorials/hosting/modrinth.md index 1493c1a..bb2bebe 100644 --- a/docs/tutorials/hosting/modrinth.md +++ b/docs/tutorials/hosting/modrinth.md @@ -2,10 +2,10 @@ 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! -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 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 [the 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). +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). Be wary of including files that you don't want (the `packwiz` executable, and the modpack zip itself) in the pack! 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. -See [the corresponding reference page](../../reference/commands/packwiz/modrinth/export/index.md) for less information. \ No newline at end of file +See [the corresponding reference page](../../reference/commands/packwiz/modrinth/export/index.md) for less information.