BatMap

World map for BatMUD

This package provides an undockable user window in Mudlet, showing the continent map for a player's current location.

Usage

Currently, there's a BatMap/update trigger that needs BatMUD to echo commands to move the map on directional movement. Basically, as long as you send a whereami command to BatMUD whenever you want to move the map to your position, the map should work fine.

There's also the option to override the command being sent to the game: create a BatConfig table and add a movementCommand item. For example:

BatConfig = BatConfig or {}
BatConfig.movementCommand = "@sc"

You'll have to make sure that you capture the output of that command and raise the event as is described in the API section.

Or you can disable the trigger of automatic updates with commands by configuring the movementCommand as an empty string:

BatConfig.movementCommand = ""

This could be useful of you want to trigger off your prompt.

Aliases

• wmap show|hide
  • Shows or hides the world map window.

API

• raiseEvent("BatMap.event.locationUpdated", continent, x, y)
  • If you want to add additional ways to move/change the map, you can raise this event.
  • The x and y are coordinates within the continent. They will not work with global coordinates.

Final thoughts, how to contribute, thanks, things like that

This is a preliminary release of my BatMap. Good enough already to let others try it out, but lacking a few things I'd like to add in the near future, such as zooming.

History

v1.0.2 - April 10, 2026

Improvements from review feedback and added the option to override the movement command.

v1.0.1 - April 10, 2026

Tiny fix to the initial x-coordinate of the world map user window as it started at x = 100% (trying to for the user window to appear outside the main window).

v1.0.0 - April 9, 2026

Very first release