Manual

In this section all the steps to download, run and use the program are explained.
There is also a subsection containing the descriptions of external projects that have contributed to the development of this software.

Requirements

Be aware that in order to use the software, Java must be installed on your computer.
It is also important to notice that the project has been developed and tested using the JDK 20 therefore some bugs may appear if you run it with an older version of java.
Download Java here!

If you want to be able to use the funcionality "Smart Next Best Move", Python is required.
Download Python here!
To use the version of the software with the "Smart Next Best Move" you need to build the project locally on your system. An IDE with maven such as Intellij IDEA or Eclipse is therefore required. Download an IDE following these links:

Download

Follow these steps to download the software:

  1. Open our @GitHub page.
  2. Click on the green button code.
    3. github code button image
  3. Click on Download ZIP.
    4. github download zip image

Execute

Follow these steps to execute the software without the complete "Next Best Move":

  1. Unzip the downloaded folder.
    2. unzip folder
  2. Open the klotski_ids-main/out directory
  3. Double click on klotski_ids.jar
    4. unzip folder

Follow these steps to execute the software with the "Next Best Move" on your system:

  1. Unzip the downloaded folder.
    2. unzip folder
  2. Open the folder on your IDE the klotski_ids-main/klotski_ids directory as a Maven project (many IDEs automatically recognize the program as a Maven project)
  3. Run the file: .\src\main\java\klotski_ids\Launcher.java or .\src\main\java\klotski_ids\mainApplication.java
    4. run Launcher
  1. Open the terminal in the directory where the zip folder is located.
  2. Run this command:
    >unzip klotski_ids-main.zip && cd klotski_ids-main
  3. Open the folder on your IDE the ./klotski_ids directory as a Maven project (many IDEs automatically recognize the program as a Maven project)
  4. Run the file: .\src\main\java\klotski_ids\Launcher.java or .\src\main\java\klotski_ids\mainApplication.java
    5. run Launcher

Game Rules

The rules of the game can be studied at the klotski page in wikipedia.

Libraries

# Name Description Credit
1 org.json JSON is a light-weight, language independent, data interchange format.
2 iDocs iDocs is a free one page documentation html template built with Bootstrap 4. Which helps you to create your offline and online documentation for your themes, templates, plugins and software.
3 KlotskiSolver mza44/KlotskiSolver is a command-line Klotski solver written in Python 3.4