• Stars
    star
    2,032
  • Rank 22,775 (Top 0.5 %)
  • Language
    TypeScript
  • License
    GNU General Publi...
  • Created over 10 years ago
  • Updated 6 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

lichess.org mobile application

lichess.org/mobile

Android build Lint and unit tests GitHub contributors GitHub All Releases GitHub

lichess mobile screenshots

Lichess mobile is the lichess.org official application. It is written in TypeScript, with a bit of Kotlin and Swift. It is a web application that accesses the native SDK, thanks to Ionic capacitor. The rendering library is mithril.js. It talks to a native Stockfish engine, supporting multiple variants, through a capacitor plugin. Multi-variant chess library is brought by a JavaScript version of scalachess.

Download

Get it on F-Droid Get it on Google Play

or get the APK from the Releases section

Required dependencies

Android:

  • in addition to capacitor dependencies, android ndk for stockfish compilation (to install with Android Studio).

Setup project

Make sure to install all dependencies:

$ npm install

Capacitor needs the web app before sync, so build it:

$ npm run build

Sync capacitor:

$ npx cap sync

Running in the browser

$ npm run serve

Will serve assets at http://localhost:8080. Once the server is up, browse to http://localhost:8080/www.

You should use a chromium based browser to be close to the android webview which is based on chrome.

Be sure to Toggle Device Mode or else you won't be able to click on anything.

Running in a device/emulator

Be sure to install all the dependencies and follow the steps above in the Setup project section.

In order to build Stockfish, you need to download the current stockfish plugin NNUE file and save it to the proper location for each platform:

$ npm run fetch-nnue

Android

Using command line:

$ npx cap run android

Using android studio:

$ npx cap open android

More information available here.

Free version

By default, the output APK will rely on Firebase Cloud Messaging to support push notifications. However, it is possible to remove this dependency if you don't care about push notifications.

To build the free version:

$ npm run patch-nonfree
$ npx cap update android
$ cd ./android
$ ./gradlew assembleDebug

iOS

You will need a GoogleService-Info.plist file in order to compile iOS project. You can download a dummy one from the firebase open-source project. Put it in the ios/App/App/ folder. Only debug builds are allowed with that example file. Push notifications won't work, but you will be able to run the app on a simulator just fine.

Using command line:

$ npx cap run ios

Using Xcode:

$ npx cap open ios

More information available here.

Advanced setup

See the wiki.

More Repositories

1

lila

โ™ž lichess.org: the forever free, adless and open source chess server โ™ž
Scala
15,513
star
2

mobile

Lichess mobile app v2
Dart
1,316
star
3

chessground

Mobile/Web chess UI for lichess.org
TypeScript
1,011
star
4

fishnet

Distributed Stockfish analysis for lichess.org
Rust
708
star
5

scalachess

Chess API written in scala. Immutable and free of side effects.
Scala
636
star
6

api

Lichess API documentation and examples
TypeScript
444
star
7

chess-openings

An aggregated data set of chess opening names
Python
354
star
8

stockfish.wasm

WebAssembly port of the strong chess engine Stockfish
C++
257
star
9

stockfish.js

The strong open source chess engine Stockfish compiled to JavaScript and WebAssembly using Emscripten
C++
195
star
10

lila-ws

Lichess' websocket server
Scala
146
star
11

lila-openingexplorer

Opening explorer for lichess.org that can handle all the variants and trillions of unique positions
Rust
132
star
12

compression

Chess clock and move compression algorithms for lichess.org
Java
110
star
13

lila-gif

Webservice to render Gifs of chess positions and games, and stream them frame by frame
Rust
104
star
14

pgn-viewer

PGN viewer widget
TypeScript
101
star
15

lila-tablebase

Tablebase server
Rust
85
star
16

berserk

Python client for the lichess API
Python
85
star
17

database

Public exports of all rated games, puzzles, and computer evaluations.
Scala
83
star
18

external-engine

Using engines running outside of the browser on https://lichess.org/analysis
Python
77
star
19

api-demo

Client-side app using various Lichess APIs for demonstration purpose
TypeScript
56
star
20

chessground-examples

Usage examples for chessground
TypeScript
55
star
21

kaladin

Machine learning tool aimed at automating cheat detection using insights data.
PureBasic
48
star
22

flutter-chessground

Chessboard package for flutter
Dart
46
star
23

lila-gitpod

Lichess development environment
Shell
42
star
24

lila-search

Keep elasticsearch threads out of your web facing app, kids
Scala
39
star
25

lila-fishnet

Proxy between lila and fishnet move clients
Scala
37
star
26

lila-http

Handle some https://lichess.org/tournament load
Rust
34
star
27

lila-docker

Lichess local development using Docker Compose.
Rust
33
star
28

dartchess

Dart chess library for native platforms
Dart
32
star
29

api-ui

some web UIs on top of the Lichess API
TypeScript
17
star
30

lila-push

Web push microservice for lichess.org
Rust
17
star
31

lila-db-seed

Sample database data for lila development
Python
15
star
32

pgn-mule

Merge, filter, tweak and expose PGN sources
TypeScript
14
star
33

scalalib

Some convenience functions for my scala projects
Scala
13
star
34

leroyjenkins

Follow ban logs to manage ipsets
Rust
13
star
35

broadcaster

Broadcast your chess games on Lichess!
Vue
13
star
36

lila-ip2proxy

Webservice to query an IP2Proxy BIN database
Rust
11
star
37

papers

Papers that use Lichess data, study Lichess, or cite Lichess
TeX
9
star
38

swiss-maker

Script that creates regular swiss tournaments for a team.
TypeScript
8
star
39

lila-engine

Broker for communication between external engine providers and clients
Rust
7
star
40

lila-maven

distributing lichess jars
Shell
6
star
41

lila-stockfish-web

A home for stockfish wasms - because we care
Python
6
star
42

files

Public downloads
5
star
43

lila-deepq

deepquluru
Rust
4
star
44

lila-pwned

Webservice to query https://haveibeenpwned.com/ database dumps
Rust
3
star
45

lifat

large assets used by lila in production but optional for dev builds
JavaScript
3
star
46

ab-stub

JavaScript
1
star
47

fishnet-builder

Docker image for an environment that can produce fully static Stockfish builds
C
1
star
48

.github

1
star