Difference between revisions of "Manual:Profile and Packages"

From Mudlet
Jump to navigation Jump to search
(Sharing your System with others - Making complex Packages: fix random capitalisation)
(Exporting and Importing Profiles or Packages)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{TOC right}}
 
{{TOC right}}
=Exporting and Importing Profiles or Packages=
+
=Exporting and Importing Packages=
  
Mudlet supports XML packages that can be imported and exported while playing. You can find a package section on the [http://forums.mudlet.org/viewforum.php?f=6 forum], where you can download demo packages or ready made packages for your MUD or upload your own packages to share your work with other players. A package can contain anything ranging from a single trigger to hundreds of button groups, trigger groups aliases - in other words, entire "systems".
+
Mudlet supports xml and zip (.mpackage) packages that can be imported and exported while playing. You can find a package section on the [http://forums.mudlet.org/viewforum.php?f=6 forum], where you can download demo packages or ready made packages for your game or upload your own packages to share your work with other players. A package can contain anything ranging from a single trigger to hundreds of button groups, trigger groups aliases - in other words, entire "systems".
  
 
==Importing Packages==
 
==Importing Packages==
  
To import a package, open the script editor and click the import icon, select your xml package file and import it. Package files might be compressed to save space. If the file is compressed, you’ll need to uncompress it before importing it. The imported package will be stored permanently in your profile when you safe the profile. If you don’t like the imported package, delete its components manually or simply don’t save the profile. Then the new content will be lost on restart. Good packages will be organized in such a way that they will be easy to update or remove.
+
To import a package, open the Package Manager and click the import icon, select your package file, and import it.  
  
Packages are nothing else, but profiles - or parts of profiles that can be exchanged, imported and exported between your own profiles and between different players. From a technical perspective a package and a profile xml file are the same thing.
+
If you don't like the imported package, you can uninstall it from the Package Editor.
 +
 
 +
Packages can also be imported using the Module Manager, which is different from the Package Manager: importing a package as a module will ''not'' merge it into your profile but keep it in its original location on your computer. The advantage of that is when you make changes to the module, you don't have to re-export it: all changes will be saved back in the original file.
 +
 
 +
Modules also allow you to sync them across many profiles - so installing the same module in many profiles and editing it in one will automatically update it in others.
  
 
==Exporting Packages==
 
==Exporting Packages==
To export a single set of items, you can select them and hit the 'Export' button on top of the script editor.
+
To export just one item, you can select it and hit the 'Export' button on top of the script editor.
  
To export several different types of items, go to Toolbox → Package Exporter. Tick the items you'd like to export, select a file to export to, and hit ''Export''.
+
To export many related items as one package, go to the Toolbox → Package Exporter (experimental). Enter the name of your package to be and set the location it should be saved to when exported.
  
To export your entire profile e. g. to make a backup on a flash drive, use the "save profile as" button. You can export packages of a trigger branch, alias branch, function key, scripts etc. by clicking on a folder in the tree of the particular item in question and then click on the export icon. You’ll be asked to give a filename for your package. You can export arbitrarily complex structures by moving them into a folder that e.g. is named after the package you’d like to make.
+
Then, select any triggers/aliases/scripts/etc you'd like to export in the package. If you'd like to add custom fonts, images, or sounds, you can add them in as well. When that is all done hit the Export button to create your package.
  
==Sharing your system with others - making complex packages==
+
To export your entire profile e. g. to make a backup on a flash drive, use the "save profile as" button.
  
If you have written a nice set of triggers, buttons, scripts etc. or maybe even a fully fledged "system" of some sort and you want to share it with others, you can make nice packages that other people can import with a single mouse click. The recommended procedure to make a large package that contains groups of all sorts of items e.g. trigger groups, individual triggers, scripts, buttons, aliases etc., is to export the entire profile with "save profile as". Then create a new empty profile e.g. with your package name. Don’t give a server or port name in the connection dialog and "connect". Mudlet will load the new empty profile although you are offline. Open the script editor and import your previously exported profile and then delete all items that are not part of the package that you are making. Finally, make a folder (group) that is named after your package name and version number e.g. "Johnny’s curing system 12-3-2009" and move all respective items into this folder and repeat the same procedure for all triggers/aliases/scripts etc.. This will make it much easier for other people to import your package and stay updated if you release a newer version. Then save your profile and use the "save profile as" button to create your package.
 
 
[[Category:Mudlet Manual]]
 
[[Category:Mudlet Manual]]

Latest revision as of 09:09, 12 October 2019

Exporting and Importing Packages

Mudlet supports xml and zip (.mpackage) packages that can be imported and exported while playing. You can find a package section on the forum, where you can download demo packages or ready made packages for your game or upload your own packages to share your work with other players. A package can contain anything ranging from a single trigger to hundreds of button groups, trigger groups aliases - in other words, entire "systems".

Importing Packages

To import a package, open the Package Manager and click the import icon, select your package file, and import it.

If you don't like the imported package, you can uninstall it from the Package Editor.

Packages can also be imported using the Module Manager, which is different from the Package Manager: importing a package as a module will not merge it into your profile but keep it in its original location on your computer. The advantage of that is when you make changes to the module, you don't have to re-export it: all changes will be saved back in the original file.

Modules also allow you to sync them across many profiles - so installing the same module in many profiles and editing it in one will automatically update it in others.

Exporting Packages

To export just one item, you can select it and hit the 'Export' button on top of the script editor.

To export many related items as one package, go to the Toolbox → Package Exporter (experimental). Enter the name of your package to be and set the location it should be saved to when exported.

Then, select any triggers/aliases/scripts/etc you'd like to export in the package. If you'd like to add custom fonts, images, or sounds, you can add them in as well. When that is all done hit the Export button to create your package.

To export your entire profile e. g. to make a backup on a flash drive, use the "save profile as" button.