Manual:Mudlet Packages - Revision history

Vadi: /* via the Mudlet Package Repository */

2025-01-24T14:00:37Z

via the Mudlet Package Repository

2024-12-28T11:05:41Z

What is a Mudlet Module?

2024-09-25T13:45:55Z

Self-hosting and Mudlet Package Repository

2024-09-25T13:40:07Z

rewrite to include screenshots, update old info, add mpkg

2024-08-22T14:28:45Z

Package optional details

2024-08-22T14:28:23Z

Package information

2024-05-09T05:39:52Z

Where to find Mudlet packages: wiki link

2024-02-11T07:20:52Z

as a one-liner: mention module CLI install path

2023-07-11T21:05:56Z

Revise removing dependencies.

2023-03-21T11:25:52Z

Create a Mudlet package by hand: clarify supported font extensions

@@ Line 9: / Line 9: @@
 == via the Mudlet Package Repository ==
-The [https://github.com/Mudlet/mudlet-package-repository Mudlet Package Repository] is a collection of packages submitted by game developers, players and Mudlet fans alike.  It is designed to be a central system for finding useful packages and scripts to enhance your gaming pleasure.  While there is a vast array of packages available here, some scripters choose not to submit their work in which case you can find them somewhere else, see below.
+The [https://packages.mudlet.org/ Mudlet packages] is a collection of packages submitted by game developers, players and Mudlet fans alike.  It is designed to be a central system for finding useful packages and scripts to enhance your gaming pleasure.  While there is a vast array of packages available here, some scripters choose not to submit their work in which case you can find them somewhere else, see below.
 == via the Web ==

@@ Line 66: / Line 66: @@
 A Mudlet module is very similar to a Mudlet package - the only difference is how you import it: via the Module Manager (Alt+I) instead of the Package Manager (Alt+O), and what happens after: Mudlet will save the module back to the original file instead of the profile save file. This means the original XML or mpackage (in Mudlet 4.14+) will automatically get updated. Really useful if you're writing Mudlet code to share with others - you won't have to ever manually export it again, Mudlet will do it automatically for you! You can version your modules using Git using this way.
-You can also share a module across several profiles and automatically keep it in sync by installing the module in the relevant profiles and ticking the "sync" option in all of them.  '''This method will not work if you multiplay multiple profiles at once''', as any changes in one profile may overwrite changes made in another profile when saved.
+You can also share a module across several profiles and automatically keep it in sync by installing the module in the relevant profiles and ticking the "sync" option in all of them.
 If you'd like your module to be loaded before all the scripts in a Mudlet profile, you can do that with the <code>-1</code> module priority.
@@ Line 81: / Line 81: @@
 If you have a module on your computer use the Module Manager (Alt+I) from the toolbar to install it.  Modules can be uninstalled from the same interface.
 = Package Development =

← Older revision		Revision as of 13:45, 25 September 2024
Line 207:		Line 207:

	<code>installPackage("https://<my game package location>")</code>		<code>installPackage("https://<my game package location>")</code>
		+
		+	The cons of this method means that any updates to your package and notifying your users is up to you, as it will not be shared with the repository's update system.


	[[Category:Mudlet Manual]]		[[Category:Mudlet Manual]]

@@ Line 67: / Line 67: @@
 [[File:ProfileExport-Form-Name.png|frameless|]]
-=== Package optional details ===
+=== Package details ===
 [[File:ProfileExport-Form-Options.png|frameless|Make your package stand out]]
-The optional details allow setting:
+The details allow setting:
 * Author information

@@ Line 63: / Line 63: @@
 Each new package requires a name or use the dropdown menu to update a currently installed package. Select the profile configuration and definitions to be exported using the interface. For simple exports, this information is enough to create a file.
-To build a Mudlet package following best practices, use the Package optional details by pressing '''(optional) add icon, description, and more''' to define additional metadata and provide information to Mudlet users that choose to import your package.
+To build a Mudlet package following best practices, use the Package details by pressing '''add icon, description, and more''' to define additional metadata and provide information to Mudlet users that choose to import your package.
 [[File:ProfileExport-Form-Name.png|frameless|]]

@@ Line 7: / Line 7: @@
 == Where to find Mudlet packages ==
-Check out the [https://forums.mudlet.org/viewforum.php?f=6 Scripts & Packages] section on Mudlet forums for an excellent selection of Mudlet packages.
+Check out the [https://forums.mudlet.org/viewforum.php?f=6 Scripts & Packages] section on Mudlet forums for an excellent selection of Mudlet packages.  Those listings are also being transferred over to the [https://wiki.mudlet.org/w/Category:Mudlet_Package_Listing Mudlet Package Listing].
-Some Mudlet packages may also be exlusively available on your own game-specific website or forums, so make sure to check out what your game has to offer as well.
+Some Mudlet packages may also be exclusively available on your own game-specific website or forums, so make sure to check out what your game has to offer as well.
 == What is a Mudlet module ==

@@ Line 25: / Line 25: @@
 === as a one-liner ===
-In the command line:
+In the command line as a package:
-<code>lua installPackage"http://<online package location>"</code>
+<code>lua installPackage("https://<online package location>")</code>
 === as a module ===

@@ Line 89: / Line 89: @@
 To remove an included asset, select it from the list and use backspace (fn + delete on macOS) to remove it.
-'''NOTE:''' Currently there is no way in the interface to remove a dependency. '''Choose settings carefully''' or you may need to discard changes and try again.
+'''NOTE:''' To remove a dependency that has already been selected and added, use CTRL+Delete (Linux/Windows) or FN+Backspace (MacOS).
 [[File:ProfileExport-Form-References.png|frameless|Include any dependencies]]

@@ Line 116: / Line 116: @@
 === Including images, sounds, and other files ===
-If you'd like to include other folders or files in the package, you can - they will be copied into ''getMudletHomeDir().."/"..packagename'' upon installation, so your scripts can use them. Since Mudlet 3.10 you can include font files and they will be automatically available for your scripts to use.
+If you'd like to include other folders or files in the package, you can - they will be copied into ''getMudletHomeDir().."/"..packagename'' upon installation, so your scripts can use them. Since Mudlet 3.10 you can include font files (.otf or .ttf) and they will be automatically available for your scripts to use.
 For example, if your package is called "sipper" and you have health.png as an image in it, you can place on a label like so: