MQ2ManPage

[Alatyami]

Have you ever found yourself in-game and wanting the syntax of a plugin without having to start it and do a /pluginname help? Will now we have MQ2ManPage!

For those that are used to the UNIX/LINUX environment you already know what this plugin does. For those that are not ...

A "manpage" is a one page manual. A simple how-to or syntax guide. You usually see this when you screw up a command in MQ2 and the developer tells you "hey idiot! RTFM! you do it like this ...".

MQ2ManPage is simple. Developers can create a MQ2PluginName.txt file to be placed in your macroquest folder. What your MQ2 folder is alread cluttered? Well good news, Alatyami is a neat freak (not really, but the line sounds good). All of the "manpages" go into the ManPages folders located in you macroquest folder (note you may need to create it yourself until the next JMO release.)

So enjoy!

I will be migrating all of the syntax commands in the JMO posts to manpage.txt files, that way JMO doesnt get to pad his post stats anymore.

-Alatyami

:judge

 

[Alatyami]

Ok being that I completely change the format from dumbing text reading to XML the ManPage formats have changed. New ManPages on the way!

MQ2AdvPath.xml

I'll do a couple more of the main plugins ...

-Alatyami

 

[unknown405]

Good idea and nice plugin, have a redcent.

-UnKnoWn

 

[Jmo]

Thanks for all th hard work Yammerz. Will definitely get this up and running with the next compile release.

 

[Alatyami]

But Alatyami, how could you improve such an awesome plugin? How about XML support?

Yes you heard it right! Less than five hours of release and now you too can use MQ2ManPage 2.0! 2.0! 2.0!

So, you ask, "Alatyami, how many of those RedCents things is this going to cost?". Good news! It will cost you a total of 0 RedCents! Yes you heard it right! 0 RedCents!

Syntax:

/man [pluginname] [c|s|d|v]
c = All commands for the plugin with a description
s = All syntax (Commands, Command Description, and Examples)
d = A description of the plugin itself
v = Plugin version, author, and date.

Sample XML manpage:

<?xml version="1.0" ?>
<MQ2ManPage version="2.0" author="Alatyami, NotAddicted.com" date="May 26, 2008">
  <description>This plugin returns any in-game syntax availible for the given plugin if there is a manpage.xml avialible for it.</description>
  <syntax>
    <command name="/man" args="[pluginname]" example="/man mq2manpage">
      Returns all sections.
    </command>
    <command name="/man" args="[pluginname] s" example="/man mq2manpage s">
      Returns the full syntax of teh plugi.
    </command>
    <command name="/man" args="[pluginname] v" example="/man mq2manpage v">
      Returns the plugin information section.
    </command>
    <command name="/man" args="[pluginname] d" example="/man mq2manpage d">
      Returns the plugin description.
    </command>
    <command name="/man" args="[pluginname] c" example="/man mq2manpage c">
      Returns the available commands without examples.
    </command>    
  </syntax>
</MQ2ManPage>

Main post has been updated ....

 

[unknown405]

I tried to give a redcent for upgrading it to XML already, but said I need to spread the love before giving it to you again. So I gave it to JMO, because he always deserves some red cents and now it's saying I must wait 24 hours.. sooo I'll get you one tomorrow, good job!

 

[Alatyami]

lol ... thats awesome. It you want to see some improvements, let me know.

 

[nyghteyes]

I Like this alot!

Great Idea, Thanks, have a RC!

 

[Alatyami]

Thanks!

 

[toejam]

Quick question. I think I'm doing something wrong. When I clik on the xml link it asks if I want to open it. I say yes and it results in this

"
  <?xml version="1.0" ?> 
- <MQ2AdvPath version="" author="A_Enchanter_00" date="">
  <description>Plugin version of AdvPath.mac and .ini. AdvPath TLO's: ${AdvPath.Active} Plugin Loaded and ready ${AdvPath.State} // FollowState, 0 = off, 1 = Following, 2 = Playing, 3 = Recording ${AdvPath.Waypoints} // Total Number of Waypoints ${AdvPath.NextWaypoint} // Number of NextWaypoint ${AdvPath.Y[Check Point Name OR Waypoint number]} LOC ${AdvPath.X[Check Point Name OR Waypoint number]} LOC ${AdvPath.Z[Check Point Name OR Waypoint number]} LOC ${AdvPath.Monitor} // Spawn your following ${AdvPath.Idle} // Idel time when following and not moving ${AdvPath.Length} // Estimated length off the follow path ${AdvPath.Following} // BOOL Following spawn ? ${AdvPath.Playing} // BOOL Playing ? ${AdvPath.Recording} // BOOL Recording? ${AdvPath.Status} // INT Status 0 = off , 1 = on , 2 = paused? ${AdvPath.Paused} // BOOL Paused?</description> 
- <syntax>
  <command name="/afollow" args="[on|off]" example="">Auto-Follow target turned on or off.</command> 
  <command name="/afollow" args="[pause|unpause]" example="">Pause/Unpause auto-follow</command> 
  <command name="/afollow" args="spawn [spawnID]" example="">Auto follow a given spawn.</command> 
  <command name="/afollow" args="" example="">Auto-Follow Traget turned on.</command> 
  <command name="/play" args="[on|off] [slow|fast]" example="">Play a recorded path.</command> 
  <command name="/record" args="" example="">Start recording a path</command> 
  <command name="/record" args="save [name]" example="">Save the recorded path.</command> 
  <command name="/record" args="checkpoint [name]" example="">Set a checkpoint for the recorded path.</command> 
  </syntax>
  </MQ2AdvPath> "

Is this the way it is supposed to look? Sorry anonther newb question... ((

 

[Alatyami]

Kinda.

What editor are you using? Internet Explorer? If you open it with Notepad the line feeds should look better.

 

[Alatyami]

added more xml files to the main post ...

Decker has completed a lot also which he'll be posting soon ...

~alatyami