Bashmatic/readme.md
2024-06-16 10:59:55 -04:00

4.1 KiB

What is this?

Bashmatic is a generic script package for mudlet. Many muds have a character visit areas and attack various denizens to gain experience to level up. This process is colloquially called bashing. Bashmatic is a very generic script package that automates this process.

What does it support?

Again, it's very generic. Because of that it supports pretty much anywhere that you can bash using a one line command to do so. However, because of the generic nature of the script it also doesn't support more advanced features games might have. It does however support sending commands to the game before and after fights. It also supports grouping bashing targets by areas if you use the mudlet mapper or your game supports gmcp. It also supports finding enemies by gmcp or general input scraping. So overall:

  • Supports sending a customized pre-bashing command
  • Supports sending a customized bashing command
  • Supports sending a customized post-bashing command
  • Supports specifying a custom mob death phrase
  • Supports grouping bashing targets by area
  • Supports detecting areas using the mudlet mapper or by GMCP
  • Supports detecting enemies by GMCP or general input scraping
  • Provides a function bmDisable() that will disable the basher so you can rig a flee/wimpy trigger/alias

Can I use this on my mud?

I don't know. Many muds have rules against this kind of script. Just as many muds don't care if you use a script like this. Yet more sit somewhere in the middle. It's your responsibility to know where the rules on your mud stand.

Are there any cavaets?

A few but none that are too bad.

Switching To Area Group Mode

By default, Bashmatic does not group by areas. This means if you switch the target grouping mode to areas you will erase your target list. This is by necessity. If area grouping is turned off, no area data is stored for targets. When you turn on area grouping, we have no way of finding out what area they should be in. So you'll have to readd them to get them in the right area. This is not true of the other way. If you are grouping by area and turn that off, then we will simply collate all targets into a giant list. You can then clear your target list using bm clear if you want.

GMCP Usage

GMCP requires you to tell the script where the variables are located. This isn't hard. You can type lua gmcp into mudlet to get back a listing of the gmcp data your mud sends out. If the list of enemies on your mud was at Room.Info.Enemies you could give me that information using bm config egmcp=Room.Info.Enemies

Grouping Targets By Areas

If grouping by GMCP areas, also see above. We can group targets by areas if you prefer as long as we can tell which area we are in. This can happen by the mud sending the area name by GMCP or by mudlet returning an area through GetRoomArea(GetPlayerRoom()). This can be useful for keeping your target lists manageable assuming you want to be able to look at them.

Auto target switching

Bashmatic doesn't technically support auto-target switching, but we have a jury rigged solution. Upon detecting an enemy's death we will look at the room again.

Before, During, and After Bashing commands

You should know that the only time we append the target name is bashing start command. Before, During, and After bashing commands do not receive the target name.

Required Setup

At the very least, you'll need to setup a bashing command. This can be as simply as just kill and we'll fill in the target. And you'll need some kind of death trigger. On a lot of muds this could just be the word died. A lot of muds just use some variation of the phrase has died and this script will match .*word.*. Then at least one target added using bm add target. So bm add bunny maybe.

  • A bash command, Possibly just: kill
  • A death trigger, Possibly just: died
  • At least one target, Possibly just: bm add bunny

How does this work?

It depends. Under the hood, it's much more efficient if we can get enemy data from GMCP. Using GMCP, we can simply scan GMCP data for changes to enemy data and react to that. Without GMCP, we create temporary triggers and react to those as they fire.