Wordle in the terminal!

This is Wordle, but in the terminal, written in Kotlin!

The repository only contains Kotlin source files that you have to compile into an executable .jar file yourself.

If you only want to play, download the .zip file in the latest release, unpack it, open your terminal, cd into the folder and run java -jar wordle.jar. If this doesn't work, scroll down for a tutorial on how to install the JDK.

If you want to contribute to this project, you may want to install both the Kotlin terminal compiler and the JDK.

---

Dependencies

To successfully compile and run the project, you need:

• Kotlin Compiler (kotlinc)
• Java Development Kit (JDK)

---

Kotlin Compiler

The Kotlin compiler (kotlinc) is required to compile the .kt source files into a .jar.

Installation:

• Official website: https://kotlinlang.org/docs/command-line.html

Quick install instructions:

Manual download:
Download the latest Kotlin compiler (e.g. kotlin-compiler-2.1.21.zip) from the GitHub Releases.
Unzip it and add the bin directory to your system's PATH to access kotlinc globally.

On UNIX-like systems:
Use SDKMAN! for easy installation and management of Kotlin versions.
Install SDKMAN! with:

curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"

Verify installation by running:

sdk version

Then install Kotlin:

sdk install kotlin

Verify installation by running:

kotlin -version

---

Java Development Kit (JDK)

The Java Development Kit is required to run the compiled .jar file.

Installation:

• Official Oracle JRE/JDK: https://www.oracle.com/java/technologies/downloads/

• OpenJDK (recommended and open-source):

  sudo apt install openjdk-21-jdk     # Debian/Ubuntu
  sudo pacman -S jdk21-openjdk       # Arch Linux

Verify installation by running:

java -version

---

Usage

Compile the Kotlin source files into a .jar:

./compile.sh

Run the game:

java -jar wordle.jar

Compile and run the game:

./compile.sh -e

Show help:

./compile.sh --help

If no flag is provided, the script will just compile the game.

Legal

This project uses two seperate word lists for English and German. You can find them here:
English
German