ChessConnect

Author: joojoooo

.gitattributes

@@ -1 +1,4 @@
-* text=auto eol=lf
+* text=auto eol=lf
+
+# git-crypt: encrypt all ChessConnect source files
+src/chessconnect/** filter=git-crypt diff=git-crypt

.github/workflows/release.yml

@@ -32,13 +32,23 @@ jobs:
       - name: Install PlatformIO
         run: pip install platformio
 
+      - name: Install git-crypt
+        run: sudo apt-get update && sudo apt-get install -y git-crypt
+
+      - name: Unlock encrypted sources
+        run: |
+          printf '%s' "${{ secrets.GIT_CRYPT_KEY }}" | base64 -d > /tmp/git-crypt-key
+          git-crypt unlock /tmp/git-crypt-key
+          rm /tmp/git-crypt-key
+
       - name: Extract version from tag
         id: version
         run: echo "version=${GITHUB_REF_NAME#v}" >> "$GITHUB_OUTPUT"
 
       - name: Inject version into firmware
         run: |
           sed -i 's/#define FIRMWARE_VERSION "dev"/#define FIRMWARE_VERSION "${{ steps.version.outputs.version }}"/' src/version.h
+          sed -i '/#define DEV_BUILD/d' src/version.h
           echo "Firmware version set to: ${{ steps.version.outputs.version }}"
           cat src/version.h
 
@@ -91,7 +101,7 @@ jobs:
             ## OpenChess ${{ github.ref_name }}
 
             ### Flash via Browser (ESP Web Tools)
-            Visit the [OpenChess Web Installer](https://joojoooo.github.io/OpenChess/flash.html) to flash your ESP32 directly from your browser.
+            Use the [OpenChess Web Installer](https://joojoooo.github.io/OpenChess/flash.html) to flash your ESP32 directly from the browser.
 
             ### Release Files
             | File | Description |
@@ -100,13 +110,8 @@ jobs:
             | `bootloader.bin` | ESP32 bootloader |
             | `partitions.bin` | Partition table |
             | `boot_app0.bin` | OTA boot selector |
-            | `littlefs.bin` | Web UI filesystem image (initial flash only) |
-            | `web_assets.tar` | Web UI assets for OTA updates (preserves saved games) |
-
-            ### OTA Updates
-            The board checks for updates automatically at boot (can be disabled in Board Settings).
-            - **Firmware**: Updated via `firmware.bin`
-            - **Web UI**: Updated via `web_assets.tar` (preserves saved games on LittleFS)
+            | `littlefs.bin` | Web UI filesystem image |
+            | `web_assets.tar` | Web UI assets for OTA updates |
 
   # Deploy GitHub Pages with the new release firmware so the Web Installer can fetch
   # binaries from the same origin (GitHub Pages has CORS headers, GitHub Releases does not).

README.md

@@ -1,5 +1,5 @@
 # OpenChess - Smart Chess Board [![Build & Release](https://github.com/joojoooo/OpenChess/actions/workflows/release.yml/badge.svg)](https://github.com/joojoooo/OpenChess/actions/workflows/release.yml)
-OpenChess is a smart chessboard, it can show legal moves, plays against you using Stockfish or let you play online games from Chess.com, Lichess, etc. on your physical board.
+OpenChess is a smart chessboard, it can show legal moves, plays against you using Stockfish or let you play online games on your physical board.
 
 <p align="center"><img src="docs/BuildGuide/OpenChess - Plastic PCB (Bot config).webp" width="50%"></p>
 
@@ -12,18 +12,31 @@ Love this project? You can [support it on Ko-fi](https://ko-fi.com/joojooo) Ever
 - **👣 [Step-by-step build guide](https://joojoooo.github.io/OpenChess)** - covers materials, schematics, assembly, and [software setup](https://joojoooo.github.io/OpenChess/index.html#software)
 - **⚡ [Web Flasher](https://joojoooo.github.io/OpenChess/flash.html)** - easily flash your ESP32 directly from the browser
 
+## ♟️ ChessConnect
+OpenChess can emulate BLE (Bluetooth Low Energy) chess boards and is compatible with [ChessConnect](https://chessconnect.de/) for playing on Chess.com, Lichess and many other platforms.
+
+### How to use
+1. Download the [ChessConnect](https://chessconnect.de) app or extension
+2. In the OpenChess WebUI, choose a board to emulate and start the BLE server
+3. In ChessConnect, select the emulated board and connect
+4. Start a game right from ChessConnect
+5. Watch the [video guide](https://youtu.be/bYm5_dK6EnQ)
+
+> [!NOTE]
+> This feature is **closed-source** and only included in precompiled [GitHub releases](https://github.com/joojoooo/OpenChess/releases). Works fully offline, no Internet required.
+
 ## ✨ Features
 Features that differentiate this fork from the original Concept-Bytes project:
 
 ### 🕹️ Gameplay
-- **Lichess**: Play online Lichess games using the Lichess API directly over WiFi
+- **Lichess**: Play online Lichess games using the Lichess API directly over WiFi (no ChessConnect)
 - **Game history**: Saves local (not-online) games so they can be reviewed later. If power is lost during gameplay, the game is automatically recovered on reboot.
 - **Check**: Shows a blinking animation on the checked king square and doesn't display or allow illegal moves that would put or leave the king in check
 - **GameOver**: Detects when the game is over and shows an animation with the winner color. Enforces 50-move, 3-fold repetition and insufficient material rules
 - **Draw/Resign**: Buttons in the WebUI can be used to Draw/Resign or Lift both kings off the board and hold them lifted for 2 seconds to end the game in a Draw.
 - **Castling**: Castling is possible by moving the king 2 squares towards the side you want to castle and it will show you where to move the rook.
 - **En passant**: Lift the pawn to show the destination square in red and the captured pawn square in purple
-- **Promotion**: Can be picked from the WebUI or the ChessUp app. If the WebUI or app are not open, a Queen is automatically picked.
+- **Promotion**: Can be picked from the WebUI or ChessConnect app. If the WebUI or app are not open, a Queen is automatically picked.
 - **Fixes**: Glaring bugs from the Concept-Bytes code that were fixed: Board is rotated correctly (white on the right), Queen and King are on the correct squares and playing infinite moves in a row is no longer possible.
 
 ### 🖥️ Hardware & Software
@@ -38,7 +51,11 @@ Features that differentiate this fork from the original Concept-Bytes project:
 
 ## 🤝 Contributing
 Contributions are welcome! If you have any new ideas to add or feedback to share, I'd love to hear it!
+</br></br>
 Please read the [Contributing Guidelines](/CONTRIBUTING.md) before submitting a PR.
+</br></br>
+[ChessConnect code](/src/chessconnect/) is [git-crypt](https://github.com/AGWA/git-crypt) encrypted. Access to the decryption key may be granted to trusted contributors.
+You can still contribute to the open-source parts of the project without the key: the ChessConnect feature is automatically disabled when building from encrypted sources.
 
 ## 📄 License
 This project is based on [Open-Chess](https://github.com/Concept-Bytes/Open-Chess) by [Concept-Bytes](https://github.com/Concept-Bytes), which is licensed under the [MIT License](/LICENSE-MIT).

platformio.ini

@@ -16,6 +16,7 @@ monitor_speed = 115200
 board_build.filesystem = littlefs
 board_build.partitions = min_spiffs_nocore.csv
 extra_scripts = 
+	pre:scripts/chessconnect.py
 	pre:src/web/build/minify.py
 	pre:src/web/build/prepare_littlefs.py
 	src/web/build/upload_fs.py
@@ -24,7 +25,9 @@ lib_deps =
 	bblanchon/ArduinoJson@^7.4.3
 	esp32async/AsyncTCP@^3.4.10
 	esp32async/ESPAsyncWebServer@^3.10.1
+	h2zero/NimBLE-Arduino@^2.3.9
 lib_ignore = 
 	ESPAsyncTCP
 	RPAsyncTCP
+	ESP32 BLE Arduino
 lib_ldf_mode = deep

scripts/chessconnect.py

@@ -0,0 +1,47 @@
+"""PlatformIO pre-build script for ChessConnect private source handling.
+
+All files in src/chessconnect/ are git-crypt encrypted in the public repo.
+When any file is encrypted (or missing), this script excludes the entire folder
+from compilation and builds without ChessConnect features.
+
+When all sources are decrypted, they compile normally and CHESSCONNECT_ENABLED is
+defined, enabling ChessConnect support in the firmware.
+
+The CI workflow (release.yml) unlocks via git-crypt and builds with full features.
+"""
+
+import os
+Import("env")
+
+CHESSCONNECT_DIR = os.path.join(env.subst("$PROJECT_SRC_DIR"), "chessconnect")
+
+
+def is_encrypted_or_missing(filepath):
+    """Return True if the file is git-crypt encrypted or missing."""
+    try:
+        with open(filepath, "rb") as f:
+            return f.read(10).startswith(b"\x00GITCRYPT")
+    except (FileNotFoundError, IOError):
+        return True
+
+
+# Check every file in the chessconnect folder
+all_files = os.listdir(CHESSCONNECT_DIR) if os.path.isdir(CHESSCONNECT_DIR) else []
+sources_available = len(all_files) > 0 and not any(
+    is_encrypted_or_missing(os.path.join(CHESSCONNECT_DIR, f))
+    for f in all_files
+)
+
+if sources_available:
+    print(">> ChessConnect: sources available - building with CHESSCONNECT_ENABLED")
+    env.Append(CPPDEFINES=["CHESSCONNECT_ENABLED"])
+else:
+    print(">> ChessConnect: sources encrypted/missing - building without CHESSCONNECT_ENABLED")
+
+    def skip_chessconnect(node):
+        path = node.get_path().replace("\\", "/")
+        if "/chessconnect/" in path:
+            return None
+        return node
+
+    env.AddBuildMiddleware(skip_chessconnect)