RumbleStats

From Robowiki
Revision as of 05:01, 27 March 2013 by Voidious (talk | contribs) (update sample and description)
Jump to navigation Jump to search

A MediaWiki extension by Voidious that leverages the API access (append &api=True to URLs) on Skilgannon's LiteRumble instance to make it really easy to include rumble stats in your version history.

Example use and output

To use it for Diamond 1.8.22 in the General 1v1 RoboRumble, you'd do the following:

{{subst:rumblestats:roborumble|voidious.Diamond 1.8.22}}

The output for the above would render like this (with bold added around the above tag):

RoboRumble ‒ APS: 90.33% (2nd), PL: 984-1 (2nd), Survival: 97.95%

The ranks are calculated dynamically, based on where the scores would put the bot in the current rankings (ignoring other versions of the same bot).

Parameters

The first parameter is the rumble category, which can be any of:

  • 1v1 Rumbles: roborumble, minirumble, microrumble, nanorumble
  • Melee Rumbles: meleerumble, minimeleerumble, micromeleerumble, nanomeleerumble
  • Team Rumble: teamrumble
  • Twin Duel Rumble: twinduel

The second parameter is the full bot name and version, such as would be put on the RoboRumble/Participants page.

Templates

By default, the extension uses Template:RumbleStatsDefault, which is formatted as shown above. You can create your own formats, as well. Check out Category:RoboRumble Stats to find out how, and to browse existing templates.

Important usage note!

Please be sure to add the "subst:" tag when using this, otherwise it will be querying the RR server for the stats every time the page loads. Also, be mindful when doing repeated previews of a page after you insert this tag, as it will query the RR server every time until you submit. The RR Query API has some modest rate limits, so if this gets too much use in a short timeframe, the tag will just render an error string and you'll have to try again later.