Documentation Update

README.md

@@ -29,12 +29,13 @@ BattleWords is a vocabulary learning game inspired by classic Battleship mechani
 - Reveal grid cells and guess words for points
 - Scoring tiers: Good (34–37), Great (38–41), Fantastic (42+)
 - Responsive UI built with Streamlit
+- Customizable word lists
 - Wordlist sidebar controls (picker + one-click sort)
 - Deterministic seed support (Beta/Full)
 - Keyboard navigation and guessing (Beta/Full)
-- Overlapping words on shared letters (Beta)
 - Daily and practice modes (Full)
 - Leaderboards, persistence, and advanced features (Full)
+- **Dockerfile-based deployment supported for Hugging Face Spaces and other container platforms**
 - **Game ends when all words are guessed or all word letters are revealed**
 
 ## Installation
@@ -67,6 +68,21 @@ or
 streamlit run app.py
 ```
 
+### Dockerfile Deployment (Hugging Face Spaces and more)
+
+BattleWords supports containerized deployment using a `Dockerfile`. This is the recommended method for deploying to [Hugging Face Spaces](https://huggingface.co/docs/hub/spaces-sdks-docker) or any Docker-compatible environment.
+
+To deploy on Hugging Face Spaces:
+1. Add a `Dockerfile` to your repository root (see [Spaces Dockerfile guide](https://huggingface.co/docs/hub/spaces-sdks-docker)).
+2. Push your code to your Hugging Face Space.
+3. The platform will build and run your app automatically.
+
+For local Docker runs:
+```sh
+docker build -t battlewords .
+docker run -p 8501:8501 battlewords
+```
+
 ## Folder Structure
 
 - `app.py` – Streamlit entry point
@@ -89,6 +105,22 @@ streamlit run app.py
 
 ## Changelog
 
+- 0.1.10
+  - Sidebar Game Mode selector: `standard` (allows guess chaining after correct guesses) and `too easy` (no chaining; score panel reveals words list).
+  - Replaced Hit/Miss with Correct/Try Again status indicator for guesses.
+  - UI polish: animated ocean background; metal-scope styled radar retained with session-cached GIF.
+  - Footer shows version info (commit, Python, Streamlit).
+  - Word list handling: defaults to `classic.txt` when present; selection persists across new games; sort action rewrites the file and restarts after 5s notice.
+  - Documentation updated.
+
+- 0.1.9
+  - Background naming cleanup and consistency.
+  - Version info surfaced in Settings panel.
+  - Mobile layout improvements.
+
+- 0.1.8
+  - Bumped runtime to Python 3.12 (and config/docs updated accordingly).
+
 - 0.1.5
   - Hit/Miss circular indicator.
   - Completed words render as non-interactive styled cells.
@@ -122,7 +154,9 @@ BattlewordsTM. All Rights Reserved. All content, trademarks and logos are copyri
 
 ## Hugging Face Spaces Configuration
 
-BattleWords is deployable as a Hugging Face Space. To configure your Space, add a YAML block at the top of your `README.md`:
+BattleWords is deployable as a Hugging Face Space. You can use either the YAML config block or a Dockerfile for advanced/custom deployments.
+
+To configure your Space with the YAML block, add it at the top of your `README.md`:
 
 ```yaml
 ---

battlewords/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "0.1.9"
+__version__ = "0.1.10"
 __all__ = ["models", "generator", "logic", "ui"]

specs/requirements.md

@@ -62,7 +62,7 @@ Acceptance: Types exist and are consumed by generator/logic; simple constructors
 - Streamlit: `st.cache_data` to memoize loading/filtering.
 - Loader is centralized in `word_loader.py` and used by generator and UI.
 
-Acceptance: Loading function returns lists by length with >= 500 words per length or fallback minimal lists.
+Acceptance: Loading function returns lists by length with >= 25 words per length or fallback minimal lists.
 
 3) Puzzle Generation (Placement)
 - Randomly place 2×4, 2×5, 2×6 letter words on a 12×12 grid.
@@ -84,7 +84,7 @@ Acceptance: Generator returns a valid `Puzzle` passing validation checks (no col
   - If correct: add base points = word length; bonus points = count of unrevealed cells in that word at guess time; mark all cells of the word as revealed; add to `guessed`.
   - If incorrect: no points awarded.
   - After any guess, set `can_guess=False` and require another reveal before next guess.
-  - Exception in 0.1.5: after a correct guess, another guess is allowed without a reveal (`can_guess=True`).
+  - Exception: in default mode a correct guess allows chaining (`can_guess=True`); other modes may disable chaining.
   - Streamlit: `with st.form("guess"):` + `st.text_input("Your guess")` + `st.form_submit_button("OK", disabled=not can_guess)`; after guess, call `st.rerun()`.
 - End of game when all 6 words are guessed or all word letters are revealed; display summary and tier, then `st.stop()`.
 
@@ -94,8 +94,8 @@ Acceptance: Unit tests cover scoring, guess gating, and reveal behavior.
 - Layout:
   - Title and brief instructions via `st.title`, `st.subheader`, `st.markdown`.
   - Left: 12×12 grid using `st.columns(12)`.
-  - Right: Animated radar, Hit/Miss indicator, guess form, and score panel.
-  - Sidebar: New Game, wordlist selectbox, Sort Wordlist action.
+  - Right: Animated radar, Correct/Try Again indicator, guess form, and score panel.
+  - Sidebar: New Game, wordlist selectbox, Sort Wordlist action, Game Mode selector.
 - Visuals:
   - Covered vs revealed styles; revealed empty cells use CSS class `empty`.
   - Completed word cells styled with `bw-cell-complete`; cell tooltips show coordinates.
@@ -111,9 +111,9 @@ Acceptance: Users can play end-to-end; radar shows exactly 6 pulses; reveal and
 7) Basic Tests
 - Placement validity (bounds, overlap, counts, no duplicate words).
 - Scoring logic and bonus calculation.
-- Guess gating (reveal required except chaining after correct guess).
+- Guess gating (reveal required except chaining after correct guess when enabled).
 
-Current Deltas (0.1.3 → 0.1.5)
+Current Deltas (0.1.3 → 0.1.10)
 - 0.1.3
   - Sidebar wordlist select; sorting persists length-then-alpha ordering; auto new-game after 5s notice.
   - Score panel improvements; per-word points; final score styling.
@@ -124,6 +124,11 @@ Current Deltas (0.1.3 → 0.1.5)
   - Hit/Miss indicator derived from `last_action`.
   - Completed word cells render as non-buttons with tooltips.
   - Helper functions for scope image and stable letter map rebuild.
+- 0.1.10
+  - Game Mode selector (`standard`, `too easy`); chaining allowed only in `standard`.
+  - Guess feedback indicator switched to Correct/Try Again.
+  - Version footer shows commit/Python/Streamlit; ocean background effect.
+  - Word list default/persistence fixes and sort action persists after delay.
 
 Known Issues / TODO
 - Word list selection bug: improper list fetched/propagated in some runs.

specs/specs.md

@@ -10,7 +10,9 @@ Battlewords is inspired by the classic Battleship game, but uses words instead o
   - Two five-letter words
   - Two six-letter words
 - Words are placed horizontally (left-right) or vertically (top-down), not diagonally.
+- Words may touch edges or corners but do not overlap unless a future mode allows shared letters.
 - Entry point is `app.py`.
+- **Supports Dockerfile-based deployment for Hugging Face Spaces and other container platforms.**
 
 ## Gameplay (Common)
 - Players click grid squares to reveal letters or empty spaces.
@@ -20,6 +22,7 @@ Battlewords is inspired by the classic Battleship game, but uses words instead o
 - After revealing a letter, players may guess a word by entering it in a text box.
 - Guess submission triggers an immediate rerun to reflect results.
 - Only one guess per letter reveal; must uncover another letter before guessing again.
+- In the default mode, a correct guess allows chaining an additional guess without another reveal.
 - **The game ends when all six words are guessed or all word letters are revealed.**
 
 ## Scoring
@@ -55,11 +58,12 @@ Battlewords is inspired by the classic Battleship game, but uses words instead o
 - Radar screen (shows last letter locations); y-axis inverted so (0,0) is top-left
 - Text box for word guesses
 - Score display (shows word, base points, bonus points, total score)
+- Guess status indicator (Correct/Try Again)
 
 ## Word List
 - External list at `battlewords/words/wordlist.txt`.
 - Loaded by `battlewords.word_loader.load_word_list()` with caching.
-- Filtered to uppercase A�Z, lengths in {4,5,6}; falls back if < 500 per length.
+- Filtered to uppercase A�Z, lengths in {4,5,6}; falls back if < 25 per length.
 
 ## Generator
 - Centralized word loader.
@@ -67,6 +71,7 @@ Battlewords is inspired by the classic Battleship game, but uses words instead o
 
 ## Entry Point
 - The Streamlit entry point is `app.py`.
+- **A `Dockerfile` can be used for containerized deployment (recommended for Hugging Face Spaces).**
 
 ## Copyright
 BattlewordsTM. All Rights Reserved. All content, trademarks and logos are copyrighted by the owner.