Installing the Ludii Tutorials Repository


Following these instructions for installing the Ludii Tutorials Repository is only required if you are interested in running some of the code examples from various programming tutorials. This is irrelevant for non-programming use cases of Ludii, such as game design.

The Ludii Tutorials repository on GitHub provides various code examples to go along with some of the tutorials on these pages. This page lists the steps required to run these code examples locally:

  1. Clone the repository from:
  2. Create a Java project in your favourite IDE, using the source code in the cloned repository.
  3. Suppose that the repository was cloned in the directory <install_dir>/LudiiTutorials, which already contains src and docs directories. Create a new directory <install_dir>/LudiiTutorials/libs alongside them, and place the Ludii.jar file (downloaded from Ludii’s downloads page) in it.
  4. Set up the project in your IDE to use the Ludii.jar file as a library. Most of the code requires this as a dependency.
  5. Also set the project to use the other two .jar files that are already included in <install_dir>/LudiiTutorials/libs as libraries; these are only required for the unit tests in this repository.
  6. The code examples for various programming tutorials can all be found in the <install_dir>/LudiiTutorials/src/ludii_tutorials package. Each of these .java files has a main method, which means that it can be run directly to see that tutorial’s code in action.