Skip to content

Commit 7f92243

Browse files
Merge pull request #162 from ufosc/NeedToLookAtMyPictures-patch-2
Revise README with project updates and roadmap
2 parents 4144158 + 9204ed1 commit 7f92243

File tree

1 file changed

+9
-19
lines changed

1 file changed

+9
-19
lines changed

README.md

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Welcome to Terminal Casino
22

3-
This is a set of casino games all in terminal. Multiplayer and item stores will eventually be added. This is a 100% Python project.
4-
All games will follow their American rules first.
3+
This is a set of casino games all in the Terminal. This is a 100% Python project.
4+
We primarily use the official [OSC Discord](https://discord.gg/qAGudju6) to communicate.
55

66
## How to Contribute
77
1. Find an issue to work on
@@ -12,26 +12,16 @@ All games will follow their American rules first.
1212
* If you want to work on an issue in collaboration with multiple OSC members, be careful not to submit overlapping PRs.
1313

1414
## How to Run
15-
1. Open terminal
15+
1. Open Terminal
1616
2. cd into your TERMINALCASINO folder
17-
3. To run the program:
17+
3. Execute the following command to run the program:
1818
```
1919
python -m casino.main
2020
```
2121

22-
## Current Task
22+
## Roadmap
2323

24-
Current milestone is a working single player blackjack.
25-
26-
#### Missing
27-
28-
Splits, double down, insurance, betting/payout, themes
29-
30-
#### Additional Goals
31-
Clean up blackjack_animations.py into a structured file format.
32-
33-
#### Future Goals
34-
Add card slide animations for initial decks and hits.
35-
36-
#### Project Requirements / Design Document
37-
https://docs.google.com/document/d/1ewN4baNegzGZweMzRXMcEzH38dWIzm8h-eUV6gS6xZc/edit?usp=sharing
24+
1. Documentation: continue to update the new docs/ folder with technical explanations of the games (keyed towards developers, not users)
25+
2. OOP Overhaul: spring-boards off of documentation, we will release a blackjack/template doc shortly (as blackjack is now fully OOP) that contributors can use as inspiration when overhauling the remaining games. For future feature development, it's important that the games are modular, readable, and logically structured.
26+
3. [Textual](https://textual.textualize.io) Overhaul: Textual is an incredibly powerful terminal UI library. Kevin and I feel that switching to this will make Terminal Casino resemble a professional project, not to mention features of [tabs](https://textual.textualize.io/widget_gallery/#tabs), [loading bars](https://textual.textualize.io/widget_gallery/#loadingindicator), and other [widgets](https://textual.textualize.io/widget_gallery), which will all vastly improve the user experience. What's incredible about Textual is that it will make our UI workflow far simpler. Everything we need will be inside one library instead of being triaged across multiple.
27+
4. Multiplayer: P2P multiplayer sessions. We're still discussing possible remote-networking solutions, but at the very least, multiplayer across the same Wi-Fi network will be possible.

0 commit comments

Comments
 (0)