Difference between revisions of "Mudlet Scripts"

From Haelrahv Wiki
Jump to navigation Jump to search
(4 intermediate revisions by the same user not shown)
Line 8: Line 8:
  
 
You will need:
 
You will need:
# The Mapper (.mpackage file)
+
# The Mapper (.mpackage file) - Within Mudlet, press <code>Alt O</code> and then select <code>HR Mapper.mpackage</code> to install.
# The Map (.dat file) - optional if you want to make your own, but it includes more than 3000 premapped rooms of the most common areas.
+
# The Map (.dat file) - This is the actual map; within mudlet, press <code>Alt P</code>, go to the <code>Mapper</code> tab, and click the <code>Press to choose file and load</code> button, and select the dat file.
 
# In game, use: <code>set gmcp to on</code>
 
# In game, use: <code>set gmcp to on</code>
  
 
The following files are also located in the [https://discord.gg/M42HPRc Haelrahv Discord] in the "script-sharing" channel.
 
The following files are also located in the [https://discord.gg/M42HPRc Haelrahv Discord] in the "script-sharing" channel.
  
Downloads: [[Media:HR_Mapper.mpackage]] | [[Media:Haelrahvmap.dat]]
+
Downloads: [[Media:HR_Mapper.mpackage]] | [[Media:Haelrahvmap.dat]] (This map is out of date, please see discord for now)
  
 
<strong>Disclaimer/Notice:</strong> Haelrahv does not use an internal coordinate system it can report to the mapper, and the mapper makes a 'best guess.' It can often range from a little messy to very messy.
 
  
 
Commands:  
 
Commands:  
  
* <code>mapper start</code>, <code>mapper stop</code> - Start or stop map creation mode. Leaving this on is not recommended, as it may recalculate room positions in areas that do not line up cleanly on a grid (such as Llanfair).
+
* <code>mapper start full</code>, <code>mapper stop</code> - Start or stop map creation mode. Leaving this on is not recommended, as it may recalculate room positions in areas that do not line up cleanly and will overwrite manual edits (that, for example, lock invalid paths or stop the mapper from looping)
 
* <code>roomsearch NAME</code> - Searches for a room by name. Results will be a list that can be clicked for auto navigatation.
 
* <code>roomsearch NAME</code> - Searches for a room by name. Results will be a list that can be clicked for auto navigatation.
* <code>goto NAME/ID</code> - Goes to a room with a certain name or ID number. If you supply a name and there are several rooms that match, you'll be shown a clickable list to select your destination. Alternatively, you can use the command again with one of the room IDs you'll be shown. If a movement invokes roundtime while walking, simply <code>look</code> when out of roundtime and the path will resume.
+
* <code>goto NAME/ID</code> - Goes to a room with a certain name or ID number. If you supply a name and there are several rooms that match, you'll be shown a clickable list to select your destination. Alternatively, you can use the command again with one of the room IDs you'll be shown.
 
* <code>mstop</code> - Abort navigating a path in progress, such as from the goto command.
 
* <code>mstop</code> - Abort navigating a path in progress, such as from the goto command.
 
* <code>showpath</code> - Similar to goto, but instead of taking you there, this only shows you the path.
 
* <code>showpath</code> - Similar to goto, but instead of taking you there, this only shows you the path.
 
* <code>delall</code>, <code>delarea</code>, <code>delroom</code> - Delete the entire map, the area you are in, or the room you are in, respectively. In the case of deleting only a room, using <code>look</code> with map creation mode enabled will add the room again.
 
* <code>delall</code>, <code>delarea</code>, <code>delroom</code> - Delete the entire map, the area you are in, or the room you are in, respectively. In the case of deleting only a room, using <code>look</code> with map creation mode enabled will add the room again.

Revision as of 02:04, 20 January 2021

Haelrahv Mapper

Mapper Pathing.png
Mudlet Mapper Window.png




This package can track your location on the existing map, as well as provides tools to map new places and areas.

You will need:

  1. The Mapper (.mpackage file) - Within Mudlet, press Alt O and then select HR Mapper.mpackage to install.
  2. The Map (.dat file) - This is the actual map; within mudlet, press Alt P, go to the Mapper tab, and click the Press to choose file and load button, and select the dat file.
  3. In game, use: set gmcp to on

The following files are also located in the Haelrahv Discord in the "script-sharing" channel.

Downloads: Media:HR_Mapper.mpackage | Media:Haelrahvmap.dat (This map is out of date, please see discord for now)


Commands:

  • mapper start full, mapper stop - Start or stop map creation mode. Leaving this on is not recommended, as it may recalculate room positions in areas that do not line up cleanly and will overwrite manual edits (that, for example, lock invalid paths or stop the mapper from looping)
  • roomsearch NAME - Searches for a room by name. Results will be a list that can be clicked for auto navigatation.
  • goto NAME/ID - Goes to a room with a certain name or ID number. If you supply a name and there are several rooms that match, you'll be shown a clickable list to select your destination. Alternatively, you can use the command again with one of the room IDs you'll be shown.
  • mstop - Abort navigating a path in progress, such as from the goto command.
  • showpath - Similar to goto, but instead of taking you there, this only shows you the path.
  • delall, delarea, delroom - Delete the entire map, the area you are in, or the room you are in, respectively. In the case of deleting only a room, using look with map creation mode enabled will add the room again.