mirror of
https://github.com/darwincereska/terminordle.git
synced 2026-06-11 08:33:23 -05:00
darwincereska
58 lines
1.4 KiB
Markdown
58 lines
1.4 KiB
Markdown
# Terminordle
|
|
|
|
Terminordle is a terminal-based Wordle clone written in Java. It renders the board with ANSI colors, downloads a Wordle-compatible word list at startup, and lets you play directly in the console.
|
|
|
|
## Requirements
|
|
|
|
- Java 17
|
|
- A terminal that supports ANSI escape codes
|
|
- Internet access at startup, because the game downloads the allowed word list from a public gist
|
|
|
|
## Run
|
|
|
|
Use the Gradle wrapper from the project root:
|
|
|
|
```bash
|
|
./gradlew run
|
|
```
|
|
|
|
On Windows:
|
|
|
|
```powershell
|
|
gradlew.bat run
|
|
```
|
|
|
|
## Build
|
|
|
|
To produce a JAR:
|
|
|
|
```bash
|
|
./gradlew jar
|
|
```
|
|
|
|
The application entry point is `dev.darwincereska.terminordle.App`.
|
|
|
|
## How it works
|
|
|
|
- The game picks a random 5-letter word from the downloaded list.
|
|
- You get 6 guesses.
|
|
- Each guess must be a valid word from the same list.
|
|
- Tiles are colored using Wordle-style feedback:
|
|
- green for correct letter and position
|
|
- yellow for correct letter, wrong position
|
|
- gray for letters not in the answer
|
|
|
|
## Project layout
|
|
|
|
```text
|
|
src/main/java/dev/darwincereska/terminordle/App.java # CLI entry point
|
|
src/main/java/dev/darwincereska/terminordle/game/Game.java # Core game logic and board rendering
|
|
src/main/java/dev/darwincereska/terminordle/color/Color.java # ANSI color helpers
|
|
```
|
|
|
|
## Notes
|
|
|
|
- If your terminal does not support ANSI colors, the game falls back to plain text.
|
|
- If the word list cannot be downloaded, the app exits with an error before the game starts.
|
|
|