wordle-clone
v1.3.0
Published
A clone of the popular Wordle game.
Downloads
3
Readme
wordle-clone
Click here to play on browser
A clone of the worldwide phenomenon known as Wordle.
Can be played on either the browser or the command line.
Features
- Base browser game
- Also playable on the terminal
- Share functionality
- Countdown to next day's Wordle
- Can be launched as PWA on mobile
- Hard Mode
- High Contrast Mode
- Themes
- Dark
- Light
- Snow
- Tap and hold backspace to clear input
Setup
Browser
Click here to play on the browser
CLI
Assuming you have Node.js and npm installed, run the following command to install the game:
npm install -g wordle-clone
Now you can run it using the following command:
wordle
# or, alternatively:
# wordle-clone
CLI arguments
-d, --difficulty <string> change game difficulty (choices: "hard", "easy")
-v, --verbose print extra information
-h, --help display help for command
-V, --version output the version number
Preferences
Preferences are stored in the following locations (depending on OS):
$HOME/.config/wordle-clone/preferences.json
(Linux)/Users/<username>/Library/Application Support/wordle-clone/preferences.json
(macOS)C:\Users\<username>\AppData\Roaming\wordle-clone\Config\preferences.json
(Windows)
To find where it's located on your machine, you can use the Game Data Subcommand (see Game Data Subcommand Usage for full usage). You can output the preferences filepath by running wordle data -p
.
In this file, you can specify the following options in JSON format:
| Option | Type | Description | Default Value |
| ------ | ---- | ----------- | ------------- |
| hardMode
| boolean
| Whether to enable hard mode | false
|
| highContrast
| boolean
| Whether to turn on high contrast mode | false
|
Example:
{
"hardMode": true,
"highContrast": false
}
Game Data Subcommand Usage
Usage: wordle-clone data [options]
outputs the filepath of game state and/or preferences
Options:
-p, --preferences output preferences filepath
-s, --state output game state filepath
-h, --help display help for command
Development
Clone this repository, then run the following:
npm install
It's also a good idea to scramble the words when working on the project, to prevent spoilers:
./scripts/gen_word_list.sh
(Note: If you're on Windows, run the script in WSL)
The following will make it so that git doesn't detect that words.txt
changed:
git update-index --assume-unchanged words.txt
At this point, run the following to start a local dev server:
npm run dev
The game should render when navigating to http://localhost:5500.
HTTPS Local Development
The share feature uses the share sheet provided by the browser/OS and can also fall back to the browser's clipboard feature if the share sheet isn't available. Both of these features need a secure context to operate, requiring the use of a local HTTPS server when developing them. However, the game can still run on a HTTP server, where it will default to legacy clipboard functionality.
Using mkcert, run the following commands to setup local certificates to be used by local HTTPS server:
mkdir ssl
cd ssl
mkcert -install
mkcert localhost 127.0.0.1 ::1
Then run the following to start up the local HTTPS server:
npm run devs
The game should render when navigating to https://localhost:5501.
Testing
Run the following to launch unit tests:
npm run test
Cypress tests can be accessed by running the following:
npm run cypress open
This will launch the tests in the Cypress UI.
Alternatively, you can run the tests directly on CLI:
npm run cypress run
Future Additions
- Player Statistics
- Archive
- Animations
- Code cleanup