Editing Macros

MTScript is a custom language for writing MapTool macros which grew out of MapTool’s chat functionality. It began simply enough as a way to roll dice. It expanded over time to the point where users create custom gaming frameworks and convenience functions in MapTool to be used by GMs and Players alike. To get a hint of what mtScript can do, check out the User Creations topic in the MapTool forum. To see MTScript taken to the Nth degree see Wolph42’s Bag of Tricks which encapsulates extreme MTScripting. You’ll find support for complete RPG frameworks for a huge number of games systems in Campaign Frameworks.

The MapTool macro editor is a little lacking in functionality so the community stepped up to create tools for editing. It’s one of the strengths of this group, the desire to contribute when and where they can. There are at least two community gems out there that allow for easy editing and syntax checking for Macros.

vim_headerThe first is Craig’s GVIM configuration. You can find download and installation instructructions at this forum link. GVIM is the descendant of the venerable VI editor. People either love or hate VI. It uses one or two character commands and is very powerful. You almost never need to touch the mouse once you get use to it. To get over VI’s learning curve we suggest reading vimbook-OPL.pdf. Azhrei also produced a quick reference sheet. GVIM runs on Windows, Mac, Linux.

notepad++

The second external editor that can be used is Notepad++ with Aliasmask’s configuration. Notepad++ is more user friendly and is closer to the editors most users know. However, it only runs on Windows operating systems or a system in Windows emulation mode, such as Linux Wine.

RPedit LogoRegardless of which you use, the RPEdit library token is a great utility that allows you to extract all the macros from a token for easy copying into one of the above tools.  The tool is actually written in MTScript and allows for macro configuration and button display properties.

rpedit

You can find the files and full instructions on this forum link. Besides editing, you can also put your macros under source code control by saving them out to github or sourceforge.

If you decide to take the plunge into Macro writing, visit the Introduction to Macro Writing on the RPTools Documentation Wiki. If you get stuck head over to the MapTool->Macros topic in the RPTools forum for help.

2 Responses to Editing Macros

  1. We have upgraded to 1.4 but I get cheater etc on several of the macros. A couple of them are cheats but I’m the GM I sometimes need to, we only have a small group and cheating is necessary sometimes, killing everybody isn’t useful. Something simple like hit location doesn’t run. Can you point me to suggestions like how to rewrite or block the check. Help would be appreciated as none of us have lots of spare time.
    Kev

  2. The best way to find an answer to such questions are to go to the forums and post the question. There are lots of folks with an in-depth knowledge of MTScript that can help.

Leave a reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.