will2dye4/jeopardy

Command-line client and server for Jeopardy!

jeopardy

Dedication

This project is dedicated to Mr. William D. Dye, my father and one of the best armchair Jeopardy! players I have ever known.

Installing

$ make install

Running the server

$ jeopardyd [-s <server_ip>] [-p <server_port>]

or:

$ python3.7 jeopardy/server.py [-s <server_ip>] [-p <server_port>]

Options

• -s, --server-address - the IP address on which to run the server
• -p, --port - the port on which to run the server

Running the client

$ jeopardy -n <nick> -s <server_address> [-c <client_ip>] [-p <client_port>] [-d]

or:

$ python3.7 -m jeopardy -n <nick> -s <server_address> [-c <client_ip>] [-p <client_port>] [-d]

or:

$ python3.7 jeopardy/main.py -n <nick> -s <server_address> [-c <client_ip>] [-p <client_port>] [-d]

Options

• -n, --nickname - the nickname to use (must be unique)
• -s, --server-address - the address and port of the remote server to connect to
• -c, --client-address - the IP address for the server to connect to in order to send events (defaults to the external IP address of the host running the client)
• -p, --client-port - the port for the server to connect to in order to send events
• -d, --dark-mode - use the dark theme in the GUI

You only need to specify -n, -s, and -p once, or if you want to change them. Otherwise, the previously-used value will be used on the next invocation of the program.

jeopardy's Issues

Enhance answer parsing

• "alone/a loan"
  • "alone or a loan"
  • "alone and a loan"
  • "alone & a loan"
  • "a loan or alone"
  • "a loan and alone"
  • "a loan & alone"
• "one of: apples, oranges, pears"
  • "apples"
  • "oranges"
  • "pears"
• etc...

Add question status indicator

• Active question or no
• Time remaining

Add type hints

Enforce max length for nicks, chats and answers

Add logging to server side

Allow passing on a question if all players agree

Add menu option to toggle players/stats pane

Add timeouts to HTTP requests

Add menu option to toggle dark mode

Show images inline

Instead of ignoring image links, parse them out and display them inline.

Rewrite client and server to use WebSockets

Improve documentation

• readme
• help text
• docstrings

Track daily/weekly scores in addition to overall scores

Investigate whether emoji are supported in tkinter

Create event handler abstract base class

CLI and GUI can extend from this base class.

Goals:

• deduplicate logic
• make the API for being an event handler explicit

Add logging to client side

• HTTP client
• GUI
• CLI

Investigate implementing a "Daily Double" feature

If a question is worth $0, let the last person to answer a question correctly make a wager and have exclusive rights to answer the question.

Optional bonus feature: Allow other players to answer privately while the selected player is wagering/answering. If the selected player gets it wrong, the first player to submit the correct answer gets $X (for some value of X).

Fix black separator bar between stats pane and event pane

Seems to happen on Linux but not macOS.

Randomize correct/incorrect host responses

Fall back to standard fonts to ensure monospace

If Consolas is not available, check for Monaco, and default to Courier.

Fix issues with answer parsing/checking

• strip leading/trailing quotes
• strip leading/trailing whitespace
• lowercase everything
• replace special characters (e.g., "é") with standard versions (e.g., "e")

Add option to view detailed stats

Server should print the IP it is running on when it starts

If 0.0.0.0, look up the external IP and show that instead.

Add up-arrow functionality

Reinsert last value into the input field on up-arrow

Fix HTML parsing of answers

Currently, a regex is being used to find <a> tags inside the answers and remove them. However, a nested <b> or <i> tag (or any other tag) inside of the <a> tag breaks the parsing. Either use a proper HTML parser (such as beautifulsoup) or, at the very least, figure out a way to handle the case mentioned above.

Allow specifying client IP as an argument/environment variable

Question: Persist it to the config file?

Improvements to player activity tracking

• Add timeout to mark a player inactive after 30 minutes (configurable)
• If server fails to send events to a client N times, mark client as inactive

Add logic to display a message when joining based on whether you are the first player or not

For example, "Let's start a game!" vs. "Joining game already in progress..."

Use requests.Session objects in server

Use a session for each client?

Investigate/fix race conditions

Two players answering correctly, timeouts not happening immediately, etc.

Figure out how to handle keyboard shortcuts

Cmd+Q, Cmd+C, Cmd+V, etc.