Wizdle.Models 1.0.1

<p align="center"><img src="Resources/WizdleTitle.png" alt="Test Miner" width="512" height="512"></p>

🔭 High Level

A library for solving Wordle.

Simple Flow:

---
config:
  theme: redux-dark
  look: handDrawn
  layout: fixed
---
flowchart LR
    CORRECT["Correct Letters"] --> REQUEST["Request"]
    MISPLACED["Misplaced Letters"] --> REQUEST
    EXCLUDE["Excluded Letters"] --> REQUEST
    REQUEST --> ENGINE["Engine"]
    ENGINE --> RESPONSE["Response"]
    RESPONSE --> WORDS["Possible Words"]

Prerequisites

🧙 Wizdle

The Wizdle core library found here, is responsbile for translating the request into a list of possible Words.

Example

var wizdleEngine = new WizdleEngine(_logger);

var request = new WizdleRequest
{
    CorrectLetters = "....t"
    MisplacedLetters = "..rs.",
    ExcludeLetters = "haebu",
};

WizdleResponse response = wizdleEngine.ProcessWizdleRequest(request);
// response.Words: ["skirt", "snort", "sport"]

Package

Available on:

• NuGet
• GitHub

💻 Wizdle.Console

The Wizdle Console application allows us to access all the functionality of the Wizdle library via the CLI.

More information can be found here

Example

Command:

$ ./Wizdle.Console.exe solve --correct "....t" --misplaced "..rs." --exclude "haebu"

Response:

Processing WizdleRequest: CorrectLetters: "....t"   MisplacedLetters: "..rs." ExcludeLetters: "haebu"
Mapping WizdleRequest:    CorrectLetters: "....t"   MisplacedLetters: "..rs." ExcludeLetters: "haebu"
Mapped SolveParameters:   CorrectLetters: "????t"   MisplacedLetters: "??rs?" ExcludeLetters: "haebu"
Found 3          Word(s) matching the criteria.
Found 3 Word(s) matching the criteria.
skirt
snort
sport

📨 Wizdle.ApiService

The Wizdle Api Service contains a deployable API instance of the Wizdle library.

More information can be found here

🪟 Wizdle.Windows

The Wizdle Windows application allows us to access all the functionality of the Wizdle library via a GUI on Windows.

More information (and installers) can be found here.

📲 Wizdle.Web

The Wizdle Web contains a deployable Blazor web app instance of the Wizdle library (hosted on the new dotnet Aspire platform).

More information can be found here

🧪 Testing

• Unit Testing
  • Wizdle.Tests
• Integration Testing
  • Wizdle.IntegrationTests
• Functional Testing
  • Wizdle.ApiService.Tests
  • Wizdle.Web.Tests (using Playwright)
• Performance Testing
  • Wizdle.PerformanceTests (using BenchmarkDotNet)
• Mutation Testing
  • Strkyer.NET with my GitHub Action