View on GitHub

LynxBot

A Twitch.tv IRC bot for Old School Runescape

Download this project as a .zip file Download this project as a tar.gz file

cml(1) - LynxBot manual

NAME

cml - interact with crystalmathlabs trackers

SYNOPSIS

$cml [-s|-v]
$cml [-nu] RSN
$cml -t [-c AMT] [-p PERIOD] SKILL

DESCRIPTION

cml is used to interact with players' Crystal Math Labs trackers.

Without any arguments, cml links to the CML homepage.

Alternatively, if RSN is given, cml will link to that player's CML page.

The -u option makes cml update the given player's tracker.

The -t option looks up the current top players for a given skill and period. Defaults to 5 players and 1 week.

As with all commands taking a RSN, the period . and the -n option can be used to access stored RSNs.

OPTIONS

-c, --count=AMT
with -t: display AMT players (between 1 and 7)
--help
print brief description and usage information
-n, --nick
search using a Twitch nick rather than a RSN. When set, the argument RSN is interpreted as a Twitch username and its corresponding RSN is looked up.
-p, --period=PERIOD
with -t: show current top players for PERIOD. Can be day, week or month.
-s, --supplies-calc
link to the CML supplies calc
-t, --current-top
look up current top players in SKILL
-u, --update
update the CML tracker of the player RSN
-v, --virtual-hiscores
link to the CML supplies calc

EXAMPLES

Posts a link the CML homepage:

$cml

Posts a link to Lynx Titan's CML page:

$cml lynx_titan

Posts a link to the CML page of the account associated with the Twitch user zoydbergrs

$cml -n zoydbergs

Updates the CML tracker of the command user:

$cml -u .

Updates the CML tracker of the account associated with the Twitch user randalicious:

$cml -nu randalicious

Displays the 5 current top players in Farming this week:

$cml -t farming

Displays the 3 top players in EHP this month:

$cml -t -c 3 -p month ehp

SEE ALSO

ehp(1), rsn(1), RSN Management(3)