pakker/docs/README.md
NotAShelf 614d76fd74
docs: clean up project README
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I4033cccdf099208243e47ffd00b7e2416a6a6964
2026-05-03 03:44:49 +03:00

39 lines
1.3 KiB
Markdown

# Pakker
Fast, reliable multiplatform modpack manager for Minecraft, written in Rust.
Pakker manages Minecraft modpacks across CurseForge, Modrinth, and GitHub. It
handles project resolution, dependency linking, lockfile updates, exports, and
remote modpack workflows from a single CLI.
## Core Features
- Create and import modpacks
- Add, remove, update, and inspect projects
- Resolve dependencies across supported platforms
- Manage pack configuration and per-project overrides
- Export CurseForge, Modrinth, and serverpack layouts
### New in Pakker
- Work with forked packs and remote repositories
- Interactively set and configure and test API credentials
## Quick Start
1. Run `pakker init` to create a new modpack.
2. Use `pakker add` or `pakker add-prj` to add projects.
3. Run `pakker export` when you want distributable output.
## Acknowledgments
[Pakku]: https://github.com/juraj-hrivnak/Pakku
Pakker is _greatly_ inspired by [Pakku], and commits to bringing similar
functionality with improved performance and additional features through a Rust
implementation. Pakku is by no means a bad project, but I found it difficult to
work with the Kotlin code.
[teksturepako]: https://github.com/juraj-hrivnak
Many thanks to [teksturepako] for Pakku, as well as his infinite patience, code
reviews and suggestions to bring Pakker to its current state.