Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coteh/wordle-clone
:green_square: A clone of the popular game Wordle. Vanilla HTML/CSS/JS browser game + Node.js CLI game.
https://github.com/coteh/wordle-clone
Last synced: 6 days ago
JSON representation
:green_square: A clone of the popular game Wordle. Vanilla HTML/CSS/JS browser game + Node.js CLI game.
- Host: GitHub
- URL: https://github.com/coteh/wordle-clone
- Owner: Coteh
- License: mit
- Created: 2022-03-23T01:53:28.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T00:44:11.000Z (7 months ago)
- Last Synced: 2024-05-28T07:52:35.331Z (7 months ago)
- Language: JavaScript
- Homepage: https://coteh.github.io/wordle-clone/
- Size: 2.74 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# wordle-clone
[](https://www.npmjs.com/package/wordle-clone)
[](https://github.com/Coteh/wordle-clone/actions/workflows/run-tests.yml)
[](https://gitpod.io/#https://github.com/Coteh/wordle-clone)
### [**Click here to play on browser**](https://coteh.github.io/wordle-clone)
A clone of the worldwide phenomenon known as [Wordle](https://www.powerlanguage.co.uk/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
- QWERTY, Dvorak, and Alphabetical on-screen keyboards
## Setup
### Browser
[Click here to play on the browser](https://coteh.github.io/wordle-clone)
### CLI
Assuming you have [Node.js](https://nodejs.org) 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 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//Library/Application Support/wordle-clone/preferences.json` (macOS)
- `C:\Users\\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](#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
```
##### Uninstalling CLI
You can use the command `wordle data -s` to find the state file on your machine, as well as `wordle data -p` to find the preferences file on your machine.
Uninstalling the game and all its data from your machine is as simple as deleting those underlying directories, then running:
```
npm uninstall -g wordle-clone
```
## 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:
```sh
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](https://github.com/FiloSottile/mkcert), run the following commands to setup local certificates to be used by local HTTPS server:
```sh
mkdir ssl
cd ssl
# run this on elevated shell on Windows
mkcert -install
mkcert localhost 127.0.0.1 ::1
```
Then run the following to start up the local HTTPS server:
```sh
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