deleomike / clue-less

Clue-Less

   ______ __                     __                    
  / ____// /__  __ ___          / /   ___   _____ _____
 / /    / // / / // _ \ ______ / /   / _ \ / ___// ___/
/ /___ / // /_/ //  __//_____// /___/  __/(__  )(__  ) 
\____//_/ \__,_/ \___/       /_____/\___//____//____/  

This project is using the fastapi framework in addition to click for providing an clue-less game that can be played in the terminal and on your browser.

Project Structure

clueless is our project root

pyproject.toml defines our project's requirements.

clueless/main.py defines the entry points for the application, namely:

• The terminal entry point clue play
• The web serving command clue serve

clueless/app contains all the application logic including

• The fastapi webapp definitions
• Web app logic including UI/UX
• Core logic

clueless/app/core contains all the core game logic such as

• Game Loop
• Characters
• Players
• Rooms

Getting Started

Make sure you have at least python 3.9 installed.

python --version

Make a virtual environment

python -m venv venv
. ./venv/bin/activate

Install dependencies

pip install .

Alternative Setup (Later in Project)

When we get to deploying the stack we may want to use docker.

To build and stand up the stack following the steps. (Must have docker and docker compose installed).

docker compose build

Standup

docker compose up

Playing the game

Terminal

Run the following command

clue play

On your browser

clue serve

Alternatively, you can use docker

docker compose up --build

Instructions

Authentication

The Clue-less stack now uses a user authentication system via fastapi-users. Generally users will need to register and login. The frontend will need to keep the session information when logged in. The general process for testing this is:

1. Stand up the stack with the prior instructions.
2. Visit the docs page at http://0.0.0.0:80/docs
3. Register for a new account at http://0.0.0.0/docs#/auth/register_register_api_auth_register_post
   1. Provide a username (email) and password)
4. Log in to the docs by clicking on the authorization button at the top of the page.
   1. Provide your username and password. You don't need to provide anything else.
5. You are now authenticated and logged in to the docs, you can test the endpoints now.

graph TD;
    Register-->Login;
    Login-->ClueLess_Code;

Loading

Authenticating with a request

When the user logs in, the following payload

{
   "username": "[email protected]",
   "password": "password"
}

is sent to /api/auth/login/jwt/login as a POST REQUEST

You will receive a response

{
  "access_token": "<TOKEN>",
  "token_type": "bearer"
}

Use this token to authenticate when sending requests to the backend

headers = {
    'Authorization': 'Bearer <TOKEN>',
}

Rooms

Games are centered around game rooms. They're basically a lobby for you to wait in before your game starts.

Creating a room

1. Stand up the stack with the prior instructions.
2. Visit the docs page at http://0.0.0.0:80/docs
3. Log in to the docs by clicking on the authorization button at the top of the page.
   1. Provide your username and password. You don't need to provide anything else.
4. Visit the create room doc. http://0.0.0.0/docs#/room/create_room_api_room__post
   1. Click Try it out
   2. Create a room with the payload of: and send

{
  "name": "My Game"
}

5. You will receive the response

{
  "name": "My Game",
  "player_limit": 6,
  "is_started": false,
  "host": "f4b8215d-5e3d-4444-9228-e0e5da5fad09",
  "id": "a943d563-828b-414e-98a5-dd37828770dd",
  "room_key": "pVn6",
  "users": [
    "f4b8215d-5e3d-4444-9228-e0e5da5fad09"
  ]
}

6. Visit the rooms UI page to see your room. http://0.0.0.0/rooms

graph TD;
    Login-->Create_Room;
    Login-->Join_Room;

Loading

Joining a room

1. Stand up the stack with the prior instructions.
2. Visit the docs page at http://0.0.0.0:80/docs
3. Log in to the docs by clicking on the authorization button at the top of the page.
   1. Provide your username and password. You don't need to provide anything else.
4. Visit the join room doc. http://0.0.0.0/docs#/room/join_game_api_room___id__join__post
   1. Click Try it out
   2. Provide the room key or ID
5. You will have joined the room

clue-less's Issues

Implement Dummy Core Game Loop

Create Databases

Create databases for the list of rooms, players, and weapons

Webpage Displays Whose Turn It Is

User Feedback In Terminal

When a user initiates the local play with

clue play

It will start the game play loop. Create a set of prompts that bring the player through dummy functions of

1. Game Setup
2. Game Waiting
3. Game Play

Webpage Prompts for Suggestion

If the player is making a suggestion, the webpage prompts the user for their character and weapon choice, then displays if they guessed correctly.

Skeletal - Determine How to Host Website

Determine what will be used to host the server for the Clue-Less website.

Database/Data Type Updates During Gameplay

Update databases and data types given the players moves during their turns

Skeletal - List of Available Rooms

See list of rooms available.

Will this be necessary if we're only joining games based on the generated Room ID?

Skeletal - Select Username

Room options for selecting username

Skeletal - Determine Programming Language(s)

Get final confirmation of the programming language(s) to be used for the project.

Right now it looks like it will be Python and HTML.

Skeletal - Database or In-Memory ORM of Game Session

Webpage Prompts Action

Webpage prompts the user for their selection of what action they want to make on their turn

Skeletal - Publish Updates to Webpage

Publish updates webpage to server and test multiplayer synchronization is working

Webpage Prompts for Accusation

If a player makes an accusation, the webpage prompts them for their character, weapon, and room choice, then displays if they are correct or not. If the player is correct, they will be declared victorious. If the accusation is incorrect, the player will be eliminated from the game.

Publish Updates During Gameplay

Publish updates from webpage to server and test multiplayer synchronization is working

Skeletal - Dockerize

Dockerize and/or containerize the project

Skeletal - Create Basic Webpage

Create the webpage and backend with a “new game” button that generates a unique Room ID code.

Create Data Structures Representing Game Pieces

Skeletal - Update Webpage and Backend

Update webpage and backend with a textbox input and “Join Game” button that allows a second through sixth player(s) to input that unique Room ID and join an existing game. (Reject more than limit).

Create Text-Based Display of Game Board

Skeletal - Publish Webpage

Publish webpage to server such that one player could see and use current buttons and functionality

Skeletal - Create AWS Project

Create an AWS project for Clue-Less

Interface Front End of Player Statuses with Database to Display Accurately

Skeletal - Leave Joined Game

Room option for leaving the game