README
¶
MCPM - Minecraft Package Manager
MCPM is a package manager AND A LIBRARY, that lets you manage mods, modpacks, world saves and resource packs. It's all written in Go. You can use this as a server command-line tool or create whole new tool using MCPM as a library.
The idea of MCPM is creating easy and fully automated management of Minecraft resources. It is dedicated to both servers and clients.
This project is still missing its target features. You can contribute by giving new ideas or bugs at Issues page or developing the source code.
How does this work?
MCPM gets information of all Minecraft-related stuff available from Curse CDN server. So everything downloadable on Curse is also available in MCPM.
Package names come from their specific curse.com URL. For example: /mc-mods/minecraft/tinkers-construct
Why Go? / Why not Java?
The answer is simple. This is not a Minecraft mod, launcher nor a development library. Also Go is simple and easy to understand language.
Installation
Check Releases for downloads
To get the latest build, get Go and type this command:
go get github.com/Szewek/mcpm
If you have it compiled, make sure you have set GOPATH/bin in PATH environment variable.
Modes
Modes are commands available in MCPM. They can be used as plugins for your own tool. To run a mode, type this following command:
mcpm <modename>
Modes examples
| Command | Description |
|---|---|
mcpm get tinkers-construct |
Downloads the newest version of Tinkers' Construct and puts in "mods" folder where this command was executed |
mcpm search Tinkers |
Searches database for packages containing word "Tinkers" in package name, title and description |
mcpm update |
Updates database |
mcpm info xyz |
Displays information about package "xyz" |
TO DO (for contributors)
- Caching database
- Getting package by unique name
- Getting package for appropriate version of Minecraft
- Unpacking modpacks and world saves
- Creating server and client instances
- Managing server from through HTTP
- Getting mods' source code
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package database helps maintaining Minecraft resources available at Curse CDN
|
Package database helps maintaining Minecraft resources available at Curse CDN |
|
Package helper contains helpful objects and methods to gather Minecraft resources' information
|
Package helper contains helpful objects and methods to gather Minecraft resources' information |
|
Package modes contains all subcommands (called "modes").
|
Package modes contains all subcommands (called "modes"). |
|
Package util contains varoius utilities used by MCPM
|
Package util contains varoius utilities used by MCPM |
|
Package websrv contains MCPM web server
|
Package websrv contains MCPM web server |