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:
- Clone the repository from: https://github.com/Ludeme/LudiiTutorials.
- Create a
Javaproject in your favourite IDE, using the source code in the cloned repository.
- Suppose that the repository was cloned in the directory
<install_dir>/LudiiTutorials, which already contains
docsdirectories. Create a new directory
<install_dir>/LudiiTutorials/libsalongside them, and place the
Ludii.jarfile (downloaded from Ludii’s downloads page) in it.
- Set up the project in your IDE to use the
Ludii.jarfile as a library. Most of the code requires this as a dependency.
- Also set the project to use the other two
.jarfiles that are already included in
<install_dir>/LudiiTutorials/libsas libraries; these are only required for the unit tests in this repository.
- The code examples for various programming tutorials can all be found in
<install_dir>/LudiiTutorials/src/ludii_tutorialspackage. Each of these
.javafiles has a main method, which means that it can be run directly to see that tutorial’s code in action.