NotAShelf/pakker
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: clean up project README

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I4033cccdf099208243e47ffd00b7e2416a6a6964
This commit is contained in:
raf 2026-05-01 23:43:21 +03:00
commit 614d76fd74
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
1 changed files with 32 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

41
docs/README.md
View file

@ -1,16 +1,39 @@
# Pakker
A fast, reliable multiplatform modpack manager for Minecraft, written in Rust.
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.
## Overview
## Core Features
Pakker is a command-line tool for managing Minecraft modpacks across multiple
platforms including CurseForge, Modrinth, and GitHub. It provides a streamlined
workflow for creating, maintaining, and distributing modpacks with support for
automated dependency resolution, version management, and multi-platform exports.
- 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
Pakker is _greatly_ inspired by [Pakku](https://github.com/juraj-hrivnak/Pakku),
bringing similar functionality with improved performance and additional features
through Rust implementation.
[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.