Overview

This plugin will put a governor on the frames per second (FPS) of your foreground and background instances of EQ. This can reduce each client instances load on your computer. The idea is to lower the FPS of background instances since choppy video on a background instance isn’t a problem. This doesn’t slow macro/game performance.

Framerate Commands

/maxfps fg|bg <FPS:0-200>

Sets the maximum frame rate for foreground (fg) or background (fg) instances.

Example
Set our frame per second limit to 10 on our background instances of EQ
/maxfps bg 10

/fps mode [absolute|calculate]

Sets the frame limiter mode to absolute or calculate.

Example
Set the limiter to absolute.
/fps mode absolute

Example
Toggle the limiter mode.
/fps mode

/render fg|bg [~]<frames:0-200>

Sets the foreground (fg) or background (bg) rendering ratio—or how many frames of animation get drawn. Without the tilda only 1 frame gets drawn out of the number you specified. With a tilda [~] it kind of flips the logic from inclusive to exclusive; it skips drawing a frame every nth frames you specified (see examples)

Example
Set the foreground render rate to draw 1:4 frames. (Only draws a frame every 4 frames)
/render fg 4

Example
Set the background render rate to draw 7:8 frames. (Skips a frame every 8 frames)
/render bg ~8

This logic with the tilda seems a bit odd to me, if someone has a better explanation please reply and I’ll add it to the documentation. Some documentation shows being able to use multiple numbers (1~1), but I don’t think this actually does anything useful; please correct me if I’m wrong.

Display Commands

/fps on|off

Turns the frame rate display on or off.

Example
Turn off the frame rate display
/fps off

/fpscolor <color code:0-255>

Sets the color of the frame rate display. Using predefined color codes.

Example
Sets the frame rate display color.
/fpscolor 3

/fps <x:coord>,<y:coord>

Sets the location of the frame rate display.

Example
Set the display at (10, 200) on the screen.
/fps 10,200

Top Level Objects

All of the top level objects are root objects with no sub elements (aside from the default primitive properties/methods for int/bool types)

int FPS

Returns the frame per second as an integer.

Example
${FPS}

int MaxFPS

Returns the maximum frame per second limiter you’ve set, as an integer.

Example
${MaxFPS}

bool Foreground

Returns a TRUE/FALSE for if this window is in the foreground.

Example
${Foreground}