A Package Repository for Mudlet
This Github repository hosts packages made for the Mudlet MUD client. It is also home to the development of mpkg, a command line interface for managing packages used in Mudlet which helps you install, remove, search and update packages from the Mudlet command line.
Installation
mpkg comes preinstalled on later (4.20+) versions of Mudlet. If you do not have it, consider upgrading or
issue this command on any profile you wish to use mpkg with.
lua installPackage("https://github.com/Mudlet/mudlet-package-repository/raw/refs/heads/main/packages/mpkg.mpackage")
Then on the command line you can issue any of the following commands.
Commands:
mpkg install -- install/upgrade a package
mpkg list -- list all installed packages
mpkg remove -- remove an existing package
mpkg search -- search for a package
mpkg show -- show detailed information about a package
mpkg update -- update package listing from repository
Submit a Package
Have you created a package you wish to share? There are two methods to get your package added to this repository.
via the Package Website
Visit the main package website (https://packages.mudlet.org) and follow the links to upload.
via Github Method
Contribute your mpackage using Github's "fork and pull request" method
- create a fork and clone the repository,
- copy your mpackage to the cloned repository subdirectory
packages/ (no further files need to be changed, Github workflows take care of rebuilding the repository index),
- commit, push and submit a pull request.
via Trusted Publishing (from your CI)
If your package is built by GitHub Actions, its workflow can publish new versions
by itself, with no token stored anywhere: it presents the short-lived OIDC token
GitHub mints for the run, and a maintainer-reviewed entry in
trusted-publishers.json says which workflow is allowed
to act for which package. The result is an ordinary pull request, reviewed as usual.
See TRUSTED-PUBLISHING.md to set it up.
Development
Using Docker, run ./mpkg/muddle or run Muddler manually to generate the new ./mpkg/build/mpkg.mpackage file can be loaded into Mudlet as a module.
New mpkg release
To make a new mpkg release, bump the version in mpkg/mfile and the rest will happen automatically.
Report Issues
Report any issues here or find us on Mudlet's Discord server.
