Spaces:
Running
Running
Documentation and Version Update
Browse files- README.md +2 -1
- battlewords/__init__.py +1 -1
- specs/requirements.md +1 -1
- specs/specs.md +2 -0
README.md
CHANGED
|
@@ -33,6 +33,7 @@ BattleWords is a vocabulary learning game inspired by classic Battleship mechani
|
|
| 33 |
- Overlapping words on shared letters (Beta)
|
| 34 |
- Daily and practice modes (Full)
|
| 35 |
- Leaderboards, persistence, and advanced features (Full)
|
|
|
|
| 36 |
|
| 37 |
## Installation
|
| 38 |
1. Clone the repository:
|
|
@@ -82,7 +83,7 @@ streamlit run app.py
|
|
| 82 |
1. Click grid squares to reveal letters or empty spaces.
|
| 83 |
2. After revealing a letter, enter a guess for a word in the text box.
|
| 84 |
3. Earn points for correct guesses and bonus points for unrevealed letters.
|
| 85 |
-
4. The game ends when all six words are found. Your score tier is displayed
|
| 86 |
|
| 87 |
## Development Phases
|
| 88 |
|
|
|
|
| 33 |
- Overlapping words on shared letters (Beta)
|
| 34 |
- Daily and practice modes (Full)
|
| 35 |
- Leaderboards, persistence, and advanced features (Full)
|
| 36 |
+
- **Game ends when all words are guessed or all word letters are revealed**
|
| 37 |
|
| 38 |
## Installation
|
| 39 |
1. Clone the repository:
|
|
|
|
| 83 |
1. Click grid squares to reveal letters or empty spaces.
|
| 84 |
2. After revealing a letter, enter a guess for a word in the text box.
|
| 85 |
3. Earn points for correct guesses and bonus points for unrevealed letters.
|
| 86 |
+
4. **The game ends when all six words are found or all word letters are revealed. Your score tier is displayed.**
|
| 87 |
|
| 88 |
## Development Phases
|
| 89 |
|
battlewords/__init__.py
CHANGED
|
@@ -1,2 +1,2 @@
|
|
| 1 |
-
__version__ = "0.1.
|
| 2 |
__all__ = ["models", "generator", "logic", "ui"]
|
|
|
|
| 1 |
+
__version__ = "0.1.1"
|
| 2 |
__all__ = ["models", "generator", "logic", "ui"]
|
specs/requirements.md
CHANGED
|
@@ -81,7 +81,7 @@ Acceptance: Generator returns a valid `Puzzle` passing validation checks (no col
|
|
| 81 |
- If incorrect: no points awarded.
|
| 82 |
- After any guess, set `can_guess=False` and require another reveal before next guess.
|
| 83 |
- Streamlit: `with st.form("guess"):` + `st.text_input("Your guess", key="guess_text")` + `st.form_submit_button("OK", disabled=not st.session_state.can_guess)`; after guess, call `st.rerun()`.
|
| 84 |
-
- End of game when all 6 words are guessed; display summary and tier, then `st.stop()
|
| 85 |
|
| 86 |
Acceptance: Unit tests cover scoring, guess gating, and reveal behavior.
|
| 87 |
|
|
|
|
| 81 |
- If incorrect: no points awarded.
|
| 82 |
- After any guess, set `can_guess=False` and require another reveal before next guess.
|
| 83 |
- Streamlit: `with st.form("guess"):` + `st.text_input("Your guess", key="guess_text")` + `st.form_submit_button("OK", disabled=not st.session_state.can_guess)`; after guess, call `st.rerun()`.
|
| 84 |
+
- **End of game when all 6 words are guessed or all word letters are revealed; display summary and tier, then `st.stop()`.**
|
| 85 |
|
| 86 |
Acceptance: Unit tests cover scoring, guess gating, and reveal behavior.
|
| 87 |
|
specs/specs.md
CHANGED
|
@@ -20,6 +20,7 @@ Battlewords is inspired by the classic Battleship game, but uses words instead o
|
|
| 20 |
- After revealing a letter, players may guess a word by entering it in a text box.
|
| 21 |
- Guess submission triggers an immediate rerun to reflect results.
|
| 22 |
- Only one guess per letter reveal; must uncover another letter before guessing again.
|
|
|
|
| 23 |
|
| 24 |
## Scoring
|
| 25 |
- Each correct word guess awards points:
|
|
@@ -29,6 +30,7 @@ Battlewords is inspired by the classic Battleship game, but uses words instead o
|
|
| 29 |
- Good: 34-37
|
| 30 |
- Great: 38-41
|
| 31 |
- Fantastic: 42+
|
|
|
|
| 32 |
|
| 33 |
## POC (0.1.0) Rules
|
| 34 |
- No overlaps: words do not overlap or share letters.
|
|
|
|
| 20 |
- After revealing a letter, players may guess a word by entering it in a text box.
|
| 21 |
- Guess submission triggers an immediate rerun to reflect results.
|
| 22 |
- Only one guess per letter reveal; must uncover another letter before guessing again.
|
| 23 |
+
- **The game ends when all six words are guessed or all word letters are revealed.**
|
| 24 |
|
| 25 |
## Scoring
|
| 26 |
- Each correct word guess awards points:
|
|
|
|
| 30 |
- Good: 34-37
|
| 31 |
- Great: 38-41
|
| 32 |
- Fantastic: 42+
|
| 33 |
+
- **Game over is triggered by either all words being guessed or all word letters being revealed.**
|
| 34 |
|
| 35 |
## POC (0.1.0) Rules
|
| 36 |
- No overlaps: words do not overlap or share letters.
|