fabulously-optimized/DEVELOPER-README.md

39 lines
2.6 KiB
Markdown
Raw Permalink Normal View History

2021-06-24 12:53:27 +00:00
# Fabulously Optimized repository
Welcome to my repository.
Here you'll find the resources for:
2022-05-24 05:04:37 +00:00
* CurseForge modpack [(read more)](https://support.curseforge.com/en/support/solutions/articles/9000196904-creating-a-custom-profile)
2021-06-24 12:53:27 +00:00
* MultiMC modpack [(read more)](https://github.com/MultiMC/MultiMC5/wiki/Instance-settings)
* MultiMC modpack with packwiz [(read more)](https://github.com/comp500/packwiz#packwiz-installer-for-pack-installation)
* Packwiz files [(read more)](https://github.com/comp500/packwiz#packwiz)
2021-09-19 12:52:21 +00:00
* Modrinth files [(read more)](https://github.com/Madis0/fabulously-optimized/issues/63)
2021-06-24 12:57:00 +00:00
* Changelog, license, readme, [cape](https://github.com/Madis0/fabulously-optimized/wiki/Free-cape)
2021-06-24 12:56:28 +00:00
* GitHub meta files in `.github` [(read more)](https://stackoverflow.com/a/61301254)
* GitHub page in `docs` [(read more)](https://pages.github.com/) - currently just a redirection to CF page
2021-06-24 12:53:27 +00:00
Other things to note:
2022-05-24 05:04:37 +00:00
* As seen in the `.gitignore` file, this repo will not include JAR files of any kind to respect the modders. If you want to build a pack based on this, get the JARs manually via any method you like (CurseForge Launcher, CurseForge website, Modrinth, packwiz, ...).
2022-03-05 08:05:14 +00:00
* Because there are no JARs, some folders would usually not be uploaded by Git at all, this is worked around using a `.gitkeep` file [(read more)](https://stackoverflow.com/a/7229996) to keep the folder structure.
* Since some folders are duplicated - such as config folders, I am using Windows-like soft symlinks [(read more)](https://blogs.windows.com/windowsdeveloper/2016/12/02/symlinks-windows-10/). Those don't work very well in GitHub, so I recommend using a [local Git client](https://desktop.github.com).
2022-04-23 21:24:08 +00:00
### Build process
Contact us in Discord if you have ideas on how to streamline this process while still testing the pack in the launchers.
2022-05-24 05:04:37 +00:00
1. Download the latest modpack version to CurseForge Launcher
2022-04-23 21:24:08 +00:00
2. Do changes, test
2022-08-22 13:17:33 +00:00
3. Update the version with `Version update.py`
4. Export to ZIP manually via CurseForge Launcher's option
5. Copy to MultiMC using `CurseForge to MultiMC-Git.py`
2022-04-23 21:24:08 +00:00
* If needed, change the Minecraft version in the script
2022-08-22 13:17:33 +00:00
6. Run it in MultiMC, test
7. Export to ZIP manually via MultiMC's option
8. Run `MultiMC to Git.py` to reflect manifest updates in Git and streamline MultiMC ZIP's manifest
9. Run `CurseForge to Packwiz-Modrinth.py`
2022-04-23 21:24:08 +00:00
* If needed, change the Minecraft version or variables in the script
2022-08-22 13:17:33 +00:00
10. Drag the exported CurseForge ZIP to the console window and hit enter - Packwiz changes will be made and Modrinth ZIP will be exported
11. Publish manually to GitHub, CurseForge, Modrinth
12. Announce on modpack's Discord, Fabric's Discord