Wordle

Screenshots

This is a terminal based program atempting to recreate the wordle experience on the terminal. About "Wordle". it is a popular word-guessing game where players try to guess a five-letter word by making guesses and receiving feedback on the correctness of their guesses. I have attempted to replicated the complex ui of it by making the color of the character to a particular color. Green for correct index and match, yellow for match but not correct index, red for no form of match.

Table of Contents

• Dependencies
• Building the program
• Run Locally
• Features
• File Structure
• Running Tests
• Demo
• Roadmap
• Made by

Dependencies

Only dependency is to have gcc in your machine

sudo apt-get install gcc

Building the program

The below command will make a new executable/equivalent but you should have gcc installed

gcc wordle.c src/randomindex.c src/wordcheck.c src/hash.c src/color.c -Iinclude -o wordle -lm

Run Locally

Clone the project

  git clone https://github.com/smresponsibilities/Wordle

Go to the project directory

  cd Wordle

Running the project

For linux

  chmod +x wordle.sh && ./wordle.sh

For windows, both commands are individually capable enough to make the program first command runs in git bash only

sh wordle.sh

 wordle.bat

Features

• A single word for the whole day like the original
• Implemented a pseudo hash technique with no collisions
• Very modular
• Cross platform
• Attractive colors

File Structure

• wordle.c: The main program file that is the entry point to the project.
• test folder: The folder that have the unit tests.
• README.md: The README file with project documentation.
• include folder: This contains the header files.
• src folder: This contains actual code of all the modular functions.
• wordle.sh: This contains the neccessary commands to build the program in Linux or in Windows by git bash.
• wordle.bat: This contains the neccessary commands to build the program in Windows.

Running Tests

To run tests, go to the test directory on your machine

 cd test

To run the script on Windows , either run the below bat file or the next commands

.\test.bat 

gcc -I.. ../hash.c ../randomindex.c ../wordcheck.c testwordcheck.c testhash.c testrandom.c maintest.c -o maintest
.\maintest

To run the tests on Linux , run the following script

chmod +x wordle.sh && ./wordle.sh

Demo

Roadmap

• Transition from terminal to gui
• Add more words and slangs
• Using socket
• Doing more optimization and some more easter eggs
• Custom wordle

Made by

• @smresponsibilities