Update README.md

This commit is contained in:
Gordon Shumway 2020-02-05 03:50:29 -05:00 committed by GitHub
parent 737f46418f
commit 9e47386813
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 6 deletions

View File

@ -1,15 +1,48 @@
Come play in ##Jeopardy on Freenode. irc://chat.freenode.net/##Jeopardy
## This... is... Jeopardy!
Uses [jService](http://jservice.io) (150K+ Jeopardy! questions, more if run locally) as a trivia source.
To run a local instance (190K+ questions, can add more questions as episodes continue to air) install [my jService fork](https://github.com/oddluck/jService) then point `plugins.jeopardy.jserviceUrl` to your own URL.
Fork of Trivia (https://github.com/ProgVal/Supybot-plugins/tree/master/Trivia) with option to use http://jservice.io (150K+ Jeopardy! questions, more if run locally) as trivia source plus additional features such as category selection, question history, and improved scoring and answer checking.
To run a local instance (190K+ questions) install my jservice fork from here https://github.com/oddluck/jService then point `plugins.jeopardy.jserviceUrl` to your own URL.
## Commands
```
start --num (int) <category> (optionally specify number of questions or category name or ID#)
start [--num <int>] [--shuffle] [--no-hints] [category1, category2, etc,]
```
calling start a second time will add additional questions to the queue.
Calling the `start` command by itself will yield a round of random questions. Adding category names after the start command will search for specific categories by name. Calling start while a game is running will add additional questions to the queue. Use `--shuffle` to randomize question order. Use `--no-hints` to disable hints for the round.
```
categories | return a list of popular Jeopardy! categories and their IDs
categories
```
Returns a list of popular Jeopardy! categories.
```
stats [--top <int>] [nick]
```
Returns game scores. Defaults to top 5 players. Use `--top` and a number to receive more top players. Specify a nick to get a score for the selected player.
```
question
```
Repeat the currently active question.
```
hint
```
Repeat the current hint.
## Config
```
config list plugins.jeopardy
```
List the config variables for the game.
```
config help plugins.jeopardy.<variable_name>
```
Get information about what game options the variable controls.