summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorseth <[email protected]>2023-05-12 06:31:55 -0400
committerseth <[email protected]>2023-05-12 06:31:55 -0400
commit1c9c0ef2e40fbd1a921b446d8fe5884e645e4308 (patch)
treeb9cbd07b2ddc1a61192db574b620bc7cdf3648e0 /README.md
parent6c816508fbfc876cf1cc389eb8bb800553a8e2f9 (diff)
docs: clarify files required for mkMultiMCPackHEADmain
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index c440d3b..c8b1ed4 100644
--- a/README.md
+++ b/README.md
@@ -98,8 +98,10 @@ Prism Launcher and MultiMC can import. For example:
in rec {
myModpack = mkMultiMCPack {
inherit pkgs mods;
- # optionally include external
- # files in modpack
+ # optionally include externa. files in modpack.
+ # instance related files should be placed here,
+ # as made in step 1 and 3 of this guide:
+ # https://packwiz.infra.link/tutorials/installing/packwiz-installer/#creating-a-multimc-instance-for-your-modpack
filesDir = ./files;
name = "myModpack";
};
@@ -116,7 +118,7 @@ There are two main things you should keep in mind with this project currently:
- No Curseforge support
- Packwiz does not keep the download URL for Curseforge mods in it's TOML files
- due to Curseforge's ToS, which is not acceptable in the current method used to
+ due to Curseforge's ToS, which is not acceptable in the current method used to
generate checksums and create the final derivations for mods.
- This is the biggest concern as it affects end users the most
@@ -125,7 +127,6 @@ There are two main things you should keep in mind with this project currently:
- Packwiz uses SHA1 by default to verify mod files, which fetchers in nix such as `builtins.fetchurl`
and `pkgs.fetchurl` do not support. This prevents us from using them, and requires a separate
checksum file (using SHA256) to be generated and updated along with the modpack.
-
- There are [plans](https://github.com/packwiz/packwiz/issues/156) to change this in the future,
which would allow for this process to be removed