mirrors/packwiz
1
0
Fork 0
mirror of https://github.com/packwiz/packwiz.git synced 2025-04-19 13:06:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add more information to README.md

Browse Source
This commit is contained in:
comp500 2021-12-27 01:33:31 +00:00
parent 00e647fb4b
commit 2d9913cb81
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,5 +1,17 @@
# packwiz
A command-line tool for creating Minecraft modpacks. Join my Discord server if you need help [here](https://discord.gg/Csh8zbbhCt)!
packwiz is a command line tool for creating Minecraft modpacks. Instead of managing JAR files directly, packwiz creates TOML metadata files which can be easily version-controlled and shared with git (see an example pack [here](https://github.com/packwiz/packwiz-example-pack)). You can then [export it to a CurseForge modpack](tutorials/hosting/curseforge.md), or [use packwiz-installer](tutorials/installing/packwiz-installer.md) for an auto-updating MultiMC instance.
packwiz is great for...
- Distributing private modpacks for servers
- Creating modpacks for CurseForge (and soon Modrinth)
packwiz is not so great for...
- Managing downloaded mod files (use [Curse/GDLauncher or another CLI](https://gist.github.com/comp500/13ae6f058221196077fb19953ac608c7))
- People who want a GUI (though there are some [third-party efforts](https://github.com/ExoPlant/packwiz-gui))
Join my Discord server if you need help [here](https://discord.gg/Csh8zbbhCt)!
## Features
- Git-friendly TOML-based metadata format