MMPM Custom Packages

Overview

Custom Packages in MMPM allow adding private or public packages not listed in the MagicMirror 3rd Party Wiki. You can install these packages using standard MMPM installation methods after adding them to your database.

Required Information

To create a Custom Package, provide its title, author, repository, and description. This can be done through the CLI with mmpm mm-pkg add or in the GUI under the "Custom Packages" menu.

Adding Custom Packages

Interactive Mode

mmpm mm-pkg add

Single Command Entry

mmpm mm-pkg add \
  -t "my-module" \
  -a "my-author" \
  -r "https://github.com/my-author/my-module" \
  -d "my-description"

You can add private repositories and specific branches. Note the --repo (or -r) argument.

mmpm mm-pkg add \
  --title "my-module" \
  --author "my-author" \
  --repo "https://github.com/my-author/my-module -b develop" \
  --desc "my-description"

Installing Custom Packages

Now that you've added a Custom Package to your local database, install it as you normally would:

mmpm install -y my-module

Removing Custom Packages

Uninstall it like you would any other MagicMirror Package:

mmpm remove -y my-module

Then remove it from the database:

mmpm mm-pkg remove my-module