README.md
1# Lizzie - Leela Zero Interface
2
3
4Lizzie is a graphical interface allowing the user to analyze games in
5real time using [Leela Zero](https://github.com/gcp/leela-zero). You
6need Java 8 or higher to run this program.
7
8[](https://travis-ci.org/featurecat/lizzie?branch=master)
9
10
11## Running a release
12
13Just follow the instructions in the provided readme in the
14[release](https://github.com/featurecat/lizzie/releases/tag/0.6).
15
16The first run may take a while because Leela Zero needs to set up the
17OpenCL tunings. Just hang tight, and wait for it to finish, then you
18will see Leela Zero's analysis displayed on the board. Feel free to supply
19your own tunings, as this will speed up the process. Do this by copying
20any `leelaz_opencl_tuning` file you have into the directory.
21
22## Building from source
23
24### Building Leela Zero
25
26First, you will need to have a version of Leela Zero that
27continually outputs pondering information. You can get this from one
28of the Lizzie releases or build it yourself; just compile from the **next**
29branch of Leela Zero (see http://github.com/gcp/leela-zero/tree/next for more
30details).
31
32 $ git clone --recursive --branch next http://github.com/gcp/leela-zero.git
33
34### Building Lizzie
35
36The simplest way to build Lizzie is to use [Maven](https://maven.apache.org/).
37
38To build the code and package it:
39
40 $ mvn package
41
42### Running Lizzie
43
44 $ java -jar "target/lizzie-0.6-shaded.jar"
45
46(or whatever the current version of the shaded `jar` file is in
47`target/`).
48
49After you run this command you should see a GUI start. Lizzie will also start a Leela Zero
50process that it will communicate with. You can configure the location of Leela Zero from the
51`config.txt` file from the folder you started the `java` command. If Lizzie is unable to start
52Leela Zero it will display an error and you can fiddle with the `config.txt` file
53until you get all the paths correct.
54
55Lizzie will provide multitude of options to load and save SGF files, run an auto analysis and
56configure the board. To see all the options just hold down the key **x** (yes, just press and hold
57the letter **x**) and you will see all the commands listed in the GUI.
58
){kind=link}