Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve: add show-repo, upload, upgrade all #151

Merged
merged 14 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
## A package repository for [Mudlet](https://www.mudlet.org) ##
## A Package Repository for [Mudlet](https://www.mudlet.org) ##

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](https://www.mudlet.org) which helps you install, remove, search the repository and update packages from the Mudlet command line.
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](https://www.mudlet.org) which helps you install, remove, search and update packages from the Mudlet command line.

### Installation ###

To get started, install the `mpkg` client in Mudlet by issuing;
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://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 install -- install/upgrade a package
mpkg list -- list all installed packages
mpkg remove -- remove an existing package
mpkg search -- search for a package via name and description
mpkg search -- search for a package
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
mpkg update -- update package listing from repository
```

### Submit a Package ###

Have you created a package you wish to share? There are currently two methods to get your package added to this repository.
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 ####

Expand All @@ -34,11 +36,8 @@ Contribute your mpackage using Github's "[fork and pull request](https://docs.gi
- 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 The Repository Maintainer ####

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](https://discordapp.com/invite/kuYvMQ9) and he will assist in getting your package submitted.

### Development ###

Using Docker, run `./mpkg/muddle` or run Muddler [manually](https://github.com/demonnic/muddler/wiki/Installation) to generate the new `./mpkg/build/mpkg.mpackage` file can be loaded into Mudlet as a module.

### Report Issues ###
Expand Down
5 changes: 1 addition & 4 deletions mpkg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,14 @@ mpkg is a command line interface for managing packages used in Mudlet. You can i

```
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 upgrade -- upgrade a specific package
mpkg upgradeable -- show packages that can be upgraded
mpkg debug -- turn on debugging messages
```
### See Also

* https://packages.mudlet.org
* https://mudlet.github.io/mudlet-package-repository/
6 changes: 3 additions & 3 deletions mpkg/mfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
"package": "mpkg",
"title": "A command line package manager for Mudlet.",
"description": "",
"version": "2.8",
"author": "Zooka",
"icon": "inventory-management.png",
"version": "3.0",
"author": "Mudlet Default Package",
"icon": "mudlet-package-repo.ico",
"dependencies": "",
"outputFile": false
}
Binary file not shown.
Binary file not shown.
Loading