Surn commited on
Commit
23ac082
·
1 Parent(s): 51e701a

0.2.35 and update documentation

Browse files

Updated version to 0.2.35 across all relevant files, including `README.md`, `claude.md`, `requirements.mdx`, `specs.mdx`, and `pyproject.toml`. Updated release notes to reflect new features and UI improvements:

- removed and added version back to title, while capturing screenshots
- Added spinner for loading states.
- Improved graphics and added favicon.
- Moved leaderboard navigation to footer menu.
- Integrated leaderboard submission in game over dialog.
- Updated routing and navigation links.

Updated `__version__` in `__init__.py` and modified `_render_header` in `ui.py` to display the version dynamically. Ensured consistency in documentation and referenced the Wrdler → BattleWords upgrade checklist.

.github/prompts/document.md CHANGED
@@ -1,4 +1,4 @@
1
- update readme.md, claude.md, specs/specs.mdx, specs/requirements.mdx , specs/leaderboard_spec.mdx, wrdler/__init__.py, pyproject.toml, #gameplay_guide.md for these latest changes, as needed. Make changes minimal.
2
  include any new features, bug fixes, or important updates in the documentation.
3
  ensure **Current Version:** is up to date in all relevant files.
4
  ensure **Last Updated:** is current
 
1
+ update readme.md, claude.md, specs/specs.mdx, specs/requirements.mdx , specs/leaderboard_spec.mdx, battlewords/__init__.py, pyproject.toml, #gameplay_guide.md for these latest changes, as needed. Make changes minimal.
2
  include any new features, bug fixes, or important updates in the documentation.
3
  ensure **Current Version:** is up to date in all relevant files.
4
  ensure **Last Updated:** is current
README.md CHANGED
@@ -19,23 +19,22 @@ tags:
19
 
20
  > **This project is used by [huggingface.co](https://huggingface.co/spaces/Surn/BattleWords) as a demonstration of interactive word games in Python.**
21
 
22
- **Current Version:** 0.2.34
23
- **Last Updated:** 2025-01-20
24
 
25
  BattleWords is a vocabulary learning game inspired by classic Battleship mechanics. The objective is to discover hidden words on a grid, earning points for strategic guessing before all letters are revealed.
26
 
27
  ## Recent Changes
28
- - version 0.2.34
29
  - New spinner implementation for loading states
30
  - Updated graphics and improved visual polish
31
  - Favicon added for browser tab branding
32
- - Leaderboard navigation moved to footer menu
33
- - Game over dialog now integrates leaderboard submission and displays qualification results
34
  - Leaderboard page routing uses query parameters and custom navigation links
35
  - Footer navigation links to Leaderboard, Play, and Settings pages
36
  - Minimal documentation and UI updates for these changes
37
 
38
- > For the detailed porting checklist (Wrdler → BattleWords), see `specs/upgrade.mdx`.
39
 
40
  ## Features
41
 
@@ -72,7 +71,7 @@ BattleWords is a vocabulary learning game inspired by classic Battleship mechani
72
  - **"Show Challenge Share Links" toggle** (default OFF) to control URL visibility
73
  - Each player gets different random words from the same wordlist
74
 
75
- ### UI & Navigation Updates (v0.2.34+)
76
  - **Spinner implementation** for loading states
77
  - **Updated graphics** for improved visuals
78
  - **Favicon** added for browser tab branding
@@ -80,6 +79,8 @@ BattleWords is a vocabulary learning game inspired by classic Battleship mechani
80
  - **Leaderboard navigation** is now in the footer menu
81
  - **Leaderboard page routing** uses query parameters and custom navigation links
82
  - **Game over dialog** integrates leaderboard submission and displays qualification results
 
 
83
 
84
  ### Deployment & Technical
85
  - **Dockerfile-based deployment** supported for Hugging Face Spaces and other container platforms
@@ -212,6 +213,18 @@ CRYPTO_PK= # Reserved for future signing
212
  - Personal high scores sidebar with filtering
213
  - Player statistics tracking (games played, averages, bests)
214
 
 
 
 
 
 
 
 
 
 
 
 
 
215
  - 0.2.33
216
  - Simplified UI and improved gameplay experience
217
  - Enhanced subheader text clarity
 
19
 
20
  > **This project is used by [huggingface.co](https://huggingface.co/spaces/Surn/BattleWords) as a demonstration of interactive word games in Python.**
21
 
22
+ **Current Version:** 0.2.35
23
+ **Last Updated:** 2026-01-29
24
 
25
  BattleWords is a vocabulary learning game inspired by classic Battleship mechanics. The objective is to discover hidden words on a grid, earning points for strategic guessing before all letters are revealed.
26
 
27
  ## Recent Changes
28
+ - version 0.2.35
29
  - New spinner implementation for loading states
30
  - Updated graphics and improved visual polish
31
  - Favicon added for browser tab branding
32
+ - Leaderboard navigation moved to footer menu (not sidebar)
33
+ - Game over dialog integrates leaderboard submission and displays qualification results
34
  - Leaderboard page routing uses query parameters and custom navigation links
35
  - Footer navigation links to Leaderboard, Play, and Settings pages
36
  - Minimal documentation and UI updates for these changes
37
 
 
38
 
39
  ## Features
40
 
 
71
  - **"Show Challenge Share Links" toggle** (default OFF) to control URL visibility
72
  - Each player gets different random words from the same wordlist
73
 
74
+ ### UI & Navigation Updates (v0.2.35+)
75
  - **Spinner implementation** for loading states
76
  - **Updated graphics** for improved visuals
77
  - **Favicon** added for browser tab branding
 
79
  - **Leaderboard navigation** is now in the footer menu
80
  - **Leaderboard page routing** uses query parameters and custom navigation links
81
  - **Game over dialog** integrates leaderboard submission and displays qualification results
82
+ - **Leaderboard page routing** uses query parameters and custom navigation links
83
+ - **Game over dialog** integrates leaderboard submission and displays qualification results
84
 
85
  ### Deployment & Technical
86
  - **Dockerfile-based deployment** supported for Hugging Face Spaces and other container platforms
 
213
  - Personal high scores sidebar with filtering
214
  - Player statistics tracking (games played, averages, bests)
215
 
216
+ - version 0.2.34
217
+ - New spinner implementation for loading states
218
+ - Updated graphics and improved visual polish
219
+ - Favicon added for browser tab branding
220
+ - Leaderboard navigation moved to footer menu (not sidebar)
221
+ - Game over dialog integrates leaderboard submission and displays qualification results
222
+ - Leaderboard page routing uses query parameters and custom navigation links
223
+ - Footer navigation links to Leaderboard, Play, and Settings pages
224
+ - Minimal documentation and UI updates for these changes
225
+
226
+ > For the detailed porting checklist (Wrdler → BattleWords), see `specs/upgrade.mdx`.
227
+
228
  - 0.2.33
229
  - Simplified UI and improved gameplay experience
230
  - Enhanced subheader text clarity
battlewords/__init__.py CHANGED
@@ -1,2 +1,2 @@
1
- __version__ = "0.2.34"
2
  __all__ = ["models", "generator", "logic", "ui", "game_storage", "modules"]
 
1
+ __version__ = "0.2.35"
2
  __all__ = ["models", "generator", "logic", "ui", "game_storage", "modules"]
battlewords/ui.py CHANGED
@@ -230,7 +230,7 @@ def _sync_back(state: GameState) -> None:
230
 
231
 
232
  def _render_header():
233
- st.title(f"Battlewords", anchor="title")
234
 
235
  st.subheader("Click the cells to reveal the letters of words on the grid. The radar screen pulses show the LAST letter of the six words. Guess the words for extra points and a better score!", anchor="subtitle")
236
 
 
230
 
231
 
232
  def _render_header():
233
+ st.title(f"Battlewords v{version}", anchor="title")
234
 
235
  st.subheader("Click the cells to reveal the letters of words on the grid. The radar screen pulses show the LAST letter of the six words. Guess the words for extra points and a better score!", anchor="subtitle")
236
 
claude.md CHANGED
@@ -3,8 +3,8 @@
3
  ## Project Overview
4
  BattleWords is a vocabulary learning game inspired by Battleship mechanics, built with Streamlit and Python 3.12. Players reveal cells on a 12x12 grid to discover hidden words and earn points for strategic guessing.
5
 
6
- **Current Version:** 0.2.34 (Stable - Spinner, Graphics, Favicon, UI Navigation)
7
- **Last Updated:** 2025-01-20
8
  **Next Version:** 0.3.0 (In Development - Wrdler improvements)
9
  **Repository:** https://github.com/Oncorporation/BattleWords.git
10
  **Live Demo:** https://huggingface.co/spaces/Surn/BattleWords
@@ -16,12 +16,12 @@ The detailed porting checklist lives in `specs/upgrade.mdx`.
16
  ## Recent Changes
17
  See `README.md` for the canonical release notes: [Recent Changes](README.md#recent-changes)
18
 
19
- - v0.2.34
20
  - New spinner implementation for loading states
21
  - Updated graphics and improved visual polish
22
  - Favicon added for browser tab branding
23
- - Leaderboard navigation moved to footer menu
24
- - Game over dialog now integrates leaderboard submission and displays qualification results
25
  - Leaderboard page routing uses query parameters and custom navigation links
26
  - Footer navigation links to Leaderboard, Play, and Settings pages
27
 
 
3
  ## Project Overview
4
  BattleWords is a vocabulary learning game inspired by Battleship mechanics, built with Streamlit and Python 3.12. Players reveal cells on a 12x12 grid to discover hidden words and earn points for strategic guessing.
5
 
6
+ **Current Version:** 0.2.35 (Stable - Spinner, Graphics, Favicon, UI Navigation)
7
+ **Last Updated:** 2026-01-29
8
  **Next Version:** 0.3.0 (In Development - Wrdler improvements)
9
  **Repository:** https://github.com/Oncorporation/BattleWords.git
10
  **Live Demo:** https://huggingface.co/spaces/Surn/BattleWords
 
16
  ## Recent Changes
17
  See `README.md` for the canonical release notes: [Recent Changes](README.md#recent-changes)
18
 
19
+ - v0.2.35
20
  - New spinner implementation for loading states
21
  - Updated graphics and improved visual polish
22
  - Favicon added for browser tab branding
23
+ - Leaderboard navigation moved to footer menu (not sidebar)
24
+ - Game over dialog integrates leaderboard submission and displays qualification results
25
  - Leaderboard page routing uses query parameters and custom navigation links
26
  - Footer navigation links to Leaderboard, Play, and Settings pages
27
 
pyproject.toml CHANGED
@@ -1,6 +1,6 @@
1
  [project]
2
  name = "battlewords"
3
- version = "0.2.34"
4
  description = "BattleWords vocabulary game with game sharing via shortened game_id URL referencing server-side JSON settings"
5
  readme = "README.md"
6
  requires-python = ">=3.12,<3.13"
 
1
  [project]
2
  name = "battlewords"
3
+ version = "0.2.35"
4
  description = "BattleWords vocabulary game with game sharing via shortened game_id URL referencing server-side JSON settings"
5
  readme = "README.md"
6
  requires-python = ">=3.12,<3.13"
specs/requirements.mdx CHANGED
@@ -1,9 +1,9 @@
1
  # Battlewords: Implementation Requirements
2
 
3
- **Current Version:** 0.2.34
4
- **Last Updated:** 2025-06-13
5
 
6
- ## Recent Changes (v0.2.34)
7
  See `README.md` for the canonical release notes: [Recent Changes](README.md#recent-changes)
8
 
9
  - New spinner implementation for loading states
 
1
  # Battlewords: Implementation Requirements
2
 
3
+ **Current Version:** 0.2.35
4
+ **Last Updated:** 2026-01-29
5
 
6
+ ## Recent Changes (v0.2.35)
7
  See `README.md` for the canonical release notes: [Recent Changes](README.md#recent-changes)
8
 
9
  - New spinner implementation for loading states
specs/specs.mdx CHANGED
@@ -1,7 +1,7 @@
1
  # Battlewords Game Requirements (specs.md)
2
 
3
- **Current Version:** 0.2.34
4
- **Last Updated:** 2025-01-20
5
 
6
  ## Overview
7
  Battlewords is inspired by the classic Battleship game, but uses words instead of ships. The objective is to discover hidden words on a grid, earning points for strategic guessing before all letters are revealed.
@@ -9,7 +9,7 @@ Battlewords is inspired by the classic Battleship game, but uses words instead o
9
  ## Upgrade Checklist
10
  The detailed Wrdler  BattleWords porting checklist is tracked in `specs/upgrade.mdx`.
11
 
12
- ## Recent Changes (v0.2.34)
13
  See `README.md` for the canonical release notes: [Recent Changes](README.md#recent-changes)
14
 
15
  - New spinner implementation for loading states
 
1
  # Battlewords Game Requirements (specs.md)
2
 
3
+ **Current Version:** 0.2.35
4
+ **Last Updated:** 2026-01-29
5
 
6
  ## Overview
7
  Battlewords is inspired by the classic Battleship game, but uses words instead of ships. The objective is to discover hidden words on a grid, earning points for strategic guessing before all letters are revealed.
 
9
  ## Upgrade Checklist
10
  The detailed Wrdler  BattleWords porting checklist is tracked in `specs/upgrade.mdx`.
11
 
12
+ ## Recent Changes (v0.2.35)
13
  See `README.md` for the canonical release notes: [Recent Changes](README.md#recent-changes)
14
 
15
  - New spinner implementation for loading states