blek
/
wordle
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add features to readme

This commit is contained in:
blek 2023-09-04 00:32:56 +10:00
parent 43dc5c2d0d
commit 97a836a294
Signed by: blek
GPG Key ID: 14546221E3595D0C
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -4,3 +4,34 @@
</p> </p>
OpenWordle is a completely open source and lightweight wordle game with very minimal set of runtime dependencies OpenWordle is a completely open source and lightweight wordle game with very minimal set of runtime dependencies
## Features
### 1. Scripting!
You can use custom scripts to have fun with wordle!
Script interface is exposed via `globalThis.ScriptInterface`.
In order for scripts to run, the user must enable them by
clicking on the "Enable scripts" button in the settings.
After enabling scripts, all the game data would be available
to the script. To expose cheaters, a warning text would appear near the header:
"Scripts are allowed. The game may not be fair-played"
To run the scripts, I recommend using [Tampermoney](https://www.tampermonkey.net).
Using the developer console is a fine option too.
### 2. Extremely lightweight
The whole app is \~ 100kb bundled, which is pretty impressive IMHO.
The only 2 libraries are included via `await import`, and most of the
weight is the bundled-in dictionary of ~7k words
### 3. FOSS
So far, I haven't found a wordle game that is FOSS. This is the one
### 4. Customizable
There is no scoped CSS which allows good space for customization.