# PlayXylo Full Documentation

## 1. Application Overview
PlayXylo is a digital instrument designed for simplicity and speed. It is widely used in classrooms for music education.

* **Core Philosophy**: Distraction-free interface with authentic audio samples.
* **Performance**: Optimized for instant launch and low latency.
* **Input Methods**:
    * **Touch**: Tap or slide across keys (polyphonic support).
    * **Mouse**: Click keys.
    * **Keyboard**: Maps number row and QWERTY row to keys.
* **Platforms**:
    * **PWA**: Installable as a standalone app; works offline.
    * **Android App**: Available on [Google Play](https://play.google.com/store/apps/details?id=com.playsprout.xylo).
    * **Chrome Extension**: Adds play-along overlay features for YouTube videos. Available on [Chrome Web Store](https://chromewebstore.google.com/detail/playxylo/eginjflnjcdihpohfjgkafaidecbgepn).

## 2. Configuration Parameters
Customize the experience by appending these parameters to `https://playxylo.com/`.

### Musical Scale (`scale`)
| Value | Description |
| :--- | :--- |
| `major` | Standard diatonic scale (Default) |
| `chromatic` | All 12 semitones (sharps/flats included) |
| `pentatonic` | 5-note scale (commonly used for improvisation) |
| `natural-minor` | Natural minor scale |
| `pentatonic-gapped` | Pentatonic with visual gaps |
| `root-g-major` | G Major scale |
| `root-d-major` | D Major scale |

### Visual Theme (`colors`)
| Value | Description |
| :--- | :--- |
| `playxylo` | Default rainbow gradient |
| `chromanotes` | Boomwhacker-compatible colors (Red C, Orange D, etc.) |
| `codicolors` | Codi-notes system |
| `unicolor` | Single color (Red) for focus/simplicity |

### Notation Labels (`labels`)
| Value | Description |
| :--- | :--- |
| `letters` | A, B, C... |
| `solfege-fixed` | Do, Re, Mi (Fixed C = Do, with Si) |
| `solfege-movable` | Do, Re, Mi (Relative to root, with Ti) |
| `numbers` | 1, 2, 3... |
| `sargam` | Sa, Re, Ga, Ma, Pa... |
| `blank` | No text labels |

### Interface Control
* **`range`**: `octave`, `10`, `large`, `max` (Controls number of bars)
* **`start`**: `c4` (Middle C). Sets first note.
* **`quality`**: `reduced`, `basic`, `barebone` (Reduces graphical and audio fidelity for performance).
* **`appearance`**: `light`, `dark` (Overrides system preference).
* **`contrast`**: `high` (Accessibility mode).
* **`motion`**: `reduce` (Disables animations).
* **`labelsize`**: `large` (Larger font for notes).
* **`fullscreen`**: `0` (Hide button), `-1` (Hide when active).

## 3. Keyboard Shortcuts
The app maps computer keyboard keys to xylophone bars for physical feedback.

* **Keys**: `1` `2` `3` `4` `5` `6` `7` `8` `9` `0` `-` `=` `Q`
*(Note: Accidentals are only active when `scale=chromatic` is used)*

## 4. Localization
The app adapts notation based on the detected or forced language (`lang=`).

* **German**: Uses **H** instead of B.
* **Solfege**: automatically selects Fixed vs. Movable Do based on region (e.g., Fixed for France/Italy, Movable for US/UK) unless overridden.
* **Scripts**: Supports Latin, Cyrillic, Arabic, Chinese, Korean, Japanese, and Indian scripts.

### Supported Language Codes
Use these codes with the `lang` parameter (e.g., `?lang=es-ES`):
`af`, `am`, `ar`, `as`, `be`, `bg`, `bn`, `bs`, `ca`, `ckb`, `cs`, `da`, `de`, `de-CH`, `el`, `en-GB`, `en-US`, `eo`, `es-419`, `es-ES`, `es-US`, `et`, `fa`, `fi`, `fil`, `fo`, `fr`, `fr-CA`, `gl`, `gn`, `gu`, `ha`, `he`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `isv-Cyrl`, `isv-Latn`, `it`, `ja`, `ka`, `km`, `kn`, `ko`, `lb`, `lt`, `lv`, `mk`, `ml`, `mr`, `ms`, `my`, `nb`, `nl`, `nl-BE`, `nn`, `or`, `pa`, `pl`, `prs`, `ps`, `pt-BR`, `pt-PT`, `ro`, `ru`, `rw`, `sd`, `sk`, `sl`, `sq`, `sr-Cyrl`, `sr-Latn`, `sv`, `sw`, `ta`, `te`, `tg-Cyrl`, `th`, `tn`, `tr`, `uk`, `ur`, `uz-Cyrl`, `uz-Latn`, `vi`, `xh`, `yi`, `zh-Hans`, `zh-Hant-HK`, `zh-Hant-TW`.

## 5. Song Library & Community
The app features a "Library" and "Community" section accessible via the menu.

* **Included Songs**: Includes *The Lion Sleeps Tonight*, *Jingle Bells*, *Oh When The Saints*, and *Twinkle Twinkle Little Star*.
  * **Link**: [https://playxylo.com/songs](https://playxylo.com/songs)

* **Community Videos**: Curated videos showing PlayXylo being used for teaching and learning.
  * **Link**: [https://playxylo.com/videos](https://playxylo.com/videos)