3
0
mirror of https://github.com/reality/dbot.git synced 2024-12-24 03:33:07 +01:00

Various README.md's and cleanups

This commit is contained in:
thoso 2014-02-20 06:06:02 +01:00
parent d1b72fe443
commit b369ce3a0c
16 changed files with 433 additions and 12 deletions

View File

@ -9,17 +9,20 @@ This module provides a command which allows users to foobar.
### Dependencies
It has following dependencies:
node-wolfram : https://github.com/strax/node-wolfram
+ [foo](link)
### config.json
foo
```
```
### Commands
#### ~foo [(bar]
Example:
~foo bar
+ ~foo bar
### TODO

32
modules/imdb/README.md Normal file
View File

@ -0,0 +1,32 @@
## IMDB
Adds various IMDB functionalities.
### Description
This module provides a command which allows users to search IMDB for a movie.
### Dependencies
It has following dependencies:
+ [request](https://github.com/mikeal/request)
### config.json
output prefix can be set.
```
{
"outputPrefix": "\u00033IMDB\u000f"
}
```
### Commands
#### ~imdb [movie]
Searches IMDB for a movie.
Example:
+ ~imdb Fear and Loathing in Las Vegas
### TODO

66
modules/lastfm/README.md Normal file
View File

@ -0,0 +1,66 @@
## LastFM
Adds various LastFM functionalities.
### Description
This module provides a command which allows users to show stats of LastFM and such stuff.
### Dependencies
It has following dependencies:
+ [request](https://github.com/mikeal/request)
+ [async](https://github.com/caolan/async)
+ [moment](https://github.com/moment/moment)
### config.json
api_key and output prefix can be set.
Example:
```
{
"dependencies": [ "profile" ],
"api_key": "blah",
"outputPrefix": "\u000315,5last.fm\u000f"
}
```
### Commands
#### ~lastfm [user]
Display all scrobbles of a user.
Example:
+ ~lastfm reality
#### ~scrobbliest
Displays the users with the most scrobbles.
Example:
+ ~scrobbliest
#### ~suggestion
Displays a suggestion based on the listened scrobbles.
Example:
+ ~suggestion
#### ~listening
Displays the currently/last played song of the posting user.
Example:
+ ~listening
#### ~taste [user]
Compares two users (the posting user and the defined user).
Example:
+ ~taste reality
#### ~tastiest
Displays the users that matches the most in music taste.
Example:
+ ~tastiest
#### ~artists [user]
Compares two users (the posting user and the defined user) and displays their matching artists.
Example:
+ ~artists reality
### TODO

28
modules/radio/README.md Normal file
View File

@ -0,0 +1,28 @@
## TODO
bar.
### Description
This module provides a command which allows users to foobar.
### Dependencies
It has following dependencies:
+ [foo](link)
### config.json
foo
```
```
### Commands
#### ~foo [(bar]
Example:
+ ~foo bar
### TODO

View File

@ -0,0 +1,33 @@
## Souncloud
Adds various Soundcloud functionality.
### Description
This module provides a command which allows users to search Soundcloud for a song.
### Dependencies
It has following dependencies:
+ [request](https://github.com/mikeal/request)
### config.json
client_id and output prefix can be set.
```
{
"client_id": "CLIENT _ID_HERE,
"outputPrefix": "\u000307soundcloud\u000f",
"dependencies": [ "link" ]
}
```
### Commands
#### ~soundcloud [song]
Searches Soundcloud for a song.
Example:
+ ~soundcloud TNGHT
### TODO

83
modules/sstats/README.md Normal file
View File

@ -0,0 +1,83 @@
## sstats
Adds various stats functionality.
### Description
This module provides a command which allows users to print stats, such as how many words etc..
### Dependencies
It has following dependencies:
+ [async](https://github.com/caolan/async)
### config.json
database type and curses can be set.
```
{
"dbType": "redis",
"dependencies": [ "users" ],
"curses": [ "s***", "f***" ]
}
```
### Commands
#### ~words [user]
Displays how many words a user wrote.
Example:
+ ~words reality
#### ~lines [user]
Displays how many lines a user wrote.
Example:
+ ~lines reality
#### ~loudest [channel]
Displays the users with the most lines written.
Example:
+ ~loudest #tripsit
#### ~uncouth [channel]
Displays the users with the most curses written.
Example:
+ ~uncouth #tripsit
#### ~shoutiest [user]
Displays the users with the most capital words written.
Example:
+ ~shoutiest #tripsit
#### ~wordiest [channel]
Displays the users with the most words written.
Example:
+ ~wordiest #tripsit
#### ~clines [user]
Displays how many lines a user wrote in all channels.
Example:
+ ~clines reality
#### ~last [user]
Displays when the user was last seen.
Example:
+ ~last reality
#### ~trackword [word]
Adding a word to being tracked.
Example:
+ ~trackword derp
#### ~word [word]
Displays how often a word was written in all channels.
Example:
+ ~word derp
#### ~wordusers [word]
Displays how often and by whom a word was written.
Example:
+ ~wordusers derp
### TODO

View File

@ -2,4 +2,4 @@
"dbType": "redis",
"dependencies": [ "users" ],
"curses": [ "shit", "piss", "fuck", "cunt", "cocksucker", "motherfucker", "tits" ]
}
}

42
modules/steam/README.md Normal file
View File

@ -0,0 +1,42 @@
## Steam
Adds various steam functionalities.
### Description
This module provides a command which allows users to seek and compare games inside the Steam library.
### Dependencies
It has following dependencies:
+ [request](https://github.com/mikeal/request)
### config.json
api_key and output prefix
For example:
```
{
"api_key": "bleh",
"outputPrefix": "\u00033steam\u000f"
}
```
### Commands
#### ~games [user]
Seeks the games of a user. If left blank, the posting users games will be displayed.
Example:
+ ~games reality
+ ~games
#### ~playing [user]
Displays the currently/last played game of a user. If left blank, the posting users game will be displayed.
Example:
+ ~playing reality
+ ~playing
### TODO

View File

@ -1,4 +1,4 @@
{
"api_key": "bleh",
"outputPrefix": "\u00033steam\u000f"
}
}

View File

@ -8,8 +8,10 @@ This module provides a command which allows users to convert units into another
unit given the international character of networks. Converts time, distance,
mass, volume and digital values.
### Dependencies
It has following dependencies:
node-units : https://github.com/brettlangdon/node-units
+ [node-units](https://github.com/brettlangdon/node-units)
### Commands
@ -21,4 +23,4 @@ Example:
### TODO
Currency Conversion
+ Currency Conversion

33
modules/warning/README.md Normal file
View File

@ -0,0 +1,33 @@
## Warning
Adds functionality to warn a user.
### Description
This module provides commands which allows power users to warn another user.
### Dependencies
It has following dependencies:
+ [node-uuid](https://github.com/broofa/node-uuid)
### config.json
foo
```
```
### Commands
#### ~warn [user]
Warning a user.
Example:
+ ~warn reality
#### ~warnings [user]
Getting info of all warnings.
Example:
+ ~warnings reality
### TODO

View File

@ -6,20 +6,28 @@ Calculates whatever you want.
This module provides a command which allows users to calculate whatever they want.
It has following dependencies:
node-wolfram : https://github.com/strax/node-wolfram
### Dependencies
### appID
It has following dependencies:
+ [node-wolfram](https://github.com/strax/node-wolfram)
### config.json
This module is ignorable.
appID has to be added into config.json. It can be obtained at
http://products.wolframalpha.com/developers/ for free.
`{
"ignorable": true,
"appID": "APP_ID_HERE"
}`
### Commands
#### ~calculate [(whatever)]
Example:
~calculate (2+2)
~calculate (x^2+2x+4)
+ ~calculate (2+2)
+ ~calculate (x^2+2x+4)
### TODO

41
modules/words/README.md Normal file
View File

@ -0,0 +1,41 @@
## words
Adds various functionality for words.
### Description
This module provides commands which allows users to have various functionality for words,
such as defining, getting the etymology and jimble the letters.
To achieve that, this module seeks the wordnik database.
### Dependencies
It has following dependencies:
+ [node-wordnik](https://github.com/cpetzold/node-wordnik)
### config.json
api_key : most likely the wordnik developer homepage
### Commands
#### ~define [word]
Seeks wordnik database and replys with a definition.
Example:
+ ~define Spaghetti
#### ~etymology [word]
Seeks wordnik database and replys with its etymology.
Example:
+ ~etymology Spaghetti
#### ~jimble [word]
Jimbles the letters of a word.
Example:
+ ~jimble Spaghetti
### TODO

View File

@ -1,3 +1,3 @@
{
"api_key": "http://developer.wordnik.com/"
}
}

View File

@ -8,3 +8,20 @@ This module occasionally comes back and says "You're a x" when somebody goes "y
is x" or "y are x," with the intention of annoying people who are calling
something crap. Warning: this module occasionally causes the bot to be nice to
people.
### Dependencies
It has no dependencies.
### config.json
This module is ignorable.
```
{
"ignorable": true
}
```
### Commands
none.

33
modules/youtube/README.md Normal file
View File

@ -0,0 +1,33 @@
## Youtube
Searches youtube.com for videos.
### Description
This module provides a command which allows users to search for a video on youtube.com.
It replies with a video thats title is the most similar to the input.
### Dependencies
It has following dependencies:
+ [request](https://github.com/mikeal/request)
### config.json
Output prefix can be set.
For example:
```
{
"outputPrefix": "\u00031,0You\u000315,5Tube\u000f"
}
```
### Commands
#### ~youtube [title]
Example:
+ ~youtube Hello World!
### TODO