Locker (l[ichess in d]ocker) is a Docker development setup for lila. Particularly, locker is focused on developing lila using Visual Studio Code. Locker will gladly run without it but extra files are present (in this repo, not in the containers) for this setup.
- Git
- Docker
Optional:
- Visual Studio Code
- Visual Studio Code Remote - Containers extension
Clone this repository.
git clone https://github.com/wkeahi/locker.git
After this, there are a few more steps. You can run setup.shin this directory to run the remaining steps in this section.
Inside your local folder for this repo, clone lila.
git clone --recursive https://github.com/ornicar/lila.git
Inside your local folder for this repo, clone lila-ws.
git clone https://github.com/ornicar/lila-ws.git
Unfortunately, Metals requires build.sbt to be in the root. This will mean a few manual steps will be necessary.
Create a .vscode directory in lila.
mkdir lila/.vscode
Copy settings.json to this new folder.
cp settings.json lila/.vscode/
Additionally, a few changes to the conf files for lila & lila-ws will have to be done to point to redis/mongo.
Copy the configuration file to point lila to the redis and mongo containers.
cp conf/application.conf lila/conf/
Copy the configuration file to point lila-ws to the redis and mongo containers.
cp conf/custom_ws.conf lila-ws/
If you would like to start lila and lila-ws (no bloop) as is, change the entrypoint in docker-compose.yml to docker-entrypoint.sh.
Then run the following command in the locker directory.
docker-compose up
lila-ws will be started in the background (nothing will be output to the log). Then sbt run. After it has finished, go to http://127.0.0.1:9663/.
Open the Command Palette (Ctrl+Shift+P/Cmd+Shift+P) and search Remote-Containers: Open Container in Folder. Then select your local locker folder. VS Code will then prompt you if you would like to import the build, confirm. This will run sbt bloopInstall. After it is done compiling, you can use features such as "Go to Definition."
Additionally, this repo imposes a few settings to VS Code. To avoid unwanted features the settings are minimal, but you should take a look at the file. Namely, lila's .scalafmt will be used and files will be formatted on save.