Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 5.04 KB

README.md

File metadata and controls

75 lines (54 loc) · 5.04 KB
Raw

Any-Language Wordle Clone

Changes in this fork

I've adapted this code to allow for simply adapting it to another language. The wordlist and orthography (writing system) here are for the Gitksan language, but this repository is meant to be adapted to other languages. I've also added a script for publishing on GitHub Pages.

Summary of changes

  • Allow letters in the "orthography.ts" to be digraphs or multigraphs (letters that are more than one character)
  • Allow more or less atempts than 6
  • Allow the length of words to be more or less than 5
  • Added a configuration file to define language-specific metadata
  • Added functionality for free deployment to GitHub Pages
  • Dynamically render the keyboard based on the defined orthography
  • Use Unicode normalization by default
  • Use BC Sans open source font to better render Indigenous language orthographies in BC, Canada. See the blog to change the font
  • Complete localization/translateability of the interface using react-i18next

To adapt for your language (the basics):

  1. Change the file in src/constants/orthography.ts to use your language's writing system.
  2. Change the file in src/constants/wordlist.ts to use your language's words.
  3. Change the file in src/constants/validGuesses.ts to include all valid guesses for your language.
  4. Change the file in src/constants/config.ts to include meta data about your language. If your language needs words longer or shorter than 5, you can set that in this file and also set the number of tries.
  5. Publish on GitHub Pages by changing the homepage key in package.json and running npm run deploy or just committing to the main branch (and a GitHub workflow will take care of the rest).

For more information, including how to localize the interface to your language, visit the blog article: https://blog.mothertongues.org/wordle/.

The interface is translated by default in English, Kiswahili, Mandarin and Spanish - other translations are very welcome! To add translations please submit a pull request with the following steps:

  1. Add an appropriate localiztion file in public/locales
  2. Update the other localization files in public/locales to include the additional langauge
  3. Update the CONFIG.availableLangs variable in src/constants/config.ts to include your language.

Thanks to Carolyn O'Meara (https://github.com/ckomeara) for providing the Spanish translation. Thanks to Haowen Jiang (https://github.com/howard-haowen) for providing the 中文 translation. Thanks to Benson Muite (https://github.com/bkmgit) for providing the Kiswahili translation.

On to the original stuff from @hannahcode...

  • Go play the real Wordle here
  • Read the story behind it here
  • Try a demo of this clone project here

Inspiration: This game is an open source clone of the immensely popular online word guessing game Wordle. Like many others all over the world, I saw the signature pattern of green, yellow, and white squares popping up all over social media and the web and had to check it out. After a few days of play, I decided it would be great for my learning to try to rebuild Wordle in React!

Design Decisions: I used a combination of React, Typescript, and Tailwind to build this Wordle Clone. When examining the original Wordle, I assumed the list might come from an external API or database, but after investigating in chrome dev tools I found that the list of words is simply stored in an array on the front end. I'm using the same list as the OG Wordle uses, but watch out for spoilers if you go find the file in this repo! The word match functionality is simple: the word array index increments each day from a fixed game epoch timestamp (only one puzzle per day!) roughly like so:

WORDS[Math.floor((NOW_IN_MS - GAME_EPOCH_IN_MS) / ONE_DAY_IN_MS)]

React enabled me to componentize the littlest parts of the game - keys and letter cells - and use them as the building blocks for the keyboard, word grid, and winning solution graphic. As for handling state, I used the built in useState and useEffect hooks to track guesses, whether the game is won, and to conditionally render popups.

In addition to other things, Typescript helped ensure type safety for the statuses of each guessed letter, which were used in many areas of the app and needed to be accurate for the game to work correctly.

I implemented Tailwind mostly because I wanted to learn how to use Tailwind CSS, but I also took advantage of Tailwind UI with their headless package to build the modals and notifications. This was such an easy way to build simple popups for how to play, winning the game, and invalid words.

To Run Locally: Clone the repository and perform the following command line actions:

$ cd wordle
$ npm install
$ npm run start

To build/run docker container:

$ docker build -t notwordle .
$ docker run -d -p 3000:3000 notwordle

open http://localhost:3000 in browser.