Update features.md

This commit is contained in:
Vutukuri15 2025-01-27 02:03:37 -08:00 committed by GitHub
parent 67b028c2c6
commit cd5219ac91
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,30 +1,43 @@
# Features
Contained here are a list of desired features for the application
#### Inputs:
Number of Players Picker:
Ability to select the number of players in the poker game (Range: 2 to 8).
Buy-in Amount Picker:
Ability to select the buy-in amount for the game.
Chip Colors and Counts Picker:
Ability to select and define chip colors and their corresponding counts.
##### Sub-Features:
Ability to pick the number of chip colors (Range: 1 to 5).
Dynamically display inputs for each chip color based on the selected number (1-5 colors).
For each selected color, an input for the number of chips can be specified.
#### Outputs:
Chip Distribution:
Display the number of each chip color to issue to each player.
Chip Value Display:
Display the value of each chip color.
#### Persistence:
State Persistence:
When the app is closed and reopened, retain the state (values) from the previous session.
Preset Storage:
Ability to save and load up to 3 preset calculator values.
#### Image Recognition:
Chip Recognition Feature:
Image recognition feature to automatically fill chip color and count fields by prompting the user to take a photo of the poker chips.
#### Stretch Goals:
Currency Selector:
Ability to change the currency symbol (e.g., $, €, £, etc.).
Language Selector:
Ability to change the application language (English and other commonly desired languages).
## Minimum Viable Product
#### The calculator
The primary feature of this app is a calculator with various Inputs and Outputs. These can be defined as sub-features
#### Inputs
- The ability to easily pick the number of players of the poker game in a range (2 to 8)
- The ability to easily pick the buy-in amount of the game
##### Chip colors and counts
The ability to pick the chip colors and counts are a dynamically present inter-dependent features
- The ability to pick the number of chip colors in a range (1 to 5)
- A dynamically ranged input should be shown for each chip color. When "1" is chosen, just white will be shown, and when "5" is chosen, then white, red, green, blue and black will be shown. The intuitive in-between states will appy.
When selecting one of these colors, the ability to set the number of chips will present.
#### Outputs
- The number of each chip to issue to each player will be shown
- The value of each color of each chip will be shown.
#### Persistance
- When the app is closed and then opened again, the calculator will present with the same state/values as when it was closed
- The user will have an ability to easily save and load 3 pre-set calculator values
#### Image recognition
- The ability to enter the chip color and counts will be made easier with an image recognition feature which attempts to automatically fill this data by prompting for a photo of the poker chips.
## Strech
- The user will be able to change the currency icon from **$** to some other common icons including €, £ and others
- The user will be able to change the application language from English to one or two other commonly desired languages