Tutorial¶

This tutorial gives a introduction to mpkg. Please note that this tutorial describes the text console version of mpkg(At the moment there isn’t a GUI version).

Setup¶

The first step is to download mpkg from Bitbucket. Extract it somewhere and launch mpkg.exe init (respectively mono mpkg.exe init on Linux/Mac) within a terminal. This creates some files filled with the default settings. After that open mpkg.conf and verify the settings. Note down the value of mpkg-dir. This is where all mpkg files resides.

Repositories¶

After you installed mpkg, you probably want to add some repositories(They contain package files, that you can install). The official repositories are:

theunknownxy: https://bitbucket.org/theunknownxy/theunknown-mpkg/get/tip.zip

To add one, navigate to the mpkg-dir and open repos.conf. The file has the following format:

name=url
...

When you are done, save the file and go again to the terminal. Now you have to download or update the repositories which are in the repos.conf file. So run mpkg, but this time replace init with sync (e.g. mpkg.exe sync). After it’s done you can continue with searching and installing packages.

Packages¶

To search a package just run mpkg.exe search <QUERY>, where you replace <QUERY> with your search string. If mpkg has found something, a list of packages should appear:

$ mpkg.exe search ModLoader
- repo1/ModLoader
  A mod, kind ...
- ...

The theunknown/ part says in which repository the package was found. Then the package name follows. And below that, there is a short description of the package. So let’s install ModLoader(mostly you don’t need to do it manually. If a package requires it, mpkg automatically installs it and all other dependencies.) Add it with mpkg.exe add ModLoader. But it’s not yet installed. It’s just added to a list(You can view this list using mpkg.exe list). So now you need to run mpkg.exe build, which downloads and puts the mods in the right place. Then you can run Minecraft with the mods installed. If you want to get rid of a package you don’t want, remove it using mpkg.exe remove PACKAGE and rebuild Minecraft.

Profiles¶

TODO