From 97a836a29481f95d3fc1f632afe54e06322cd36b Mon Sep 17 00:00:00 2001 From: blek Date: Mon, 4 Sep 2023 00:32:56 +1000 Subject: [PATCH] add features to readme --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index d3992e6..123b36e 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,34 @@

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.