update readme

This commit is contained in:
josephsmendoza
2025-04-30 18:21:51 -07:00
parent 28babc0d5d
commit 8d81df404e
+7 -6
View File
@@ -4,11 +4,12 @@ It can also publish updates to Curseforge and/or Modrinth, provided a token and
## Usage
0. Clone/Fork/Download this template onto your pc
1. Enter the packwiz folder and edit the `pack.toml` or run `packwiz init -r`
2. Enter the prism folder and edit the `instance.cfg`, specifically the `name` and `PreLaunchCommand` variables
3. Replace or remove `modpack.png` and update or remove the `iconKey` in `instance.cfg` accordingly
4. Replace this `README.md` and the `LICENSE.md` files as appropriate for your modpack
5. Use `packwiz` to add mods to your pack in the `packwiz` folder
6. Commit and push to GitHub.
7. (optional) In your repo settings on GitHub, under the Pages environment, add the `MODRINTH_TOKEN` and `MODRINTH_ID` and/or `CURSEFORGE_TOKEN` and `CURSEFORGE_ID` to enable automated releases on the respective site.
2. Enter the `prism` folder and edit the `instance.cfg`, specifically the `name` and `PreLaunchCommand` variables
3. Create a new instance in Prism Launcher with your desired Minecraft and modloader versions, and copy the `mmc-pack.json` file from that instance into the `prism` folder
4. Replace or remove `modpack.png` and update or remove the `iconKey` in `instance.cfg` accordingly
5. Replace this `README.md` and the `LICENSE.md` files as appropriate for your modpack
6. Use `packwiz` to add mods to your pack in the `packwiz` folder
7. Commit and push to GitHub.
8. (optional) In your repo settings on GitHub, under the Pages environment, add the `MODRINTH_TOKEN` and `MODRINTH_ID` and/or `CURSEFORGE_TOKEN` and `CURSEFORGE_ID` to enable automated releases on the respective site.
Releases and release notes are automatically generated from your `pack.toml` and commit messages. To create a new release, simply increment the `version` value in `pack.toml`, commit, and push.