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 the repository and update packages from the Mudlet command line.
To get started, install the mpkg
client in Mudlet by issuing;
lua installPackage("https://mudlet.github.io/mudlet-package-repository/packages/mpkg.mpackage")
Then on the command line you can issue any of the following commands.
Commands:
mpkg help -- show this help
mpkg install -- install a new package
mpkg list -- list all installed packages
mpkg remove -- remove an existing package
mpkg search -- search for a package via name and description
mpkg show -- show detailed information about a package
mpkg update -- update your package listing
mpkg upgradeable -- show packages that can be upgraded
mpkg debug -- turn on debugging messages
Have you created a package you wish to share? There are currently two methods to get your package added to this repository.
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.
If you are having trouble submitting via Github, or do not yet have an account (and we really suggest you do to help support Mudlet!), you can contact Zooka on Mudlet's Discord server and he will assist in getting your package submitted.
Report any issues here or find us on Mudlet's Discord server.