From 3849df921cbd2619be2c273d7701890f067be7f5 Mon Sep 17 00:00:00 2001 From: reality Date: Sun, 19 May 2013 10:48:24 +0000 Subject: [PATCH] update docs for imgur with web routes [#445] and config options [#352] --- modules/imgur/README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/modules/imgur/README.md b/modules/imgur/README.md index 7e08b5d..df9b800 100644 --- a/modules/imgur/README.md +++ b/modules/imgur/README.md @@ -7,6 +7,25 @@ Various imgur functionality. Posts information on imgur links which are pasted into the channel and provides functionality to generate a random imgur link. +### Config + +#### imagelength: 5 +Length of slugs generated by the random imgur functionality. + +#### nsfwwarn: true +Warn that images generated by the ~ri command may be NSFW. + +#### apikey +Key to use with the imgur API. + +#### highscore: ricount +Quote category to use for a 'highscore;' used to run games with the web +/random page, by storing a highscore based on some arbitrary rule in the +chosen quote category (say, how far can you get before seeing a turtle). Then, +on the imgur random page you can press 'c' to see a countdown towards the last +stored value in the highscore quote category. If you beat the highscore, simply +add the winning score to the quote category. + ### Commands #### ~ri @@ -28,6 +47,18 @@ imgur API. Callback is called with one argument, the info string. Return data from the imgur API on an image with the given slug. Callback is called with one argument, the information returned by the API. +### Web + +#### /imgur/random + +A web page which loads a random image from imgur. You can press the space bar to +load a new image, and information about the images are shown on the top-left of +the page. You can press 'c' to view a highscore count (as documented above). + +#### /imgur/stats + +Show statistics on the total use of the imgur module. + ### Hooks #### link