Difference between revisions of "MQ2MMOBugs" - MMOBugs Wiki

Sidebar Sidebar
Page Discussion
View source History
 
(4 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
| author = MMOBugs Developers
 
| author = MMOBugs Developers
 
| link = [http://www.mmobugs.com/wiki/index.php/MQ2MMOBugs MQ2MMOBugs]
 
| link = [http://www.mmobugs.com/wiki/index.php/MQ2MMOBugs MQ2MMOBugs]
−
| commands=None
+
| commands=/memindi /mmoversion /mmostatus /mmologin
 
| source = No
 
| source = No
−
| usesini = No
+
| usesini = Yes
 
}}
 
}}
 
==Description==
 
==Description==
Line 16: Line 16:
 
To use <span class="highlight">MQ2MMOBugs</span> or any plugin that requires it, you must use [http://www.mmobugs.com/wiki/index.php/MMOLoader MMOLoader] and be logged with your active subscription.
 
To use <span class="highlight">MQ2MMOBugs</span> or any plugin that requires it, you must use [http://www.mmobugs.com/wiki/index.php/MMOLoader MMOLoader] and be logged with your active subscription.
  
−
<span class="highlight">Plugins that require MQ2MMOBugs</span>
+
==Commands==
 +
* <span class="highlight2">/mmostatus</span> Displays your login status.
 +
* <span class="highlight2">/mmologin</span> Reconnects if logged out.
 +
* <span class="highlight2">/mmoversion</span> Shows the compile version info.
 +
* <span class="highlight2">/memindi</span> Controls display of the memory information HUD.
 +
 
 +
==Example Usage==
 +
This command will turn off the memory indicator.
 +
* <span class="highlight2">/memindi off</span>
 +
 
 +
 
 +
This command will turn on the memory indicator.
 +
* <span class="highlight2">/memindi on</span>
 +
 
 +
 
 +
This command will move the memory indicator to X=100 and Y=200 on your screen.
 +
* <span class="highlight2">/memindi 100,200</span>
 +
 
 +
 
 +
This command will reload your INI file.
 +
* <span class="highlight2">/memindi load</span>
 +
 
 +
 
 +
 
 +
==Macro Data==
 +
 
 +
This plugin adds a new TLO called Mem.
 +
 
 +
===ExampleType===
 +
* <span class="highlight2">${Mem} : string</span> - Return TRUE if the plugin is loaded.
 +
* <span class="highlight2">${Mem.SysAvail} : int</span> - Return the free system memory in MB.
 +
* <span class="highlight2">${Mem.SysTotal} : int</span> - Return the total system memory in MB.
 +
* <span class="highlight2">${Mem.SysPct} : int</span> - Return the % of free system memory.
 +
* <span class="highlight2">${Mem.EQAvail} : int</span> - Return the free process virtual memory in MB.
 +
* <span class="highlight2">${Mem.EQTotal} : int</span> - Return the total process virtual memory in MB.
 +
* <span class="highlight2">${Mem.EQPct} : int</span> - Return the % of free process virtual memory.
 +
 
 +
==Configuration==
 +
The MQ2MMOBugs.ini file can have the following options:
 +
 
 +
[MemIndi] section:
 +
* <span class="highlight2">Indicator</span> - Whether to show the HUD info or not.
 +
* <span class="highlight2">IndicatorX</span> - X screen location where the HUD info displays.
 +
* <span class="highlight2">IndicatorY</span> - Y screen location where the HUD info displays.
 +
* <span class="highlight2">GreenColor</span> - The color for 'green' memory status.
 +
* <span class="highlight2">BlueColor</span> - The color for 'blue' memory status.
 +
* <span class="highlight2">YellowColor</span> - The color for 'yellow' memory status.
 +
* <span class="highlight2">RedColor</span> - The color for 'red' memory status.
 +
 
 +
==Sample Configuration==
 +
 
 +
MQ2MMOBugs.ini
 +
<pre>
 +
[MemIndi]
 +
IndicatorX=5
 +
IndicatorY=35
 +
Indicator=1
 +
GreenColor=259
 +
BlueColor=263
 +
YellowColor=15
 +
RedColor=13
 +
</pre>
 +
 
 +
 
 +
==Plugins that require MQ2MMOBugs==
  
 
* [http://www.mmobugs.com/wiki/index.php/MQ2AASpend MQ2AASpend]
 
* [http://www.mmobugs.com/wiki/index.php/MQ2AASpend MQ2AASpend]

Latest revision as of 01:12, 18 August 2023

Plugin Info
Name MQ2MMOBugs
Author MMOBugs Developers
Link MQ2MMOBugs
Commands /memindi /mmoversion /mmostatus /mmologin
Source Available No
Uses INI File Yes

Description

MQ2MMOBugs is the MMOBugs framework plugin that provides functionality that other plugins rely on. It also provides session management in conjunction with the MMOLoader.

When loading plugins, it is always a good idea to make sure that MQ2MMOBugs is loaded first.

Usage

To use MQ2MMOBugs or any plugin that requires it, you must use MMOLoader and be logged with your active subscription.

Commands

  • /mmostatus Displays your login status.
  • /mmologin Reconnects if logged out.
  • /mmoversion Shows the compile version info.
  • /memindi Controls display of the memory information HUD.

Example Usage

This command will turn off the memory indicator.

  • /memindi off


This command will turn on the memory indicator.

  • /memindi on


This command will move the memory indicator to X=100 and Y=200 on your screen.

  • /memindi 100,200


This command will reload your INI file.

  • /memindi load


Macro Data

This plugin adds a new TLO called Mem.

ExampleType

  • ${Mem} : string - Return TRUE if the plugin is loaded.
  • ${Mem.SysAvail} : int - Return the free system memory in MB.
  • ${Mem.SysTotal} : int - Return the total system memory in MB.
  • ${Mem.SysPct} : int - Return the % of free system memory.
  • ${Mem.EQAvail} : int - Return the free process virtual memory in MB.
  • ${Mem.EQTotal} : int - Return the total process virtual memory in MB.
  • ${Mem.EQPct} : int - Return the % of free process virtual memory.

Configuration

The MQ2MMOBugs.ini file can have the following options:

[MemIndi] section:

  • Indicator - Whether to show the HUD info or not.
  • IndicatorX - X screen location where the HUD info displays.
  • IndicatorY - Y screen location where the HUD info displays.
  • GreenColor - The color for 'green' memory status.
  • BlueColor - The color for 'blue' memory status.
  • YellowColor - The color for 'yellow' memory status.
  • RedColor - The color for 'red' memory status.

Sample Configuration

MQ2MMOBugs.ini 

[MemIndi]
IndicatorX=5
IndicatorY=35
Indicator=1
GreenColor=259
BlueColor=263
YellowColor=15
RedColor=13


Plugins that require MQ2MMOBugs

Availability

This plugin is included with the MMOBugs Compile.

Retrieved from "https://www.mmobugs.com/wiki/index.php?title=MQ2MMOBugs&oldid=2701"