wordle-analyzer/README.md

# Wordle-analyzer


![Project badge](https://img.shields.io/badge/language-Rust-blue.svg)
![Crates.io License](https://img.shields.io/crates/l/wordle-analyzer)
![Gitea Release](https://img.shields.io/gitea/v/release/PlexSheep/wordle-analyzer?gitea_url=https%3A%2F%2Fgit.cscherr.de)
![Gitea language count](https://img.shields.io/gitea/languages/count/PlexSheep/wordle-analyzer?gitea_url=https%3A%2F%2Fgit.cscherr.de)
[![cargo checks and tests](https://github.com/PlexSheep/wordle-analyzer/actions/workflows/cargo.yaml/badge.svg)](https://github.com/PlexSheep/wordle-analyzer/actions/workflows/cargo.yaml)

* [Original Repository](https://git.cscherr.de/PlexSheep/wordle-analyzer)
* [GitHub Mirror](https://github.com/PlexSheep/wordle-analyzer)
* [crates.io](https://crates.io/crates/wordle-analyzer)

[Wordle](https://en.wikipedia.org/wiki/Wordle) is a popular game in which you
have to guess words by slowly guessing the letters contained in it.

`Wordle-analyzer` aims to offer a few things:

* A basic implementation of the Wordle game
* An Interface for solvers for the Wordle game, which can make use of math and
  information theory
* A benchmark for Wordle solvers

## Wordlists

Included in this repository are the following wordlists:

<!-- TODO: make sure this is properly cited -->
* [`./data/wordlists/en_US_3b1b_freq_map.json`](./data/wordlists/en_US_3b1b_freq_map.json) --- [3Blue1Brown Top English words](https://github.com/3b1b/videos/tree/master/_2022/wordle/data)
* [`./data/wordlists/german_SUBTLEX-DE_full.json`](./data/wordlists/german_SUBTLEX-DE_full.json) --- [SUBTLEX-DE ~33.000 Common German Words](https://osf.io/py9ba/files/osfstorage)
* [`./data/wordlists/german_SUBTLEX-DE_small.json`](./data/wordlists/german_SUBTLEX-DE_small.json) --- [SUBTLEX-DE ~33.000 Common German Words (reduced to most common)](https://osf.io/py9ba/files/osfstorage)
info 2024-03-20 16:38:22 +01:00			`# Wordle-analyzer`
Initial commit 2024-03-20 16:04:33 +01:00
fancier readme 2024-03-21 11:46:26 +01:00
			`![Project badge](https://img.shields.io/badge/language-Rust-blue.svg)`
			`![Crates.io License](https://img.shields.io/crates/l/wordle-analyzer)`
			`![Gitea Release](https://img.shields.io/gitea/v/release/PlexSheep/wordle-analyzer?gitea_url=https%3A%2F%2Fgit.cscherr.de)`
			`![Gitea language count](https://img.shields.io/gitea/languages/count/PlexSheep/wordle-analyzer?gitea_url=https%3A%2F%2Fgit.cscherr.de)`
			`[![cargo checks and tests](https://github.com/PlexSheep/wordle-analyzer/actions/workflows/cargo.yaml/badge.svg)](https://github.com/PlexSheep/wordle-analyzer/actions/workflows/cargo.yaml)`

			`* [Original Repository](https://git.cscherr.de/PlexSheep/wordle-analyzer)`
			`* [GitHub Mirror](https://github.com/PlexSheep/wordle-analyzer)`
			`* [crates.io](https://crates.io/crates/wordle-analyzer)`

info 2024-03-20 16:38:22 +01:00			`[Wordle](https://en.wikipedia.org/wiki/Wordle) is a popular game in which you`
			`have to guess words by slowly guessing the letters contained in it.`

			`Wordle-analyzer` aims to offer a few things:

			`* A basic implementation of the Wordle game`
			`* An Interface for solvers for the Wordle game, which can make use of math and`
			`information theory`
			`* A benchmark for Wordle solvers`

			`## Wordlists`

			`Included in this repository are the following wordlists:`

docs: mention SUBTLEX-DE, even though it's not included yet 2024-07-25 16:18:21 +02:00			`<!-- TODO: make sure this is properly cited -->`
docs(readme): make wordlist attributions clearer 2024-08-07 15:07:59 +02:00			* [`./data/wordlists/en_US_3b1b_freq_map.json`](./data/wordlists/en_US_3b1b_freq_map.json) --- [3Blue1Brown Top English words](https://github.com/3b1b/videos/tree/master/_2022/wordle/data)
			* [`./data/wordlists/german_SUBTLEX-DE_full.json`](./data/wordlists/german_SUBTLEX-DE_full.json) --- [SUBTLEX-DE ~33.000 Common German Words](https://osf.io/py9ba/files/osfstorage)
			* [`./data/wordlists/german_SUBTLEX-DE_small.json`](./data/wordlists/german_SUBTLEX-DE_small.json) --- [SUBTLEX-DE ~33.000 Common German Words (reduced to most common)](https://osf.io/py9ba/files/osfstorage)