summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorseth <[email protected]>2023-05-12 09:13:09 +0000
committerGitHub <[email protected]>2023-05-12 09:13:09 +0000
commitbbcfd89558df3b251b2b0341a441e20c35bb2743 (patch)
treee3a5bd3e28c0872e73c8d9556c4375022846c213 /README.md
parent41f8b06570d80ac6c20118272530bc7c0ed494cb (diff)
docs: clarify gotchas
thanks comp500 and imsofi :)
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index d586c7d..3410592 100644
--- a/README.md
+++ b/README.md
@@ -81,17 +81,19 @@ There are two main things you should keep in mind with this project currently:
- No Curseforge support
- - Packwiz does not keep the download URL to mods from Curseforge in it's TOML files,
- which is not acceptable in the current method used to generate checksums and create
- the final derivations for mods. This may be changed in the future
+ - 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
+ generate checksums and create the final derivations for mods.
- This is the biggest concern as it affects end users the most
- Checksums must be generated (**modpack developers, make sure you read this**)
- - Packwiz uses SHA1 to verify mod files, which fetchers in nix such as `builtins.fetchurl`
+ - 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. I don't see
- how this can be resolved in the foreseeable future unless SHA256 is adopted by Packwiz.
+ 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
## Related Projects