project-lag/README.md

## Update Pack Template
This is a template modpack makers can use to easily release their modpack onto multiple platforms.
currently this template only supports 
- Windows
	- Technic
	- MultiMC

### How to use this?
- Modpack Makers
	- Well first your going to need to install `busybox`, `git`, `go` `7zip`, and `make` on your computer, I personally reccomend getting all of these through [Scoop](https://scoop.sh/)
	- After installing scoop, just run
		- `scoop install busybox git go make 7zip`
		- after you run the previous command, run
			- `go install github.com/packwiz/packwiz@latest`
		- and everything should be there, 
	- I reccomend using VSCode to manage your modpack as you have a full visual editor and git manager built in.
	- to add mods, run `packwiz <curseforge or modrinth> install <modid>`
		- for sodium from modrinth, `packwiz modrinth install sodium`
	- to make a release, run `make multimc` or `make technic`

	- Dont forget to make a git repo for your modpack, I reccomend using [GitLab](https://gitlab.com) due to its free Large File Support.

	- There are a few files you will need to edit as a maintainer to properly use this tool, 
		- `.gitignore`
			- Your modpack will create files that can and most likely will create issues with the updater, input the filepaths you wish for the updater to ignore, (usually files/folders that do not need to be bundled as they will be automatically created)
		- `.minecraft/icon.png`
			- This is your Modpack Icon, please change it, you may alter this one if you do not have one made specifically for you, the image is a 32x32 pixel image scaled up to 1024x1024
			- Also change the file name for it
		- `instance.cfg`
			- iconKey=icon, change this to whatever you named your modpack icon (excluding file extension)
			- name=Example Modpack, change this to your modpack name
		- `Makefile`
			- Edit this so that you can name your release zips how you want them to


	- I highly suggest using this mod or simular to push custom configs as players may make changes to their settings which *will* break the updater
		- https://www.curseforge.com/minecraft/mc-mods/yosbr

- Modpack Users
	- MultiMC
		- Add this into your instance settings if not already there
		- `$INST_DIR/update-pack.exe`
		- ![](https://i.imgur.com/wjBuHYG.png)
	- Technic
		- Nothing, your modpack maintainer will use this tool to make new technic releases automatically
Initial commit 2021-08-29 21:03:21 +01:00			`## Update Pack Template`
			`This is a template modpack makers can use to easily release their modpack onto multiple platforms.`
			`currently this template only supports`
			`- Windows`
			`- Technic`
			`- MultiMC`

			`### How to use this?`
			`- Modpack Makers`
Move to Packwiz 2022-02-25 19:07:26 +00:00			- Well first your going to need to install `busybox`, `git`, `go` `7zip`, and `make` on your computer, I personally reccomend getting all of these through [Scoop](https://scoop.sh/)
Initial commit 2021-08-29 21:03:21 +01:00			`- After installing scoop, just run`
Move to Packwiz 2022-02-25 19:07:26 +00:00			- `scoop install busybox git go make 7zip`
			`- after you run the previous command, run`
			- `go install github.com/packwiz/packwiz@latest`
Initial commit 2021-08-29 21:03:21 +01:00			`- and everything should be there,`
			`- I reccomend using VSCode to manage your modpack as you have a full visual editor and git manager built in.`
Move to Packwiz 2022-02-25 19:07:26 +00:00			- to add mods, run `packwiz <curseforge or modrinth> install <modid>`
			- for sodium from modrinth, `packwiz modrinth install sodium`
			- to make a release, run `make multimc` or `make technic`
Initial commit 2021-08-29 21:03:21 +01:00
			`- Dont forget to make a git repo for your modpack, I reccomend using [GitLab](https://gitlab.com) due to its free Large File Support.`

			`- There are a few files you will need to edit as a maintainer to properly use this tool,`
			- `.gitignore`
			`- Your modpack will create files that can and most likely will create issues with the updater, input the filepaths you wish for the updater to ignore, (usually files/folders that do not need to be bundled as they will be automatically created)`
			- `.minecraft/icon.png`
			`- This is your Modpack Icon, please change it, you may alter this one if you do not have one made specifically for you, the image is a 32x32 pixel image scaled up to 1024x1024`
Base Content 2021-08-29 21:46:40 +01:00			`- Also change the file name for it`
			- `instance.cfg`
			`- iconKey=icon, change this to whatever you named your modpack icon (excluding file extension)`
			`- name=Example Modpack, change this to your modpack name`
			- `Makefile`
			`- Edit this so that you can name your release zips how you want them to`

Initial commit 2021-08-29 21:03:21 +01:00
			`- I highly suggest using this mod or simular to push custom configs as players may make changes to their settings which will break the updater`
			`- https://www.curseforge.com/minecraft/mc-mods/yosbr`

			`- Modpack Users`
			`- MultiMC`
Base Content 2021-08-29 21:46:40 +01:00			`- Add this into your instance settings if not already there`
Initial commit 2021-08-29 21:03:21 +01:00			- `$INST_DIR/update-pack.exe`
			`- ![](https://i.imgur.com/wjBuHYG.png)`
			`- Technic`
			`- Nothing, your modpack maintainer will use this tool to make new technic releases automatically`