PsychoticNinja/oddluck-limnoria-plugins
1
0
Fork 0
mirror of https://github.com/oddluck/limnoria-plugins.git synced 2025-04-25 12:31:07 -05:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
oddluck 2020-03-02 16:18:35 +00:00
parent 2fe7d26b9f
commit 1b9a885a20
5 changed files with 59 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
IMDb/README.md
View File

@ -1,9 +1,37 @@
Information about IMDb titles from the OMDB API.
Forked from https://github.com/butterscotchstallion/limnoria-plugins/tree/master/IMDB
Obtain an [OMDB API Key](https://omdbapi.com/apikey.aspx)
https://omdbapi.com/apikey.aspx
```
config plugins.IMDb.omdbAPI (your_api_key)
```
`config plugins.imdb.omdbAPI your_key_here`
`config plugins.imdb.googleSearch True/False` enable/disable google searches
`config plugins.imdb.template` change the reply template
Default template:
`\x02\x031,8 IMDb \x0F\x02 :: $title ($year, $country, [$rated], $genre, $runtime) :: IMDb: $imdbRating | MC: $metascore | RT: $tomatoMeter :: http://imdb.com/title/$imdbID :: $plot :: Director: $director :: Cast: $actors :: Writer: $writer`
Variable | Description
---------------|------------
title | Movie title
year | Release year
country | Country
director | Director
plot | Plot
imdbID | IMDB tile ID#
imdbRating | IMDB rating
metascore | Metacritic score
released | Release date
genre | Genre
awards | Awards won
actors | Actors
rated | Rating
runtime | Runtime
writer | Writer
votes | Votes
website | Website URL
language | Language
boxOffice | Box Office
production | Production company
poster | Poster URL

10
Lyrics/README.md
View File

@ -1,11 +1,3 @@
Limnoria plugin to return song lyrics from http://lyrics.wikia.com/
load plugindownloader
install oddluck Lyrics
cd /your_bot_directory/plugins/Lyrics
pip install -r requirements.txt
load lyrics
`config plugins.lyrics.googleSearch True/False` enable/disable google searches

4
README.md
View File

@ -11,6 +11,10 @@ Easy installation:
load PluginDownloader<br />
repolist oddluck<br />
install oddluck PluginName<br />
cd <YourBotDirectory>/plugins/<PluginName><br />
python3 -m pip install -r requirements.txt --upgrade<br />
load PluginName<br />
See README files in plugin directories for additional information and instructions.
gitlab mirror: https://gitlab.com/oddluck/limnoria-plugins

6
Weed/README.md
View File

@ -1,5 +1,5 @@
Fetch cannabis (marijuana) strain information from the strain api (strains.evanbusse.com)
Fetch cannabis (marijuana) strain information.
obtain an api key from http://strains.evanbusse.com/
obtain a [Strain API key](http://strains.evanbusse.com/)
config plugins.weed.strain_api your_key_here
`config plugins.weed.strain_api your_key_here`

38
WordGames/README.md
View File

@ -27,10 +27,10 @@ Commands
The following commands are exposed by this plugin:
`worddle [easy|medium|hard|evil | stop|stats]`
`boggle [easy|medium|hard|evil | stop|stats]`
> Play a Worddle game. With no argument, a new game will start with the
> default difficulty (see worddleDifficulty in the Configuration section).
> Play a game of Boggle. With no argument, a new game will start with the
> default difficulty (see boggleDifficulty in the Configuration section).
> If a game is already started, you will join the game in progress.
>
> In addition, you may use the following subcommands:
@ -58,11 +58,11 @@ The following commands are exposed by this plugin:
Game Rules
----------
### Worddle
### Boggle
Worddle is a clone of a well-known puzzle game involving a 4x4 grid of
randomly-placed letters. It's a timed, multiplayer game where you compete
to find words that your opponents didn't find.
Boggle is a well-known puzzle game involving a 4x4 grid of randomly-placed
letters. It's a timed, multiplayer game where you compete to find words that
your opponents didn't find.
When you start a new game, or join an existing game, the bot will send you a
private message indicating that you are playing. All your guesses must be
@ -148,41 +148,37 @@ Configuration Variables
>
> Default: `^[a-z]+$`
`plugins.Wordgames.worddleDelay`
`plugins.Wordgames.boggleDelay`
> The length (in seconds) of the pre-game period where players can join a
> new Worddle game.
> new Boggle game.
>
> Default: `15`
`plugins.Wordgames.worddleDuration`
`plugins.Wordgames.boggleDuration`
> The length (in seconds) of the active period of a Worddle game, when
> The length (in seconds) of the active period of a Boggle game, when
> players can submit guesses.
>
> Default: `90`
`plugins.Wordgames.worddleDifficulty`
`plugins.Wordgames.boggleDifficulty`
> The default difficulty for a Worddle game.
> The default difficulty for a Boggle game.
>
> Default: `easy` (words must be 3 letters or longer)
A Technical Note About Worddle
A Technical Note About Boggle
------------------------------
This game sends a lot of PRIVMSGs (between the channel and all the players,
the messages add up). It attempts to send them in a single PRIVMSG if
possible to combine targets.
Supybot: I run Supybot with the latest git (there are show-stopper bugs in
0.83.4.1) and the Twisted driver (but Socket should work as well).
IRC Server: I had to tune my IRC server to handle this game, due to the large
amount of messages it sends. You may find that it has problems on your server
due to flood controls (bot may be either fake lagged or kicked from the
server). If the game seems extremely slow, it is either an old Supybot or the
server is throttling you.
server). If the game seems extremely slow, the server is throttling you.
I would like to add an option to tune the verbosity of the game to mitigate
this for restrictive servers.
@ -191,6 +187,8 @@ Credit
------
Copyright 2012 Mike Mueller <mike@subfocal.net>
Released under the WTF public license: http://sam.zoy.org/wtfpl/
Copyright 2020 oddluck <oddluck@riseup.net>
Released under the WTF public license
Thanks to Ben Schomp <ben@benschomp.com> for the inspiration and QA testing.