About clupasq/word-mastermind

Word Mastermind is an open-source web game that functions as an endless clone of Wordle combined with the mechanics of the classic board game Mastermind. Unlike the original Wordle which restricts players to one puzzle per day, this software allows for unlimited gameplay sessions. It challenges users to deduce a hidden target word by submitting letter guesses and interpreting visual feedback. The core mechanic involves entering valid words from a built-in dictionary, after which the system evaluates each letter position. Letters in the correct position are highlighted in green, while letters present in the target word but misplaced are marked in yellow. Letters that do not appear in the target word remain unmarked. To assist players, an on-screen keyboard dynamically updates to reflect the status of every letter, showing which characters are confirmed present, confirmed absent, or still unknown. A key feature of the software is its flexibility regarding language and vocabulary. It supports custom dictionary f ...

c

Published by

clupasq

Visit View Profile

README.md

View on GitHub

Word Mastermind

This game is a clone of Wordle. It's like the MasterMind game, but instead of colors you have to guess words.

Why?

The original game only allows one word per day. This one can be played endlessly.
Can work with custom dictionary files

Demo

You can try it out on Glitch:

How to Play

The goal of the game is to guess a target word.

To do so, you enter guesses and the game will provide feedback for each letter of your guess:

a letter that is placed in the correct spot will be marked green
a letter that is present in the target word, but incorrectly placed will be marked yellow
the unmarked letters are simply not present in the target word

All submitted guesses have to be valid words.

To make it easy, the keyboard at the bottom of the screen will highlight the statuses of each letter: present (green), not present (dark gray), unknown (light gray).

Running the program

Clone this repo:

git clone https://github.com/clupasq/word-mastermind.git
cd word-mastermind

There are two options for running the program: with Node.js or in Docker.

Running with Docker

The easiest option is to use Docker. You can either pull the latest Docker image from the GitHub Repository, or build it yourself.

To pull the image:

docker pull ghcr.io/clupasq/word-mastermind:latest

To build the image:

cd word-mastermind
docker build -t word-mastermind .
cd ..

Once the image is available, you can start a container:

docker run --rm -p "3333:80" word-mastermind

Then, go to http://localhost:3333.

Running with node

Make sure you have Node.JS 16 and yarn installed.

Install dependencies:

yarn install

Run the server:

yarn start

Open the application.

Go to your browser and navigate to http://localhost:3333

clupasq/word-mastermind