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):
- Change the file in
src/constants/orthography.tsto use your language's writing system. - Change the file in
src/constants/wordlist.tsto use your language's words. - Change the file in
src/constants/validGuesses.tsto include all valid guesses for your language. - Change the file in
src/constants/config.tsto 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. - Publish on GitHub Pages by changing the
homepagekey inpackage.jsonand runningnpm run deployor just committing to the main branch (and a GitHub workflow will take care of the rest).
The interface is translated by default in both English and Spanish - other translations are very welcome!
Thanks to Carolyn O'Meara (https://github.com/ckomeara) for providing the Spanish translation.
Design Decisions: To Run Locally: Clone the repository and perform the following command line actions:
$ cd CORRECTDIRECTORYNAME
$ npm install
$ npm run startTo build/run docker container:
$ docker build -t GAME .
$ docker run -d -p 3000:3000 GAMEopen http://localhost:3000 in browser.