README.md

   1 # JFDI-CMPDL: Just F---ing Do It - Curse Modpack Downloader
   2
   3 Because CurseForge is bad.
   4
   5 ## What it does
   6
   7 Download Minecraft modpacks from CurseForge.
   8
   9 ## How to use it
  10
  11 `$ python jfdicmpdl.py path/to/zip/file`
  12
  13 ## Why?
  14
  15 CurseForge changed their API, making it difficult for third-party launchers
  16 to download modpacks. This project downloads an entire modpack into a folder
  17 that you can import into the launcher of your choice: Be it MultiMC, PolyMC,
  18 or even the vanilla Minecraft launcher.
  19
  20 This fork has removed all references to the CurseForge API, and instead uses
  21 the publicly available modpacks.ch API. This means that no API key is required
  22 for usage. The next section gives more details about the original project that
  23 this project is forked from.
  24
  25 ## Fork
  26
  27 This is a fork of [modpack-installer]. This means this project is based on
  28 modpack-installer. It doesn't mean that this project is associated with the
  29 original authors and it also doesn't mean that it's endorsed by them. Please
  30 do not contact the original authors about problems with this very project,
  31 instead contact the fork authors. Thank you.
  32
  33 [modpack-installer]: https://github.com/cdbbnnyCode/modpack-installer
  34
  35 However, the authors of JFDI-CMPDL would like to take this opportunity to
  36 express their gratitude for the modpack-installer codebase.
  37
  38 ## Downloading
  39
  40 This fork is available on [GitHub], [BitBucket], [GitLab], [CodeBerg], [SourceHut],
  41 [NotABug] and [GitGud].
  42
  43 [GitHub]: https://github.com/curseforgebad/jfdi-cmpdl
  44 [BitBucket]: https://bitbucket.org/curseforgebad/jfdi-cmpdl/src/main/
  45 [GitLab]: https://gitlab.com/curseforgebad/jfdi-cmpdl
  46 [CodeBerg]: https://codeberg.org/curseforgebad/jfdi-cmpdl
  47 [SourceHut]: https://git.sr.ht/~curseforgebad/jfdi-cmpdl
  48 [NotABug]: https://notabug.org/curseforgebad/jfdi-cmpdl
  49 [GitGud]: https://gitgud.io/curseforgebad/jfdi-cmpdl
  50
  51 ## License
  52
  53 This project is licensed under the MIT license. See the LICENSE file for
  54 details.