37 lines
2.3 KiB
Markdown
37 lines
2.3 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## Project
|
|
|
|
A Jellyfin client for the Freebox Player (Revolution), written in pure QML (no C++, no JS files yet). The app runs inside the Freebox's QML runtime via the `fbx.application` module, so it cannot be run with a stock `qmlscene` — `import fbx.application 1.0` only resolves on the box or through the Freebox SDK.
|
|
|
|
## Build / run
|
|
|
|
There is no build system, linter, or test suite. Development uses the Freebox SDK's QtCreator plugin:
|
|
|
|
- SDK setup: https://dev.freebox.fr/sdk/player.html (Windows: https://github.com/fbx/freebox-qtcreator-plugin/issues/8)
|
|
- Open `Jellyfin.fbxproject` in QtCreator with the Freebox plugin; the run target deploys to a Freebox Player on the LAN (configured in `Jellyfin.fbxproject.user`, which is machine-specific).
|
|
- `Jellyfin.fbxproject` packages every QML/JS/image/font file under the repo root plus `manifest.json` — new files are picked up automatically.
|
|
|
|
## Structure
|
|
|
|
- `manifest.json` — app identity (`com.stilobique.jellyfin`), icon, required capabilities (`net_wan`), and entry point. Add capabilities here if new platform features are used.
|
|
- `Jellyfin.qml` — root `Application`: a `Row` split 1/3 (logo panel) and 2/3 (login panel). Owns initial focus.
|
|
- `Views/` — imported as `import "Views" as View` and used as `View.Logo`, `View.Login`. Paths to assets inside views are relative to the view file (e.g. `../icon.png`).
|
|
|
|
## Platform constraints
|
|
|
|
- Target is QtQuick 2.5 (old Qt). Stick to APIs available in that version.
|
|
- Input is a TV remote: navigation is driven by `Keys.onPressed` with `Qt.Key_Up`/`Qt.Key_Down` etc. and explicit focus handling, not mouse/touch.
|
|
|
|
## Current state (WIP)
|
|
|
|
Remote-key navigation on the login form is in progress (`Views/Login.qml`). Known issues to be aware of when touching it:
|
|
|
|
- `Jellyfin.qml` calls `columnLogin.updateSelection()`, but `columnLogin` is an id inside `Login.qml`; QML ids are file-scoped, so this needs an `id` on the `View.Login {}` instance instead.
|
|
- `updateSelection()` references `repeater`, but the `Repeater` has no `id`, and it sets `.color` on a `Row` (which has no `color` property).
|
|
- `Keys.onPressed` is attached to the `Repeater` rather than the focused `Column`, so it will not receive key events.
|
|
|
|
Comments in the code and README are partly in French.
|