https://github.com/gesslar/highlighter

Speedwalking highlighter for Mudlet
https://github.com/gesslar/highlighter

mudlet mudlet-mapper-script mudlet-package

Last synced: about 1 month ago
JSON representation

Speedwalking highlighter for Mudlet

• Host: GitHub
• URL: https://github.com/gesslar/highlighter
• Owner: gesslar
• Created: 2024-09-23T02:17:39.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-23T18:57:27.000Z (2 months ago)
• Last Synced: 2024-10-24T04:57:40.151Z (2 months ago)
• Topics: mudlet, mudlet-mapper-script, mudlet-package
• Language: Lua
• Homepage:
• Size: 48.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Highlighter

Speedwalk path highlighter for Mudlet

## Description

This package allows you to highlight your speedwalk paths in a different colour

so that you can more easily see where you are going.

## Configuration

In Mudlet, type `highlight` to see the help information for this package.

* `highlight set` - See your current preference settings

* `highlight set  ` - Set a preference to a value

  Available preferences:

  * `fade` - Enable or disable the fade effect (default: on)

  * `step` - Set the granularity of the fade (default: 10)

  * `delay` - Set the speed of the fade (default: 0.05)

  * `colour` - Set the colour of the highlight (default: gold)

Note that the colour must be a valid [Mudlet colour name](https://wiki.mudlet.org/images/c/c3/ShowColors.png).

## Events

This package listens to the following events in order to function. You will

need to ensure that these events are passed along with the required arguments

(if any).

### `onMoveMap`

Trigger this event when the player has moved to a new room. Highlighter uses

this information to know when to begin fading the previous room.

#### Arguments

* `current room id` - The id of the room the player has arrived in.

### `sysSpeedwalkStarted`

Trigger this event to indicate that the speedwalk has started. Highlighter will

use this notification and information provided to highlight the route.

#### Arguments

* `none` - No arguments are required.

### `sysSpeedwalkFinished`

Trigger this event when the speedwalk has finished. Highlighter will use this

notification to know when to fade all of the remaining highlights.

#### Arguments

* `none` - No arguments are required.

None

### `onSpeedwalkReset`

Trigger this event when the speedwalk has been reset. Highlighter will use this

notification immediately remove all highlights.

#### Arguments

* `exception` - True or false if the reset was due to an exception.

* `reason` - The reason the speedwalk was reset.

## Support

While there is no official support and this is a hobby project, you are welcome

to report issues on the [GitHub repo](https://github.com/gesslar/Highlighter).

## Dependencies

The following packages are required and will be automatically installed if they

are missing:

* [Helper](https://github.com/gesslar/Helper)

## Credits

[Marker icons created by mavadee - Flaticon](https://www.flaticon.com/free-icons/marker)