Skip to content

Latest commit

 

History

History
142 lines (97 loc) · 3.57 KB

README.md

File metadata and controls

142 lines (97 loc) · 3.57 KB
Raw

wordle-clone

npm CI Gitpod ready-to-code

Click here to play on browser

Browser Game Screenshot

A clone of the worldwide phenomenon known as Wordle.

Can be played on either the browser or the command line.

Features

  • Base game
    • Browser version
    • CLI version
  • Share functionality
  • Countdown to next day's Wordle
  • Hard Mode

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, you can run a local web server on the project directory, and the game should render when navigating to the port of the server from your browser.

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